PowerPoint.CustomPropertyCollection class
カスタム プロパティのコレクション。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(key, value) | 新しい |
| delete |
このコレクション内のすべてのカスタム プロパティを削除します。 |
| get |
コレクション内のカスタム プロパティの数を取得します。 |
| get |
キーによって |
| get |
コレクション内の 0 から始まるインデックスによって |
| get |
キーによって |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: PowerPoint.CustomProperty[];プロパティ値
メソッドの詳細
add(key, value)
新しい CustomProperty を作成するか、指定したキーを使用してプロパティを更新します。
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;パラメーター
- key
-
string
CustomProperty オブジェクトを識別する文字列。 大文字と小文字は区別されません。 最大キー長は 255 文字です。 文字列を大きくすると、 InvalidArgument エラーで操作が失敗します。
- value
-
boolean | Date | number | string
CustomProperty
の値。 値が文字列の場合、最大長は 255 文字です。 文字列を大きくすると、 InvalidArgument エラーで操作が失敗します。
戻り値
注釈
deleteAll()
getCount()
コレクション内のカスタム プロパティの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
コレクション内のカスタム プロパティの数。
注釈
getItem(key)
キーによって CustomProperty を取得します。
getItem(key: string): PowerPoint.CustomProperty;パラメーター
- key
-
string
CustomProperty オブジェクトを識別する文字列。 大文字と小文字は区別されません。 キーの最大長は 255 文字です。 引数が 255 文字を超える場合、このメソッドは InvalidArgument エラーを返します。
戻り値
注釈
getItemAt(index)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の 0 から始まるインデックスによって CustomProperty を取得します。 インデックスが範囲外の場合、 InvalidArgument 例外をスローします。
getItemAt(index: number): PowerPoint.CustomProperty;パラメーター
- index
-
number
コレクション内のカスタム プロパティのインデックス。
戻り値
指定されたインデックスのカスタム プロパティ。
注釈
getItemOrNullObject(key)
キーによって CustomProperty を取得します。
CustomPropertyが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemOrNullObject(key: string): PowerPoint.CustomProperty;パラメーター
- key
-
string
CustomProperty オブジェクトを識別する文字列。 大文字と小文字は区別されません。 キーの最大長は 255 文字です。 引数が 255 文字を超える場合、このメソッドは InvalidArgument エラーを返します。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;パラメーター
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): PowerPoint.CustomPropertyCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.CustomPropertyCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.CustomPropertyCollectionDataとして型指定) を返します。
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;