Word.ShapeFill class

図形の塗りつぶしの背景色を指定します。 値は '#RRGGBB' 形式または色名で指定できます。

backgroundColor: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

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

context: RequestContext;

プロパティ値

図形の塗りつぶしの前景色を指定します。 値は '#RRGGBB' 形式または色名で指定できます。

foregroundColor: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

塗りつぶしの透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値で指定します。 図形の種類が透明度をサポートしていない場合や、グラデーションの塗りつぶしの種類など、図形の塗りつぶしの透明度に一貫性がない場合は null を返します。

transparency: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

図形の塗りつぶしの種類を返します。 詳細は「Word.ShapeFillType」をご覧ください。

readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";

プロパティ値

注釈

API セット: WordApiDesktop 1.2

この図形の塗りつぶしの書式設定をクリアして Word.ShapeFillType.noFillに設定します。

clear(): void;

返品

注釈

API セット: WordApiDesktop 1.2

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-geometric-shapes.yaml

await Word.run(async (context) => {
  // Sets color fill properties of the first moon found in the document body.
  const moon: Word.Shape = context.document.body.shapes
    .getByGeometricTypes([Word.GeometricShapeType.moon])
    .getFirstOrNullObject();
  moon.load("fill");
  await context.sync();

  if (moon.isNullObject) {
    console.log("No moons found in the document body.");
    return;
  }

  const moonFill: Word.ShapeFill = moon.fill;
  console.log("Current fill properties of the first moon found in the document body:", moonFill);

  moonFill.setSolidColor("green");
  moonFill.load();
  await context.sync();

  console.log("Updated color fill properties of the first moon found in the document body:", moonFill);
});

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

load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill;

パラメーター

返品

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

load(propertyNames?: string | string[]): Word.ShapeFill;

パラメーター

返品

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ShapeFill;

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.ShapeFill): void;

パラメーター

返品

図形の塗りつぶしの書式設定を均一な色に設定します。 これにより、塗りつぶしの種類が Word.ShapeFillType.solid に変わります。

setSolidColor(color: string): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.2

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-geometric-shapes.yaml

await Word.run(async (context) => {
  // Sets color fill properties of the first moon found in the document body.
  const moon: Word.Shape = context.document.body.shapes
    .getByGeometricTypes([Word.GeometricShapeType.moon])
    .getFirstOrNullObject();
  moon.load("fill");
  await context.sync();

  if (moon.isNullObject) {
    console.log("No moons found in the document body.");
    return;
  }

  const moonFill: Word.ShapeFill = moon.fill;
  console.log("Current fill properties of the first moon found in the document body:", moonFill);

  moonFill.setSolidColor("green");
  moonFill.load();
  await context.sync();

  console.log("Updated color fill properties of the first moon found in the document body:", moonFill);
});

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

toJSON(): Word.Interfaces.ShapeFillData;

返品

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.ShapeFill;

返品

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.ShapeFill;

返品