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)
コレクション内の 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;