次の方法で共有

PowerPoint.CustomXmlPartScopedCollection class

  • リファレンス
パッケージ:
powerpoint

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

カスタム XML パーツのスコープ付きコレクション。 スコープ付きコレクションは、(名前空間によるフィルター処理など) 何らかの操作の結果です。 スコープ付きコレクションは、これ以上スコープを設定できません。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

プロパティ

context

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

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

メソッド

getCount()

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

ID に基づいて CustomXmlPart を取得します。
getItemOrNullObject(id)

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

コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 コレクションに項目が含まれているか、複数の項目が含まれている場合、このメソッドは GeneralException エラーを返します。
getOnlyItemOrNullObject()

コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 それ以外の場合、このメソッドは nullを返します。
load(options)

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

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

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

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

プロパティの詳細

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

context: RequestContext;

プロパティ値

PowerPoint.RequestContext

items

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

readonly items: PowerPoint.CustomXmlPart[];

プロパティ値

PowerPoint.CustomXmlPart[]

メソッドの詳細

getCount()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

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

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

getItem(id)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

getItem(id: string): PowerPoint.CustomXmlPart;

パラメーター

id

string

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

戻り値

PowerPoint.CustomXmlPart

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

getItemOrNullObject(id)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;

パラメーター

id

string

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

戻り値

PowerPoint.CustomXmlPart

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

getOnlyItem()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 コレクションに項目が含まれているか、複数の項目が含まれている場合、このメソッドは GeneralException エラーを返します。

getOnlyItem(): PowerPoint.CustomXmlPart;

戻り値

PowerPoint.CustomXmlPart

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

getOnlyItemOrNullObject()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 それ以外の場合、このメソッドは nullを返します。

getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;

戻り値

PowerPoint.CustomXmlPart

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

load(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

load(options?: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;

パラメーター

options

PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

戻り値

PowerPoint.CustomXmlPartScopedCollection

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

PowerPoint.CustomXmlPartScopedCollection

load(propertyNamesAndPaths)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

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

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

戻り値

PowerPoint.CustomXmlPartScopedCollection

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;

戻り値

PowerPoint.Interfaces.CustomXmlPartScopedCollectionData