Word.CustomXmlNode class

Пакет:

word

Представляет узел XML в дереве документа. Объект CustomXmlNode является членом Word. CustomXmlNodeCollection.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.3

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

• Word. CustomXmlAddNodeOptions: nextSibling
• Word. CustomXmlInsertNodeBeforeOptions: nextSibling
• Word. CustomXmlInsertSubtreeBeforeOptions: nextSibling
• Word. CustomXmlNodeCollection: getItem, items
• Word. CustomXmlPart: addNode, documentElement, selectSingleNode
• Word. CustomXmlValidationError: узел
• Word. CustomXmlValidationErrorCollection: добавление
• Word. Документ: selectLinkedControls
• Word. XmlMapping: customXmlNode, setMappingByNode

Свойства

attributes	Получает объект, CustomXmlNodeCollection представляющий атрибуты текущего элемента в текущем узле.
baseName	Получает базовое имя узла без префикса пространства имен (если оно существует).
childNodes	Получает объект, CustomXmlNodeCollection содержащий все дочерние элементы текущего узла.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
firstChild	Получает объект, CustomXmlNode соответствующий первому дочернему элементу текущего узла. Если узел не имеет дочерних элементов (или не имеет типа CustomXmlNodeType.element), возвращает Nothing.
lastChild	Получает объект, CustomXmlNode соответствующий последнему дочернему элементу текущего узла. Если узел не имеет дочерних элементов (или не имеет типа CustomXmlNodeType.element), свойство возвращает Nothing.
namespaceUri	Получает уникальный идентификатор адреса для пространства имен узла.
nextSibling	Получает следующий одноуровневый узел (элемент, комментарий или инструкцию обработки) текущего узла. Если узел является последним братом того же уровня на своем уровне, свойство возвращает Nothing.
nodeType	Получает тип текущего узла.
nodeValue	Задает значение текущего узла.
ownerPart	Получает объект, представляющий часть, связанную с этим узлом.
parentNode	Получает узел родительского элемента текущего узла. Если текущий узел находится на корневом уровне, свойство возвращает Nothing.
previousSibling	Получает предыдущий одноуровневый узел (элемент, комментарий или инструкцию обработки) текущего узла. Если текущий узел является первым тем же уровнем на своем уровне, свойство возвращает Nothing.
text	Указывает текст для текущего узла.
xml	Получает XML-представление текущего узла и его дочерних узлов.
xpath	Получает строку с канонизированным XPath для текущего узла. Если узел больше не находится в объектной модели документов (DOM), свойство возвращает сообщение об ошибке.

Методы

appendChildNode(options)	Добавляет один узел в качестве последнего дочернего элемента под узлом элемента контекста в дереве.
appendChildSubtree(xml)	Добавляет поддерево в качестве последнего дочернего элемента под узлом элемента контекста в дереве.
delete()	Удаляет текущий узел из дерева (включая все его дочерние узлы, если таковые существуют).
hasChildNodes()	Указывает, есть ли у текущего узла элемента дочерние узлы элементов.
insertNodeBefore(options)	Вставляет новый узел непосредственно перед узлом контекста в дереве.
insertSubtreeBefore(xml, options)	Вставляет указанное поддерево в расположение непосредственно перед узлом контекста.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
removeChild(child)	Удаляет указанный дочерний узел из дерева.
replaceChildNode(oldNode, options)	Удаляет указанный дочерний узел и заменяет его другим узлом в том же месте.
replaceChildSubtree(xml, oldNode)	Удаляет указанный узел и заменяет его другим поддеревом в том же месте.
selectNodes(xPath)	Выбирает коллекцию узлов, соответствующих выражению XPath.
selectSingleNode(xPath)	Выбирает один узел из коллекции, соответствующей выражению XPath.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CustomXmlNode объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.CustomXmlNodeData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

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

attributes

Получает объект, CustomXmlNodeCollection представляющий атрибуты текущего элемента в текущем узле.

readonly attributes: Word.CustomXmlNodeCollection;

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

Word.CustomXmlNodeCollection

Комментарии

Набор API: WordApiDesktop 1.3

baseName

Получает базовое имя узла без префикса пространства имен (если оно существует).

readonly baseName: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

childNodes

Получает объект, CustomXmlNodeCollection содержащий все дочерние элементы текущего узла.

readonly childNodes: Word.CustomXmlNodeCollection;

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

Word.CustomXmlNodeCollection

Комментарии

Набор API: WordApiDesktop 1.3

context

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

context: RequestContext;

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

Word.RequestContext

firstChild

Получает объект, CustomXmlNode соответствующий первому дочернему элементу текущего узла. Если узел не имеет дочерних элементов (или не имеет типа CustomXmlNodeType.element), возвращает Nothing.

readonly firstChild: Word.CustomXmlNode;

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

Word.CustomXmlNode

Комментарии

Набор API: WordApiDesktop 1.3

lastChild

Получает объект, CustomXmlNode соответствующий последнему дочернему элементу текущего узла. Если узел не имеет дочерних элементов (или не имеет типа CustomXmlNodeType.element), свойство возвращает Nothing.

readonly lastChild: Word.CustomXmlNode;

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

Word.CustomXmlNode

Комментарии

Набор API: WordApiDesktop 1.3

namespaceUri

Получает уникальный идентификатор адреса для пространства имен узла.

readonly namespaceUri: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

nextSibling

Получает следующий одноуровневый узел (элемент, комментарий или инструкцию обработки) текущего узла. Если узел является последним братом того же уровня на своем уровне, свойство возвращает Nothing.

