次の方法で共有


PowerPoint.CustomPropertyCollection class

カスタム プロパティのコレクション。

Extends

注釈

[ API set: PowerPointApi 1.7 ]

プロパティ

context

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

items

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

メソッド

add(key, value)

新しい CustomProperty を作成するか、指定したキーを使用してプロパティを更新します。

deleteAll()

このコレクション内のすべてのカスタム プロパティを削除します。

getCount()

コレクション内のカスタム プロパティの数を取得します。

getItem(key)

キーによって CustomProperty を取得します。

getItemOrNullObject(key)

キーによって CustomProperty を取得します。 CustomPropertyが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

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 エラーで操作が失敗します。

戻り値

注釈

[ API set: PowerPointApi 1.7 ]

deleteAll()

このコレクション内のすべてのカスタム プロパティを削除します。

deleteAll(): void;

戻り値

void

注釈

[ API set: PowerPointApi 1.7 ]

getCount()

コレクション内のカスタム プロパティの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

コレクション内のカスタム プロパティの数。

注釈

[ API set: PowerPointApi 1.7 ]

getItem(key)

キーによって CustomProperty を取得します。

getItem(key: string): PowerPoint.CustomProperty;

パラメーター

key

string

CustomProperty オブジェクトを識別する文字列。 大文字と小文字は区別されません。 キーの最大長は 255 文字です。 引数が 255 文字を超える場合、このメソッドは InvalidArgument エラーを返します。

戻り値

注釈

[ API set: PowerPointApi 1.7 ]

getItemOrNullObject(key)

キーによって CustomProperty を取得します。 CustomPropertyが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(key: string): PowerPoint.CustomProperty;

パラメーター

key

string

CustomProperty オブジェクトを識別する文字列。 大文字と小文字は区別されません。 キーの最大長は 255 文字です。 引数が 255 文字を超える場合、このメソッドは InvalidArgument エラーを返します。

戻り値

注釈

[ API set: PowerPointApi 1.7 ]

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;

戻り値