PowerPoint.CustomXmlPart class

包:
powerpoint

表示自定义 XML 部件对象。

扩展
OfficeExtension.ClientObject

注解

API 集：PowerPointApi 1.7

使用方

属性

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()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (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()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.CustomXmlPart 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 PowerPoint.Interfaces.CustomXmlPartData) ，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): PowerPoint.Interfaces.CustomXmlPartData;

返回

PowerPoint.Interfaces.CustomXmlPartData