PowerPoint.SlideBackgroundPictureOrTextureFill class
PowerPoint.SlideBackground の図またはテクスチャ塗りつぶしのプロパティを表します。
- Extends
注釈
[ API set: PowerPointApi 1.10 ]
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-background-fill.yaml
// Gets the picture or texture fill properties of the first selected slide's background.
await PowerPoint.run(async (context) => {
const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
const fill: PowerPoint.SlideBackgroundFill = slide.background.fill;
fill.load("type");
await context.sync();
if (fill.type !== PowerPoint.SlideBackgroundFillType.pictureOrTexture) {
console.warn("The slide background isn't a picture or texture fill.");
return;
}
const pictureFill: PowerPoint.SlideBackgroundPictureOrTextureFill =
slide.background.fill.getPictureOrTextureFillOrNullObject();
pictureFill.load("transparency");
await context.sync();
if (pictureFill.isNullObject) {
console.warn("The slide background isn't a picture or texture fill.");
} else {
console.log("Picture or texture fill:", `- transparency: ${pictureFill.transparency}`);
}
});
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| transparency | 塗りつぶしの透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値として指定します。 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set |
塗りつぶしに使用するイメージを設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
transparency
塗りつぶしの透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値として指定します。
transparency: number;プロパティ値
number
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions): PowerPoint.SlideBackgroundPictureOrTextureFill;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPictureOrTextureFill;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.SlideBackgroundPictureOrTextureFill;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
返品
setImage(base64EncodedImage)
塗りつぶしに使用するイメージを設定します。
setImage(base64EncodedImage: string): void;パラメーター
- base64EncodedImage
-
string
イメージ データの Base64 エンコードである文字列。
返品
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.SlideBackgroundPictureOrTextureFill オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData として型指定) を返します。
toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;