Office.CustomXmlPrefixMappings interface

Пакет:

office

Представляет коллекцию объектов CustomXmlPart.

Комментарии

Приложения: Word

Используется

• Office.CustomXmlPart: namespaceManager

Методы

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

TSpecis префикс, для которого нужно получить пространство имен. Обязательно.

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

TSpecis префикс, для которого нужно получить пространство имен. Обязательно.

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

Если для запрошенного пространства имен префикс не назначен, метод возвращает пустую строку (""). Если в диспетчере пространств имен указано несколько префиксов, метод возвращает первый префикс, соответствующий указанному пространству имен.