PowerPoint.CustomXmlPart class

パッケージ:

powerpoint

カスタム XML パーツ オブジェクトを表します。

Extends

OfficeExtension.ClientObject

注釈

API セット: PowerPointApi 1.7

使用元

• PowerPoint.CustomXmlPartCollection: add, getItem, getItemAt, getItemOrNullObject, items
• PowerPoint.CustomXmlPartScopedCollection: getItem, getItemAt, getItemOrNullObject, getOnlyItem, getOnlyItemOrNullObject, items

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
id	カスタム XML パーツの ID。
namespaceUri	カスタム XML パーツの名前空間 URI。

メソッド

delete()	カスタム XML パーツを削除します。
getXml()	カスタム XML パーツの XML コンテンツを取得します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
setXml(xml)	カスタム XML パーツの XML コンテンツを設定します。
toJSON()	API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.CustomXmlPart オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.CustomXmlPartData として型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

PowerPoint.RequestContext

id

カスタム XML パーツの ID。

readonly id: string;

プロパティ値

string

注釈

API セット: PowerPointApi 1.7

namespaceUri

カスタム XML パーツの名前空間 URI。

readonly namespaceUri: string;

プロパティ値

string

注釈

API セット: PowerPointApi 1.7

メソッドの詳細

delete()

カスタム XML パーツを削除します。

delete(): void;

返品

void

注釈

API セット: PowerPointApi 1.7

getXml()

カスタム XML パーツの XML コンテンツを取得します。

getXml(): OfficeExtension.ClientResult<string>;

返品

OfficeExtension.ClientResult<string>

注釈

API セット: PowerPointApi 1.7

load(options)

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

load(options?: PowerPoint.Interfaces.CustomXmlPartLoadOptions): PowerPoint.CustomXmlPart;

パラメーター

options

PowerPoint.Interfaces.CustomXmlPartLoadOptions

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

返品

PowerPoint.CustomXmlPart

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

PowerPoint.CustomXmlPart

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.CustomXmlPart;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

返品

PowerPoint.CustomXmlPart

setXml(xml)

カスタム XML パーツの XML コンテンツを設定します。

setXml(xml: string): void;

パラメーター

xml

string

パーツの XML コンテンツ。

返品

void

注釈

API セット: PowerPointApi 1.7

toJSON()

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

toJSON(): PowerPoint.Interfaces.CustomXmlPartData;

返品

PowerPoint.Interfaces.CustomXmlPartData