Word.CustomXmlNode class

Пакет:: word

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

Extends: OfficeExtension.ClientObject

Свойства

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

baseName

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

readonly baseName: string;

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

string

childNodes

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

readonly childNodes: Word.CustomXmlNodeCollection;

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

Word.CustomXmlNodeCollection

context

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

context: RequestContext;

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

Word.RequestContext

firstChild

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

readonly firstChild: Word.CustomXmlNode;

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

Word.CustomXmlNode

lastChild

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

readonly lastChild: Word.CustomXmlNode;

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

Word.CustomXmlNode

namespaceUri

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

readonly namespaceUri: string;

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

string

nextSibling

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

readonly nextSibling: Word.CustomXmlNode;

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

Word.CustomXmlNode

nodeType

Возвращает тип текущего узла.

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

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

nodeValue

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

nodeValue: string;

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

string

ownerPart

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

readonly ownerPart: Word.CustomXmlPart;

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

Word.CustomXmlPart

parentNode

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

readonly parentNode: Word.CustomXmlNode;

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

Word.CustomXmlNode

previousSibling

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

readonly previousSibling: Word.CustomXmlNode;

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

Word.CustomXmlNode

text

Задает текст для текущего узла.

text: string;

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

string

xml

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

readonly xml: string;

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

string

xpath

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

readonly xpath: string;

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

string

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

appendChildNode(options)

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

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

Параметры

options: Word.CustomXmlAppendChildNodeOptions

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

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

OfficeExtension.ClientResult<number>

appendChildSubtree(xml)

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

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

Параметры

xml: string

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

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

OfficeExtension.ClientResult<number>

delete()

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

delete(): void;

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

void

hasChildNodes()

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

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

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

OfficeExtension.ClientResult<boolean>

insertNodeBefore(options)

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

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

Параметры

options: Word.CustomXmlInsertNodeBeforeOptions

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

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

OfficeExtension.ClientResult<number>

insertSubtreeBefore(xml, options)

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

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

Параметры

xml: string

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

options: Word.CustomXmlInsertSubtreeBeforeOptions

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

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

OfficeExtension.ClientResult<number>

load(options)

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

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

Параметры

options: Word.Interfaces.CustomXmlNodeLoadOptions

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

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

Word.CustomXmlNode

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.CustomXmlNode

load(propertyNamesAndPaths)

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>

replaceChildNode(oldNode, options)

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

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

Параметры

oldNode: Word.CustomXmlNode

Заменяемый узел.

options: Word.CustomXmlReplaceChildNodeOptions

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

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

OfficeExtension.ClientResult<number>

replaceChildSubtree(xml, oldNode)

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

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

Параметры

xml: string

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

oldNode: Word.CustomXmlNode

Заменяемый узел.

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

OfficeExtension.ClientResult<number>

selectNodes(xPath)

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

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

Параметры

xPath: string

Выражение XPath.

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

Word.CustomXmlNodeCollection

selectSingleNode(xPath)

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

selectSingleNode(xPath: string): Word.CustomXmlNode;

Параметры

xPath: string

Выражение XPath.

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

Word.CustomXmlNode

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.CustomXmlNodeUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

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

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

Были ли сведения на этой странице полезными?

Поделиться через

Word.CustomXmlNode class

Комментарии

Свойства

Методы

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

attributes

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

Комментарии

baseName

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

Комментарии

childNodes

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

Комментарии

context

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

firstChild

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

Комментарии

lastChild

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

Комментарии

namespaceUri

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

Комментарии

nextSibling

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

Комментарии

nodeType

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

Комментарии

nodeValue

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

Комментарии

ownerPart

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

Комментарии

parentNode

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

Комментарии

previousSibling

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

Комментарии

text

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

Комментарии

xml

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

Комментарии

xpath

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

Комментарии

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

appendChildNode(options)

Параметры

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

Комментарии

appendChildSubtree(xml)

Параметры

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

Комментарии

delete()

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

Комментарии

hasChildNodes()

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

Комментарии

insertNodeBefore(options)

Параметры

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

Комментарии

insertSubtreeBefore(xml, options)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)