readonly nextSibling: Word.CustomXmlNode;

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

Word.CustomXmlNode

Комментарии

Набор API: WordApiDesktop 1.3

nodeType

Получает тип текущего узла.

readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document";

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

Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"

Комментарии

Набор API: WordApiDesktop 1.3

nodeValue

Задает значение текущего узла.

nodeValue: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

ownerPart

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

readonly ownerPart: Word.CustomXmlPart;

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

Word.CustomXmlPart

Комментарии

Набор API: WordApiDesktop 1.3

parentNode

Получает узел родительского элемента текущего узла. Если текущий узел находится на корневом уровне, свойство возвращает Nothing.

readonly parentNode: Word.CustomXmlNode;

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

Word.CustomXmlNode

Комментарии

Набор API: WordApiDesktop 1.3

previousSibling

Получает предыдущий одноуровневый узел (элемент, комментарий или инструкцию обработки) текущего узла. Если текущий узел является первым тем же уровнем на своем уровне, свойство возвращает Nothing.

readonly previousSibling: Word.CustomXmlNode;

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

Word.CustomXmlNode

Комментарии

Набор API: WordApiDesktop 1.3

text

Указывает текст для текущего узла.

text: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

xml

Получает XML-представление текущего узла и его дочерних узлов.

readonly xml: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

xpath

Получает строку с канонизированным XPath для текущего узла. Если узел больше не находится в объектной модели документов (DOM), свойство возвращает сообщение об ошибке.

readonly xpath: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

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

appendChildNode(options)

Добавляет один узел в качестве последнего дочернего элемента под узлом элемента контекста в дереве.

appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult<number>;

Параметры

options

Word.CustomXmlAppendChildNodeOptions

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

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

OfficeExtension.ClientResult<number>

Комментарии

Набор API: WordApiDesktop 1.3

appendChildSubtree(xml)

Добавляет поддерево в качестве последнего дочернего элемента под узлом элемента контекста в дереве.

appendChildSubtree(xml: string): OfficeExtension.ClientResult<number>;

Параметры

xml

string

Строка, представляющая поддерево XML.

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

OfficeExtension.ClientResult<number>

Комментарии

Набор API: WordApiDesktop 1.3

delete()

Удаляет текущий узел из дерева (включая все его дочерние узлы, если таковые существуют).

delete(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

hasChildNodes()

Указывает, есть ли у текущего узла элемента дочерние узлы элементов.

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

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

OfficeExtension.ClientResult<boolean>

Комментарии

Набор API: WordApiDesktop 1.3

insertNodeBefore(options)

Вставляет новый узел непосредственно перед узлом контекста в дереве.

insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult<number>;

Параметры

options

Word.CustomXmlInsertNodeBeforeOptions

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

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

OfficeExtension.ClientResult<number>

Комментарии

Набор API: WordApiDesktop 1.3

insertSubtreeBefore(xml, options)

Вставляет указанное поддерево в расположение непосредственно перед узлом контекста.

insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult<number>;

Параметры

xml

string

Строка, представляющая поддерево XML.

options

Word.CustomXmlInsertSubtreeBeforeOptions

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

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

OfficeExtension.ClientResult<number>

Комментарии

Набор API: WordApiDesktop 1.3

load(options)

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

load(options?: Word.Interfaces.CustomXmlNodeLoadOptions): Word.CustomXmlNode;

Параметры

options

Word.Interfaces.CustomXmlNodeLoadOptions

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

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

Word.CustomXmlNode

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.CustomXmlNode

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.CustomXmlNode

removeChild(child)

Удаляет указанный дочерний узел из дерева.

removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

Параметры

child

Word.CustomXmlNode

Дочерний узел, который нужно удалить.

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

OfficeExtension.ClientResult<number>

Комментарии

Набор API: WordApiDesktop 1.3

replaceChildNode(oldNode, options)

Удаляет указанный дочерний узел и заменяет его другим узлом в том же месте.

replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult<number>;

Параметры

oldNode

Word.CustomXmlNode

Узел, который нужно заменить.

options

Word.CustomXmlReplaceChildNodeOptions

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

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

OfficeExtension.ClientResult<number>

Комментарии

Набор API: WordApiDesktop 1.3

replaceChildSubtree(xml, oldNode)

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

replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

Параметры

xml

string

Строка, представляющая новое поддерево.

oldNode

Word.CustomXmlNode

Узел, который нужно заменить.

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

OfficeExtension.ClientResult<number>

Комментарии

Набор API: WordApiDesktop 1.3

selectNodes(xPath)

Выбирает коллекцию узлов, соответствующих выражению XPath.

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

Параметры

xPath

string

Выражение XPath.

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

Word.CustomXmlNodeCollection

Комментарии

Набор API: WordApiDesktop 1.3

selectSingleNode(xPath)

Выбирает один узел из коллекции, соответствующей выражению XPath.

selectSingleNode(xPath: string): Word.CustomXmlNode;

Параметры

xPath

string

Выражение XPath.

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

Word.CustomXmlNode

Комментарии

Набор API: WordApiDesktop 1.3

set(properties, options)

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

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

Параметры

properties

Word.Interfaces.CustomXmlNodeUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.CustomXmlNode): void;

Параметры

properties

Word.CustomXmlNode

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

void

toJSON()

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

toJSON(): Word.Interfaces.CustomXmlNodeData;

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

Word.Interfaces.CustomXmlNodeData

track()

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

track(): Word.CustomXmlNode;

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

Word.CustomXmlNode

untrack()

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

untrack(): Word.CustomXmlNode;

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

Word.CustomXmlNode