Word.XmlMapping class

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

Свойства

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

customXmlPart

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

readonly customXmlPart: Word.CustomXmlPart;

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

Word.CustomXmlPart

isMapped

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

readonly isMapped: boolean;

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

boolean

prefixMappings

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

readonly prefixMappings: string;

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

string

xpath

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

readonly xpath: string;

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

string

delete()

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

delete(): void;

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

void

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

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

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

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>

setMappingByNode(node)

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

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

Параметры

node: Word.CustomXmlNode

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

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

OfficeExtension.ClientResult<boolean>

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

Комментарии

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

Свойства

Методы

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

context

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

customXmlNode

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

Комментарии

customXmlPart

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

Комментарии

isMapped

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

Комментарии

prefixMappings

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

Комментарии

xpath

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

Комментарии

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

delete()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setMapping(xPath, options)

Параметры

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

Комментарии

setMappingByNode(node)

Параметры

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

Комментарии

toJSON()

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

track()

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

untrack()

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

Обратная связь