次の方法で共有


PowerPoint.SlideBackgroundFill class

スライドの背景オブジェクトの塗りつぶしの書式設定を表します。

Extends

注釈

[ API set: PowerPointApi 1.10 ]

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

type

スライドの背景の塗りつぶしの種類を返します。 詳細については 、「PowerPoint.SlideBackgroundFillType 」を参照してください。

メソッド

getGradientFillOrNullObject()

グラデーション塗りつぶしのプロパティを取得します。 塗りつぶしの種類が gradientされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPatternFillOrNullObject()

パターン塗りつぶしプロパティを取得します。 塗りつぶしの種類が patternされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPictureOrTextureFillOrNullObject()

図またはテクスチャ塗りつぶしのプロパティを取得します。 塗りつぶしの種類が pictureOrTextureされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getSolidFillOrNullObject()

塗りつぶしプロパティを取得します。 塗りつぶしの種類が solidされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

setGradientFill(options)

スライドの背景の塗りつぶしの書式設定をグラデーションの塗りつぶしに設定します。 これにより、塗りつぶしの種類が gradientに変更されます。

setPatternFill(options)

スライドの背景の塗りつぶしの書式をパターン塗りつぶしに設定します。 これにより、塗りつぶしの種類が patternに変更されます。

setPictureOrTextureFill(options)

スライドの背景の塗りつぶしの書式設定を図またはテクスチャの塗りつぶしに設定します。 これにより、塗りつぶしの種類が pictureOrTextureに変更されます。

setSolidFill(options)

スライドの背景の塗りつぶしの書式を塗りつぶしに設定します。 これにより、塗りつぶしの種類が solidに変更されます。

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.SlideBackgroundFill オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.SlideBackgroundFillData として型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

type

スライドの背景の塗りつぶしの種類を返します。 詳細については 、「PowerPoint.SlideBackgroundFillType 」を参照してください。

readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";

プロパティ値

PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"

注釈

[ API set: PowerPointApi 1.10 ]

メソッドの詳細

getGradientFillOrNullObject()

グラデーション塗りつぶしのプロパティを取得します。 塗りつぶしの種類が gradientされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;

戻り値

注釈

[ API set: PowerPointApi 1.10 ]

getPatternFillOrNullObject()

パターン塗りつぶしプロパティを取得します。 塗りつぶしの種類が patternされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;

戻り値

注釈

[ API set: PowerPointApi 1.10 ]

getPictureOrTextureFillOrNullObject()

図またはテクスチャ塗りつぶしのプロパティを取得します。 塗りつぶしの種類が pictureOrTextureされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;

戻り値

注釈

[ API set: PowerPointApi 1.10 ]

getSolidFillOrNullObject()

塗りつぶしプロパティを取得します。 塗りつぶしの種類が solidされていない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;

戻り値

注釈

[ API set: PowerPointApi 1.10 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions): PowerPoint.SlideBackgroundFill;

パラメーター

options
PowerPoint.Interfaces.SlideBackgroundFillLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundFill;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.SlideBackgroundFill;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

setGradientFill(options)

スライドの背景の塗りつぶしの書式設定をグラデーションの塗りつぶしに設定します。 これにより、塗りつぶしの種類が gradientに変更されます。

setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions): void;

パラメーター

options
PowerPoint.SlideBackgroundGradientFillOptions

グラデーション塗りつぶしのオプション。

戻り値

void

注釈

[ API set: PowerPointApi 1.10 ]

setPatternFill(options)

スライドの背景の塗りつぶしの書式をパターン塗りつぶしに設定します。 これにより、塗りつぶしの種類が patternに変更されます。

setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions): void;

パラメーター

options
PowerPoint.SlideBackgroundPatternFillOptions

パターン塗りつぶしのオプション。

戻り値

void

注釈

[ API set: PowerPointApi 1.10 ]

setPictureOrTextureFill(options)

スライドの背景の塗りつぶしの書式設定を図またはテクスチャの塗りつぶしに設定します。 これにより、塗りつぶしの種類が pictureOrTextureに変更されます。

setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void;

パラメーター

options
PowerPoint.SlideBackgroundPictureOrTextureFillOptions

図またはテクスチャ塗りつぶしのオプション。

戻り値

void

注釈

[ API set: PowerPointApi 1.10 ]

setSolidFill(options)

スライドの背景の塗りつぶしの書式を塗りつぶしに設定します。 これにより、塗りつぶしの種類が solidに変更されます。

setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions): void;

パラメーター

options
PowerPoint.SlideBackgroundSolidFillOptions

塗りつぶしのオプション。

戻り値

void

注釈

[ API set: PowerPointApi 1.10 ]

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.SlideBackgroundFill オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.SlideBackgroundFillData として型指定) を返します。

toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;

戻り値