PowerPoint.TagCollection class
タグのコレクションを表します。
- Extends
注釈
[ 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));
});
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(key, value) | コレクションの末尾に新しいタグを追加します。
|
| delete(key) | このコレクション内の指定された |
| get |
コレクション内のタグの数を取得します。 |
| get |
一意の ID を使用してタグを取得します。 タグが存在しない場合、エラーがスローされます。 |
| get |
コレクション内の 0 から始まるインデックスを使用してタグを取得します。 インデックスが範囲外の場合、エラーがスローされます。 |
| get |
一意の ID を使用してタグを取得します。 このようなタグが存在しない場合は、 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
add(key, value)
コレクションの末尾に新しいタグを追加します。
keyがコレクションに既に存在する場合、既存のタグの値は、指定されたvalueに置き換えられます。
add(key: string, value: string): void;パラメーター
- key
-
string
タグの一意の ID。この TagCollection内で一意です。 'key' パラメーターでは大文字と小文字は区別されませんが、ドキュメントに保存すると常に大文字になります。
- 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)
このコレクション内の指定された key を持つタグを削除します。
keyが存在しない場合は何も行いません。
delete(key: string): void;パラメーター
- key
-
string
タグの一意の ID。この TagCollection内で一意です。
key パラメーターでは大文字と小文字が区別されません。
戻り値
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>
コレクション内のタグの数。
注釈
getItem(key)
一意の ID を使用してタグを取得します。 タグが存在しない場合、エラーがスローされます。
getItem(key: string): PowerPoint.Tag;パラメーター
- key
-
string
タグの ID。
戻り値
一意の 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
コレクション内のタグのインデックス。
戻り値
指定されたインデックスのタグ。 インデックスが範囲外の場合、エラーがスローされます。
注釈
getItemOrNullObject(key)
一意の ID を使用してタグを取得します。 このようなタグが存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。
getItemOrNullObject(key: string): PowerPoint.Tag;パラメーター
- key
-
string
タグの ID。
戻り値
一意の ID を持つタグ。 このようなタグが存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;パラメーター
- options
-
PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): PowerPoint.TagCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.TagCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.TagCollectionDataとして型指定) を返します。
toJSON(): PowerPoint.Interfaces.TagCollectionData;戻り値
Office Add-ins