次の方法で共有


PowerPoint.CustomXmlPartCollection class

カスタム XML パーツのコレクション。

Extends

注釈

[ API set: PowerPointApi 1.7 ]

プロパティ

context

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

items

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

メソッド

add(xml)

コレクションに新しい CustomXmlPart を追加します。

getByNamespace(namespaceUri)

名前空間が指定した名前空間に一致する、カスタム XML パーツの新しい範囲のコレクションを取得します。

getCount()

コレクション内のカスタム XML パーツの数を取得します。

getItem(id)

ID に基づいて CustomXmlPart を取得します。

getItemOrNullObject(id)

ID に基づいて CustomXmlPart を取得します。 CustomXmlPartが存在しない場合、このメソッドは 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.CustomXmlPartCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.CustomXmlPartCollectionDataとして型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

items

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

readonly items: PowerPoint.CustomXmlPart[];

プロパティ値

メソッドの詳細

add(xml)

コレクションに新しい CustomXmlPart を追加します。

add(xml: string): PowerPoint.CustomXmlPart;

パラメーター

xml

string

XML コンテンツ。 有効な XML フラグメントである必要があります。 XML フラグメントが無効な場合、このメソッドは GeneralException エラーを返します。

戻り値

注釈

[ API set: PowerPointApi 1.7 ]

getByNamespace(namespaceUri)

名前空間が指定した名前空間に一致する、カスタム XML パーツの新しい範囲のコレクションを取得します。

getByNamespace(namespaceUri: string): PowerPoint.CustomXmlPartScopedCollection;

パラメーター

namespaceUri

string

これは、"http://schemas.contoso.com/review/1.0" などの完全修飾スキーマ URI である必要があります。

戻り値

注釈

[ API set: PowerPointApi 1.7 ]

getCount()

コレクション内のカスタム XML パーツの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

コレクション内のカスタム XML パーツの数。

注釈

[ API set: PowerPointApi 1.7 ]

getItem(id)

ID に基づいて CustomXmlPart を取得します。

getItem(id: string): PowerPoint.CustomXmlPart;

パラメーター

id

string

取得するオブジェクトの ID。

戻り値

注釈

[ API set: PowerPointApi 1.7 ]

getItemOrNullObject(id)

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

getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;

パラメーター

id

string

取得するオブジェクトの ID。

戻り値

注釈

[ API set: PowerPointApi 1.7 ]

load(options)

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

load(options?: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartCollection;

パラメーター

options

PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

戻り値

toJSON()

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

toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;

戻り値