PowerPoint.TagCollection class

リファレンス

パッケージ:: powerpoint

タグのコレクションを表します。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
items	このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(key, value)	コレクションの末尾に新しいタグを追加します。キーがコレクションに既に存在する場合、既存のタグの値は、指定 `value`されたに置き換えられます。
delete(key)	このコレクション内の指定されたキーを持つタグを削除します。キーが存在しない場合は何も行いません。
getCount()	コレクション内のタグの数を取得します。
getItem(key)	一意の ID を使用してタグを取得します。タグが存在しない場合、エラーがスローされます。
getItemAt(index)	コレクション内の 0 から始まるインデックスを使用してタグを取得します。インデックスが範囲外の場合、エラーがスローされます。
getItemOrNullObject(key)	一意の ID を使用してタグを取得します。このようなタグが存在しない場合は、プロパティが `isNullObject` true に設定されたオブジェクトが返されます。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
toJSON()	API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドを `JSON.stringify()`オーバーライドします。 (`JSON.stringify`さらに、渡されるオブジェクトのメソッドを呼び出 `toJSON` します)。元 `PowerPoint.TagCollection` のオブジェクトは API オブジェクトですが、 `toJSON` メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として `PowerPoint.Interfaces.TagCollectionData`型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.Tag[];

プロパティ値

PowerPoint.Tag[]

メソッドの詳細

add(key, value)

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

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

パラメーター

key: string

タグの一意の ID。この TagCollection内で一意です。キー文字列は、ドキュメントに保存すると大文字になります。

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 = 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));
  }
});

delete(key)

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

delete(key: string): void;

パラメーター

key: string

タグの一意の ID。この TagCollection内で一意です。このパラメーターは、大文字と小文字が区別されます。

戻り値

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 = context.presentation.tags;

  presentationTags.delete("COLOR");

  await context.sync();

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

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

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

注釈

[ API セット: PowerPointApi 1.3 ]

getItem(key)

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

getItem(key: string): PowerPoint.Tag;

パラメーター

key: string

タグの ID。 ID では大文字と小文字が区別され、大文字にする必要があります。

戻り値

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 = context.presentation.slides.getItemAt(selectedSlideIndex);
  slide.tags.add("CUSTOMER_TYPE", "Premium");

  await context.sync();

  const audienceTag = 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));
});

getItemAt(index)

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

getItemAt(index: number): PowerPoint.Tag;

パラメーター

index: number

コレクション内のタグのインデックス。

戻り値

PowerPoint.Tag

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

注釈

[ API セット: PowerPointApi 1.3 ]

getItemOrNullObject(key)

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

getItemOrNullObject(key: string): PowerPoint.Tag;

パラメーター

key: string

タグの ID。 ID では大文字と小文字が区別され、大文字にする必要があります。

戻り値

PowerPoint.Tag

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

注釈

[ API セット: PowerPointApi 1.3 ]

load(options)

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

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

パラメーター

options: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

戻り値

PowerPoint.TagCollection

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

PowerPoint.TagCollection

load(propertyNamesAndPaths)

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

パラメーター

propertyNamesAndPaths: OfficeExtension.LoadOption

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

戻り値

PowerPoint.TagCollection

toJSON()

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

toJSON(): PowerPoint.Interfaces.TagCollectionData;

戻り値

PowerPoint.Interfaces.TagCollectionData

Share via

PowerPoint.TagCollection class

注釈

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

items

プロパティ値

メソッドの詳細

add(key, value)

パラメーター

戻り値

注釈

例

delete(key)

パラメーター

戻り値

注釈

例

getCount()

戻り値

注釈

getItem(key)

パラメーター

戻り値

注釈

例

getItemAt(index)

パラメーター

戻り値

注釈

getItemOrNullObject(key)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

toJSON()

戻り値

フィードバック

その他のリソース