Excel.CustomXmlPartCollection class

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

context: RequestContext;

プロパティ値

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

readonly items: Excel.CustomXmlPart[];

プロパティ値

ブックに新しいカスタム XML パーツを追加します。

add(xml: string): Excel.CustomXmlPart;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

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

getByNamespace(namespaceUri: string): Excel.CustomXmlPartScopedCollection;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

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

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

[API セット: ExcelApi 1.5]

ID に基づいて、カスタム XML パーツを取得します。

getItem(id: string): Excel.CustomXmlPart;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

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

getItemOrNullObject(id: string): Excel.CustomXmlPart;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

toJSON(): Excel.Interfaces.CustomXmlPartCollectionData;

返品