Word.XmlMapping class

Пакет:

word

Представляет сопоставление XML в Word. Объект ContentControl между пользовательским XML и этим элементом управления содержимым. Сопоставление XML — это связь между текстом в элементе управления содержимым и XML-элементом в пользовательском хранилище XML-данных для этого документа.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
customXmlNode	CustomXmlNode Возвращает объект , представляющий пользовательский XML-узел в хранилище данных, с которым сопоставляется элемент управления содержимым в документе.
customXmlPart	CustomXmlPart Возвращает объект , представляющий настраиваемую XML-часть, с которой сопоставляется элемент управления содержимым в документе.
isMapped	Возвращает значение, указывающее, сопоставляется ли элемент управления содержимым в документе с узлом XML в хранилище XML-данных документа.
prefixMappings	Возвращает сопоставления префиксов, используемые для вычисления XPath для текущего сопоставления XML.
xpath	Возвращает XPath для сопоставления XML, который вычисляет сопоставленный в данный момент УЗЕЛ XML.

Методы

delete()	Удаляет сопоставление XML из родительского элемента управления содержимым.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setMapping(xPath, options)	Позволяет создавать или изменять сопоставление XML в элементе управления содержимым.
setMappingByNode(node)	Позволяет создавать или изменять сопоставление xml-данных в элементе управления содержимым.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.XmlMapping объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.XmlMappingData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

customXmlNode

CustomXmlNode Возвращает объект , представляющий пользовательский XML-узел в хранилище данных, с которым сопоставляется элемент управления содержимым в документе.

readonly customXmlNode: Word.CustomXmlNode;

Значение свойства

Word.CustomXmlNode

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

customXmlPart

CustomXmlPart Возвращает объект , представляющий настраиваемую XML-часть, с которой сопоставляется элемент управления содержимым в документе.

readonly customXmlPart: Word.CustomXmlPart;

Значение свойства

Word.CustomXmlPart

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

isMapped

Возвращает значение, указывающее, сопоставляется ли элемент управления содержимым в документе с узлом XML в хранилище XML-данных документа.

readonly isMapped: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

prefixMappings

Возвращает сопоставления префиксов, используемые для вычисления XPath для текущего сопоставления XML.

readonly prefixMappings: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

xpath

Возвращает XPath для сопоставления XML, который вычисляет сопоставленный в данный момент УЗЕЛ XML.

readonly xpath: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

Сведения о методе

delete()

Удаляет сопоставление XML из родительского элемента управления содержимым.

delete(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.XmlMappingLoadOptions): Word.XmlMapping;

Параметры

options

Word.Interfaces.XmlMappingLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Word.XmlMapping

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Word.XmlMapping

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.XmlMapping;

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Word.XmlMapping

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Word.Interfaces.XmlMappingUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.XmlMapping): void;

Параметры

properties

Word.XmlMapping

Возвращаемое значение

void

setMapping(xPath, options)

Позволяет создавать или изменять сопоставление XML в элементе управления содержимым.

setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult<boolean>;

Параметры

xPath

string

Выражение XPath для вычисления.

options

Word.XmlSetMappingOptions

Необязательный параметр. Параметры, доступные для настройки сопоставления XML.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

setMappingByNode(node)

Позволяет создавать или изменять сопоставление xml-данных в элементе управления содержимым.

setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult<boolean>;

Параметры

node

Word.CustomXmlNode

Настраиваемый XML-узел для сопоставления.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.XmlMapping объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.XmlMappingData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.XmlMappingData;

Возвращаемое значение

Word.Interfaces.XmlMappingData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.XmlMapping;

Возвращаемое значение

Word.XmlMapping

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.XmlMapping;

Возвращаемое значение

Word.XmlMapping