PowerPoint.ShapeCollection class

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

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: PowerPoint.Shape[];

プロパティ値

コレクション内の図形の数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

コレクション内の図形の数。

注釈

[ API セット: PowerPointApi 1.3 ]

一意の ID を使用して図形を取得します。 図形が存在しない場合は、エラーがスローされます。

getItem(key: string): PowerPoint.Shape;

パラメーター

戻り値

一意の ID を持つ図形。 このような図形が存在しない場合は、エラーがスローされます。

注釈

[ API セット: PowerPointApi 1.3 ]

コレクション内の 0 から始まるインデックスを使用して図形を取得します。 インデックスが範囲外の場合、エラーがスローされます。

getItemAt(index: number): PowerPoint.Shape;

パラメーター

戻り値

指定したインデックス位置の図形。 インデックスが範囲外の場合、エラーがスローされます。

注釈

[ API セット: PowerPointApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml

await PowerPoint.run(async function(context) {
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
  const shape: PowerPoint.Shape = slide.shapes.getItemAt(0);
  shape.tags.add("MOUNTAIN", "Denali");

  await context.sync();

  const myShapeTag: PowerPoint.Tag = shape.tags.getItem("MOUNTAIN");
  myShapeTag.load("key, value");

  await context.sync();

  console.log("Added key " + JSON.stringify(myShapeTag.key) + " with value " + JSON.stringify(myShapeTag.value));
});

一意の ID を使用して図形を取得します。 このような図形が存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。

getItemOrNullObject(id: string): PowerPoint.Shape;

パラメーター

戻り値

一意の ID を持つ図形。 このような図形が存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。

注釈

[ API セット: PowerPointApi 1.3 ]

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

load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;

パラメーター

戻り値

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

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

パラメーター

戻り値

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;

パラメーター

戻り値

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

toJSON(): PowerPoint.Interfaces.ShapeCollectionData;

戻り値