Word.XmlNode class

Пакет:
word

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

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.4

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

Свойства

attributes

Получает атрибуты узла XML. Возвращает null , если тип узла равен attribute.
baseName

Получает имя элемента без префикса.
childNodes

Получает дочерние элементы этого узла XML. Возвращает пустую коллекцию, если тип узла равен attribute.
context

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

Получает первый дочерний узел, если он является родительским. Возвращает null , если тип узла равен attribute.
hasChildNodes

Получает сведения о том, имеются ли у этого узла XML дочерние узлы. Всегда возвращает false узлы атрибутов, так как они не могут иметь дочерние узлы.
lastChild

Получает последний дочерний узел, если это родительский узел. Возвращает null , если тип узла равен attribute.
level

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

Получает универсальный код ресурса (URI) пространства имен схемы для этого узла XML.
nextSibling

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

Получает родительский документ данного узла XML.
parentNode

Получает родительский элемент узла XML.
placeholderText

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

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

Получает часть документа, содержащуюся в этом узле XML. Возвращает null , если тип узла равен attribute.
text

Определяет текст, содержащийся в элементе XML. Возвращает пустую строку, если тип узла равен attribute.
type

Получает тип узла.
validationErrorText

Получает описание ошибки проверки этого XmlNode объекта. Может быть непонятным для узлов атрибутов.
validationStatus

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

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

Методы

copy()

Копирует этот узел XML, за исключением XML-разметки, в буфер обмена. Для узлов атрибутов копирует только значение атрибута в виде текста.
cut()

Удаляет узел XML из документа и помещает его в буфер обмена. Для узлов атрибутов удаляется атрибут из его родительского элемента и копируется только значение атрибута в виде текста в буфер обмена.
delete()

Удаляет узел XML из XML-документа. Для узлов элементов удаляет весь элемент и его содержимое; для узлов атрибутов удаляет атрибут из родительского элемента.
load(options)

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

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

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

Удаляет дочерний элемент из этого узла XML. Этот метод не действует, если типом узла является attribute (так как узлы атрибутов не имеют дочерних элементов).
selectNodes(xPath, options)

Возвращает все дочерние элементы, соответствующие параметру XPath, в том порядке, в котором они отображаются в этом узле XML. Возвращает null тип attribute узла (так как узлы атрибутов не имеют дочерних элементов для поиска).
selectSingleNode(xPath, options)

Возвращает первый дочерний элемент, соответствующий параметру XPath в этом узле XML. Возвращает null тип attribute узла (так как узлы атрибутов не имеют дочерних элементов для поиска).
setValidationError(status, options)

Изменяет текст ошибки проверки, отображаемый пользователю для этого узла XML, и следует ли принудительно отправлять Word отчет о недопустимом узле. Может быть непонятным для узлов атрибутов.
setValidationError(status, options)

Изменяет текст ошибки проверки, отображаемый пользователю для этого узла XML, и следует ли принудительно отправлять Word отчет о недопустимом узле. Может быть непонятным для узлов атрибутов.
toJSON()

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

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

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

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

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

attributes

Получает атрибуты узла XML. Возвращает null , если тип узла равен attribute.

readonly attributes: Word.XmlNodeCollection;

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

Word.XmlNodeCollection

Комментарии

Набор API: WordApiDesktop 1.4

baseName

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

readonly baseName: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

childNodes

Получает дочерние элементы этого узла XML. Возвращает пустую коллекцию, если тип узла равен attribute.

readonly childNodes: Word.XmlNodeCollection;

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

Word.XmlNodeCollection

Комментарии

Набор API: WordApiDesktop 1.4

context

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

context: RequestContext;

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

Word.RequestContext

firstChild

Получает первый дочерний узел, если он является родительским. Возвращает null , если тип узла равен attribute.

readonly firstChild: Word.XmlNode;

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

Word.XmlNode

Комментарии

Набор API: WordApiDesktop 1.4

hasChildNodes

Получает сведения о том, имеются ли у этого узла XML дочерние узлы. Всегда возвращает false узлы атрибутов, так как они не могут иметь дочерние узлы.

readonly hasChildNodes: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.4

lastChild

Получает последний дочерний узел, если это родительский узел. Возвращает null , если тип узла равен attribute.

readonly lastChild: Word.XmlNode;

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

Word.XmlNode

Комментарии

Набор API: WordApiDesktop 1.4

level

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

readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell";

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

Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"

