Word.CustomXmlPrefixMappingCollection class

包:

word

表示 Word 集合。CustomXmlPrefixMapping 对象。

扩展

OfficeExtension.ClientObject

注解

API 集：WordApiDesktop 1.3

使用方

• Word.CustomXmlPart： namespaceManager

属性

context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

addNamespace(prefix, namespaceUri)	添加要在查询项时使用的自定义命名空间/前缀映射。
getCount()	返回集合中的项目数。
getItem(index)	返回 CustomXmlPrefixMapping 表示集合中指定项目的对象。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
lookupNamespace(prefix)	获取与指定前缀对应的命名空间。
lookupPrefix(namespaceUri)	获取与指定命名空间对应的前缀。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.CustomXmlPrefixMappingCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.CustomXmlPrefixMappingCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。

属性详细信息

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Word.RequestContext

items

获取此集合中已加载的子项。

readonly items: Word.CustomXmlPrefixMapping[];

属性值

Word.CustomXmlPrefixMapping[]

方法详细信息

addNamespace(prefix, namespaceUri)

添加要在查询项时使用的自定义命名空间/前缀映射。

addNamespace(prefix: string, namespaceUri: string): OfficeExtension.ClientResult<number>;

参数

prefix

string

要与命名空间关联的前缀。

namespaceUri

string

要映射的命名空间 URI。

返回

OfficeExtension.ClientResult<number>

注解

API 集：WordApiDesktop 1.3

getCount()

返回集合中的项目数。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

API 集：WordApiDesktop 1.3

getItem(index)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回 CustomXmlPrefixMapping 表示集合中指定项目的对象。

getItem(index: number): Word.CustomXmlPrefixMapping;

参数

index

number

对象的位置 CustomXmlPrefixMapping 。

返回

Word.CustomXmlPrefixMapping

注解

API 集：WordApi BETA (仅预览版)

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPrefixMappingCollection;

参数

options

Word.Interfaces.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

为要加载的对象属性提供选项。

返回

Word.CustomXmlPrefixMappingCollection

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Word.CustomXmlPrefixMappingCollection;

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

Word.CustomXmlPrefixMappingCollection

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPrefixMappingCollection;

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

Word.CustomXmlPrefixMappingCollection

lookupNamespace(prefix)

获取与指定前缀对应的命名空间。

lookupNamespace(prefix: string): OfficeExtension.ClientResult<string>;

参数

prefix

string

要查找的前缀。

返回

OfficeExtension.ClientResult<string>

注解

API 集：WordApiDesktop 1.3

lookupPrefix(namespaceUri)

获取与指定命名空间对应的前缀。

lookupPrefix(namespaceUri: string): OfficeExtension.ClientResult<string>;

参数

namespaceUri

string

要查找的命名空间 URI。

返回

OfficeExtension.ClientResult<string>

注解

API 集：WordApiDesktop 1.3

toJSON()

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

toJSON(): Word.Interfaces.CustomXmlPrefixMappingCollectionData;

返回

Word.Interfaces.CustomXmlPrefixMappingCollectionData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。

track(): Word.CustomXmlPrefixMappingCollection;

返回

Word.CustomXmlPrefixMappingCollection

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。

untrack(): Word.CustomXmlPrefixMappingCollection;

返回

Word.CustomXmlPrefixMappingCollection