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 ]