PowerPoint.CustomXmlPartScopedCollection class
カスタム XML パーツのスコープ付きコレクション。 スコープ付きコレクションは、(名前空間によるフィルター処理など) 何らかの操作の結果です。 スコープ付きコレクションは、これ以上スコープを設定できません。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| get |
このコレクション内のカスタム XML パーツの数を取得します。 |
| get |
ID に基づいて |
| get |
コレクション内の 0 から始まるインデックスによって |
| get |
ID に基づいて |
| get |
コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 コレクションに項目が含まれているか、複数の項目が含まれている場合、このメソッドは |
| get |
コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 それ以外の場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: PowerPoint.CustomXmlPart[];プロパティ値
メソッドの詳細
getCount()
このコレクション内のカスタム XML パーツの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
コレクション内のカスタム XML パーツの数。
注釈
getItem(id)
ID に基づいて CustomXmlPart を取得します。
getItem(id: string): PowerPoint.CustomXmlPart;パラメーター
- id
-
string
取得するオブジェクトの ID。
戻り値
注釈
getItemAt(index)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の 0 から始まるインデックスによって CustomXmlPart を取得します。 インデックスが範囲外の場合、 InvalidArgument 例外をスローします。
getItemAt(index: number): PowerPoint.CustomXmlPart;パラメーター
- index
-
number
コレクション内のカスタム XML パーツのインデックス。
戻り値
指定されたインデックスにあるカスタム XML 部分。
注釈
getItemOrNullObject(id)
ID に基づいて CustomXmlPart を取得します。
CustomXmlPartが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;パラメーター
- id
-
string
取得するオブジェクトの ID。
戻り値
注釈
getOnlyItem()
コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 コレクションに項目が含まれているか、複数の項目が含まれている場合、このメソッドは GeneralException エラーを返します。
getOnlyItem(): PowerPoint.CustomXmlPart;戻り値
注釈
getOnlyItemOrNullObject()
コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 それ以外の場合、このメソッドは nullを返します。
getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;パラメーター
- options
-
PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartScopedCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.CustomXmlPartScopedCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.CustomXmlPartScopedCollectionDataとして型指定) を返します。
toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;