PowerPoint.TagCollection class

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

context: RequestContext;

プロパティ値

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

readonly items: PowerPoint.Tag[];

プロパティ値

コレクションの末尾に新しいタグを追加します。 keyがコレクションに既に存在する場合は、既存のタグの値が指定されたvalueに置き換えられます。

add(key: string, value: string): void;

パラメーター

返品

注釈

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);
  slide.tags.add("OCEAN", "Indian");
  slide.tags.add("PLANET", "Jupiter");
  slide.tags.add("CONTINENT", "Antarctica");

  await context.sync();

  slide.tags.load("key, value");

  await context.sync();

  for (let i = 0; i < slide.tags.items.length; i++) {
    console.log(
      "Added key " +
        JSON.stringify(slide.tags.items[i].key) +
        " with value " +
        JSON.stringify(slide.tags.items[i].value),
    );
  }
});

このコレクション内の指定された key を持つタグを削除します。 keyが存在しない場合は何も行いません。

delete(key: string): void;

パラメーター

返品

注釈

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) {
  let presentationTags: PowerPoint.TagCollection = context.presentation.tags;

  presentationTags.delete("COLOR");

  await context.sync();

  console.log(JSON.stringify(presentationTags));
});

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

getCount(): OfficeExtension.ClientResult<number>;

返品

コレクション内のタグの数。

注釈

API セット: PowerPointApi 1.3

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

getItem(key: string): PowerPoint.Tag;

パラメーター

返品

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

注釈

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) {
  let selectedSlideIndex = await getSelectedSlideIndex();

  // Decrement because the getSelectedSlideByIndex method is 1-based,
  // but the getItemAt method is 0-based.
  selectedSlideIndex = selectedSlideIndex - 1;
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(selectedSlideIndex);
  slide.tags.add("CUSTOMER_TYPE", "Premium");

  await context.sync();

  const audienceTag: PowerPoint.Tag = slide.tags.getItem("CUSTOMER_TYPE");
  audienceTag.load("key, value");

  await context.sync();

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

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

getItemAt(index: number): PowerPoint.Tag;

パラメーター

返品

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

注釈

API セット: PowerPointApi 1.3

一意の ID を使用してタグを取得します。 そのようなタグが存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getItemOrNullObject(key: string): PowerPoint.Tag;

パラメーター

返品

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

注釈

API セット: PowerPointApi 1.3

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

load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

toJSON(): PowerPoint.Interfaces.TagCollectionData;

返品