Комментарии

Набор API: WordApiDesktop 1.4

namespaceUri

Получает универсальный код ресурса (URI) пространства имен схемы для этого узла XML.

readonly namespaceUri: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

nextSibling

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

readonly nextSibling: Word.XmlNode;

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

Word.XmlNode

Комментарии

Набор API: WordApiDesktop 1.4

ownerDocument

Получает родительский документ данного узла XML.

readonly ownerDocument: Word.Document;

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

Word.Document

Комментарии

Набор API: WordApiDesktop 1.4

parentNode

Получает родительский элемент узла XML.

readonly parentNode: Word.XmlNode;

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

Word.XmlNode

Комментарии

Набор API: WordApiDesktop 1.4

placeholderText

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

placeholderText: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

previousSibling

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

readonly previousSibling: Word.XmlNode;

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

Word.XmlNode

Комментарии

Набор API: WordApiDesktop 1.4

range

Получает часть документа, содержащуюся в этом узле XML. Возвращает null , если тип узла равен attribute.

readonly range: Word.Range;

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

Word.Range

Комментарии

Набор API: WordApiDesktop 1.4

text

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

text: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

type

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

readonly type: Word.XmlNodeType | "Element" | "Attribute";

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

Word.XmlNodeType | "Element" | "Attribute"

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

validationErrorText

Получает описание ошибки проверки этого XmlNode объекта. Может быть непонятным для узлов атрибутов.

readonly validationErrorText: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

validationStatus

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

readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom";

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

Word.XmlValidationStatus | "Ok" | "Custom"

Комментарии

Набор API: WordApiDesktop 1.4

value

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

value: string;

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

string

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

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

copy()

Копирует этот узел XML, за исключением XML-разметки, в буфер обмена. Для узлов атрибутов копирует только значение атрибута в виде текста.

copy(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

cut()

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

cut(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

delete()

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

delete(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.XmlNodeLoadOptions): Word.XmlNode;

Параметры

options
Word.Interfaces.XmlNodeLoadOptions

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

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

Word.XmlNode

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.XmlNode

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.XmlNode

removeChild(childElement)

Удаляет дочерний элемент из этого узла XML. Этот метод не действует, если типом узла является attribute (так как узлы атрибутов не имеют дочерних элементов).

removeChild(childElement: Word.XmlNode): void;

Параметры

childElement
Word.XmlNode

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

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

void

Комментарии

Набор API: WordApiDesktop 1.4

selectNodes(xPath, options)

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

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

Параметры

xPath

string

Выражение XPath для оценки.

options
Word.SelectNodesOptions

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

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

Word.XmlNodeCollection

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

Комментарии

Набор API: WordApiDesktop 1.4

selectSingleNode(xPath, options)

Возвращает первый дочерний элемент, соответствующий параметру XPath в этом узле XML. Возвращает null тип attribute узла (так как узлы атрибутов не имеют дочерних элементов для поиска).

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

Параметры

xPath

string

Выражение XPath для оценки.

options
Word.SelectSingleNodeOptions

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

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

Word.XmlNode

Первый узел XML, соответствующий выражению XPath, или null если совпадение не найдено.

Комментарии

Набор API: WordApiDesktop 1.4

setValidationError(status, options)

Изменяет текст ошибки проверки, отображаемый пользователю для этого узла XML, и следует ли принудительно отправлять Word отчет о недопустимом узле. Может быть непонятным для узлов атрибутов.

setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void;

Параметры

status
Word.XmlValidationStatus

Задаваемое состояние проверки.

options
Word.XmlNodeSetValidationErrorOptions

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

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

void

Комментарии

Набор API: WordApiDesktop 1.4

setValidationError(status, options)

Изменяет текст ошибки проверки, отображаемый пользователю для этого узла XML, и следует ли принудительно отправлять Word отчет о недопустимом узле. Может быть непонятным для узлов атрибутов.

setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void;

Параметры

status

"Ok" | "Custom"

Задаваемое состояние проверки.

options
Word.XmlNodeSetValidationErrorOptions

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

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

void

Комментарии

Набор API: WordApiDesktop 1.4

toJSON()

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

toJSON(): Word.Interfaces.XmlNodeData;

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

Word.Interfaces.XmlNodeData

track()

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

track(): Word.XmlNode;

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

Word.XmlNode

untrack()

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

untrack(): Word.XmlNode;

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

Word.XmlNode

validate()

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

validate(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4