Office.CustomXmlPrefixMappings interface

包:

office

表示 CustomXmlPart 对象的集合。

注解

应用程序：Word

方法

addNamespaceAsync(prefix, ns, options, callback)	将前缀异步添加到命名空间映射，以便查询某个项时使用。
addNamespaceAsync(prefix, ns, callback)	将前缀异步添加到命名空间映射，以便查询某个项时使用。
getNamespaceAsync(prefix, options, callback)	异步获取映射到指定前缀的命名空间。
getNamespaceAsync(prefix, callback)	异步获取映射到指定前缀的命名空间。
getPrefixAsync(ns, options, callback)	异步获取指定命名空间的前缀。
getPrefixAsync(ns, callback)	异步获取指定命名空间的前缀。

方法详细信息

addNamespaceAsync(prefix, ns, options, callback)

将前缀异步添加到命名空间映射，以便查询某个项时使用。

addNamespaceAsync(prefix: string, ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

参数

prefix

string

指定要添加到前缀映射列表的前缀。 必填。

ns

string

指定要分配给新添加前缀的命名空间 URI。 必填。

options

Office.AsyncContextOptions

提供一个选项，用于保留任何类型的上下文数据（保持不变），以便在回调中使用。

callback

(result: Office.AsyncResult<void>) => void

可选。 回调返回时调用的函数，其唯一参数的类型为 Office.AsyncResult。

返回

void

注解

要求集： CustomXmlParts

如果未将任何命名空间分配给请求的前缀，该方法将返回空字符串 ("")。

addNamespaceAsync(prefix, ns, callback)

将前缀异步添加到命名空间映射，以便查询某个项时使用。

addNamespaceAsync(prefix: string, ns: string, callback?: (result: AsyncResult<void>) => void): void;

参数

prefix

string

指定要添加到前缀映射列表的前缀。 必填。

ns

string

指定要分配给新添加前缀的命名空间 URI。 必填。

callback

(result: Office.AsyncResult<void>) => void

可选。 回调返回时调用的函数，其唯一参数的类型为 Office.AsyncResult。

返回

void

注解

要求集： CustomXmlParts

如果未将任何命名空间分配给请求的前缀，该方法将返回空字符串 ("")。

getNamespaceAsync(prefix, options, callback)

异步获取映射到指定前缀的命名空间。

getNamespaceAsync(prefix: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

参数

prefix

string

指定前缀以获取其命名空间。 必填。

options

Office.AsyncContextOptions

提供一个选项，用于保留任何类型的上下文数据（保持不变），以便在回调中使用。

callback

(result: Office.AsyncResult<string>) => void

可选。 回调返回时调用的函数，其唯一参数的类型为 Office.AsyncResult。 value结果的 属性是一个字符串，其中包含映射到指定前缀的命名空间。

返回

void

注解

要求集： CustomXmlParts

如果命名空间管理器中已存在前缀，则此方法将重写该前缀的映射，除非数据库在内部添加或使用前缀，这种情况下，将返回错误。

getNamespaceAsync(prefix, callback)

异步获取映射到指定前缀的命名空间。

getNamespaceAsync(prefix: string, callback?: (result: AsyncResult<string>) => void): void;

参数

prefix

string

指定前缀以获取其命名空间。 必填。

callback

(result: Office.AsyncResult<string>) => void

可选。 回调返回时调用的函数，其唯一参数的类型为 Office.AsyncResult。 value结果的 属性是一个字符串，其中包含映射到指定前缀的命名空间。

返回

void

注解

要求集： CustomXmlParts

如果命名空间管理器中已存在前缀，则此方法将重写该前缀的映射，除非数据库在内部添加或使用前缀，这种情况下，将返回错误。

getPrefixAsync(ns, options, callback)

异步获取指定命名空间的前缀。

getPrefixAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

参数

ns

string

指定要为其获取前缀的命名空间。 必填。

options

Office.AsyncContextOptions

提供一个选项，用于保留任何类型的上下文数据（保持不变），以便在回调中使用。

callback

(result: Office.AsyncResult<string>) => void

可选。 回调返回时调用的函数，其唯一参数的类型为 Office.AsyncResult。 value结果的 属性是包含指定命名空间前缀的字符串。

返回

void

注解

要求集： CustomXmlParts

如果未向请求的命名空间分配任何前缀，该方法将返回空字符串 ("")。 如果在命名空间管理器中指定了多个前缀，则该方法将返回匹配所应用的命名空间的第一个前缀。

getPrefixAsync(ns, callback)

异步获取指定命名空间的前缀。

getPrefixAsync(ns: string, callback?: (result: AsyncResult<string>) => void): void;

参数

ns

string

指定要为其获取前缀的命名空间。 必填。

callback

(result: Office.AsyncResult<string>) => void

可选。 回调返回时调用的函数，其唯一参数的类型为 Office.AsyncResult。 value结果的 属性是包含指定命名空间前缀的字符串。

返回

void

注解

要求集： CustomXmlParts

如果未向请求的命名空间分配任何前缀，该方法将返回空字符串 ("")。 如果在命名空间管理器中指定了多个前缀，则该方法将返回匹配所应用的命名空间的第一个前缀。