DocumentBase

Наследование: java.lang.Object, com.aspose.words.Node, com.aspose.words.CompositeNode

public abstract class DocumentBase extends CompositeNode

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

Чтобы узнать больше, посетитеAspose.Words Document Object Model (DOM) документальная статья.

Aspose.Words представляет документ Word в виде дерева узлов.DocumentBase является корневым узлом дерева, содержащего все остальные узлы документа.

DocumentBase также хранит информацию о документе, такую какgetStyles() а такжеgetLists() на которые могут ссылаться узлы дерева.

Методы

Метод	Описание
accept(DocumentVisitor visitor)	Принимает посетителя.
appendChild(Node newChild)	Добавляет указанный узел в конец списка дочерних узлов для этого узла.
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
equals(Object arg0)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getBackgroundShape()	Получает форму фона документа.
getChild(int nodeType, int index, boolean isDeep)
getChildNodes()	Получает все непосредственные дочерние узлы этого узла.
getChildNodes(int nodeType, boolean isDeep)
getClass()
getContainer()
getCount()	Получает количество непосредственных дочерних элементов этого узла.
getCurrentNode()
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDocument()
getFirstChild()	Получает первый дочерний элемент узла.
getFontInfos()	Предоставляет доступ к свойствам шрифтов, используемых в этом документе.
getLastChild()	Получает последний дочерний элемент узла.
getLists()	Предоставляет доступ к форматированию списка, используемому в документе.
getNextMatchingNode(Node curNode)
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeChangingCallback()	Вызывается при вставке или удалении узла в документе.
getNodeType()	Получает тип этого узла.
getPageColor()	Получает цвет страницы документа.
getParentNode()	Получает непосредственного родителя этого узла.
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getResourceLoadingCallback()	Позволяет контролировать загрузку внешних ресурсов.
getStyles()	Возвращает набор стилей, определенных в документе.
getText()	Получает текст этого узла и всех его дочерних элементов.
getWarningCallback()	Вызывается во время различных процедур обработки документов при обнаружении проблемы, которая может привести к потере точности данных или форматирования.
hasChildNodes()	Возвращает true, если у этого узла есть дочерние узлы.
hashCode()
importNode(Node srcNode, boolean isImportChildren)	Импортирует узел из другого документа в текущий документ.
importNode(Node srcNode, boolean isImportChildren, int importFormatMode)
indexOf(Node child)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
insertAfter(Node newChild, Node refChild)	Вставляет указанный узел сразу после указанного ссылочного узла.
insertBefore(Node newChild, Node refChild)	Вставляет указанный узел непосредственно перед указанным ссылочным узлом.
isComposite()	Возвращает true, так как этот узел может иметь дочерние узлы.
iterator()	Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.
nextPreOrder(Node rootNode)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
nodeTypeToString(int nodeType)
notify()
notifyAll()
prependChild(Node newChild)	Добавляет указанный узел в начало списка дочерних узлов для этого узла.
previousPreOrder(Node rootNode)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
remove()	Удаляет себя из родителя.
removeAllChildren()	Удаляет все дочерние узлы текущего узла.
removeChild(Node oldChild)	Удаляет указанный дочерний узел.
removeSmartTags()	Удаляет всеSmartTag узлы-потомки текущего узла.
selectNodes(String xpath)	Выбирает список узлов, соответствующих выражению XPath.
selectSingleNode(String xpath)	Выбирает первый узел, соответствующий выражению XPath.
setBackgroundShape(Shape value)	Устанавливает форму фона документа.
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
setNodeChangingCallback(INodeChangingCallback value)	Вызывается при вставке или удалении узла в документе.
setPageColor(Color value)	Устанавливает цвет страницы документа.
setResourceLoadingCallback(IResourceLoadingCallback value)	Позволяет контролировать загрузку внешних ресурсов.
setWarningCallback(IWarningCallback value)	Вызывается во время различных процедур обработки документов при обнаружении проблемы, которая может привести к потере точности данных или форматирования.
toString()
toString(SaveOptions saveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

accept(DocumentVisitor visitor)

public abstract boolean accept(DocumentVisitor visitor)

Принимает посетителя.

Перечисляет этот узел и все его дочерние элементы. Каждый узел вызывает соответствующий метод в DocumentVisitor.

Дополнительные сведения см. в шаблоне проектирования «Посетитель».

Параметры:

Параметр	Тип	Описание
visitor	DocumentVisitor	Посетитель, который будет посещать узлы.

Возвращает: boolean - Истинно, если были посещены все узлы; false, если DocumentVisitor остановил операцию перед посещением всех узлов.

appendChild(Node newChild)

public Node appendChild(Node newChild)

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

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.

Параметры:

Параметр	Тип	Описание
newChild	Node	Добавляемый узел.

Возвращает: Node - Добавлен узел.

dd()

public void dd()

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

Создает дубликат узла.

Этот метод служит конструктором копирования для узлов. Клонированный узел не имеет родителя, но принадлежит к тому же документу, что и исходный узел.

Этот метод всегда выполняет глубокую копию узла.isCloneChildren Параметр указывает, следует ли также выполнять копирование всех дочерних узлов.

Параметры:

Параметр	Тип	Описание
isCloneChildren	boolean	Значение true, чтобы рекурсивно клонировать поддерево в указанном узле; false, чтобы клонировать только сам узел.

Возвращает: Node - Клонированный узел.

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

Параметр	Тип	Описание
arg0	java.lang.Object

Возвращает: логический

getAncestor(int ancestorType)

public CompositeNode getAncestor(int ancestorType)

Параметры:

Параметр	Тип	Описание
ancestorType	int

Возвращает: CompositeNode

getAncestor(Class ancestorType)

public CompositeNode getAncestor(Class ancestorType)

Получает первого предка указанного типа объекта.

Параметры:

Параметр	Тип	Описание
ancestorType	java.lang.Class	Тип объекта-предка для извлечения.

Возвращает: CompositeNode - предок указанного типа или ноль, если предок этого типа не найден.

Тип предка совпадает, если он равен ancestorType или является производным от ancestorType.

getBackgroundShape()

public Shape getBackgroundShape()

Получает форму фона документа. Может быть нулевым.

Microsoft Word допускает только ту форму, которая имеет своюShapeBase.getShapeType() свойство, равноеShapeType.RECTANGLE для использования в качестве фоновой формы для документа.

Microsoft Word поддерживает только свойства заливки фоновой фигуры. Все остальные свойства игнорируются.

Установка для этого свойства ненулевого значения также установитViewOptions.getDisplayBackgroundShape() / ViewOptions.setDisplayBackgroundShape(boolean) к истине.

Возвращает: Shape - Форма фона документа.

getChild(int nodeType, int index, boolean isDeep)

public Node getChild(int nodeType, int index, boolean isDeep)

Параметры:

Параметр	Тип	Описание
nodeType	int
index	int
isDeep	boolean

Возвращает: Node

getChildNodes()

public NodeCollection getChildNodes()

Получает все непосредственные дочерние узлы этого узла.

Примечание,getChildNodes() эквивалентно вызову GetChildNodes(NodeType.Any, false) и создает и возвращает новую коллекцию при каждом доступе к ней.

Если дочерних узлов нет, это свойство возвращает пустую коллекцию.

Возвращает: NodeCollection - Все непосредственные дочерние узлы этого узла.

getChildNodes(int nodeType, boolean isDeep)

public NodeCollection getChildNodes(int nodeType, boolean isDeep)

Параметры:

Параметр	Тип	Описание
nodeType	int
isDeep	boolean

Возвращает: NodeCollection

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getContainer()

public CompositeNode getContainer()

Возвращает: CompositeNode

getCount()

public int getCount()

Получает количество непосредственных дочерних элементов этого узла.

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

getCurrentNode()

public Node getCurrentNode()

Возвращает: Node

getCustomNodeId()

public int getCustomNodeId()

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Этот идентификатор можно установить и использовать произвольно. Например, как ключ для получения внешних данных.

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

Возвращает: int - соответствующее значение int.

getDocument()

public DocumentBase getDocument()

Получает документ, которому принадлежит этот узел.

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

Возвращает: DocumentBase

getFirstChild()

public Node getFirstChild()

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

Возвращает: Node - Первый дочерний узел.

getFontInfos()

public FontInfoCollection getFontInfos()

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

Эта коллекция определений шрифтов загружается как есть из документа. Определения шрифтов могут быть необязательными, отсутствовать или быть неполными в некоторых документах.

Не полагайтесь на эту коллекцию, чтобы убедиться, что в документе используется определенный шрифт. Вы должны использовать эту коллекцию только для получения информации о шрифтах, которые могут использоваться в документе.

Возвращает: FontInfoCollection - соответствующийFontInfoCollection ценность.

getLastChild()

public Node getLastChild()

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

Возвращает: Node - Последний дочерний узел.

getLists()

public ListCollection getLists()

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

Для получения дополнительной информации см. описаниеListCollection учебный класс.

Возвращает: ListCollection - соответствующийListCollection ценность.

getNextMatchingNode(Node curNode)

public Node getNextMatchingNode(Node curNode)

Параметры:

Параметр	Тип	Описание
curNode	Node

Возвращает: Node

getNextSibling()

public Node getNextSibling()

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

Возвращает: Node - Узел, непосредственно следующий за этим узлом.

getNodeChangingCallback()

public INodeChangingCallback getNodeChangingCallback()

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

Возвращает: INodeChangingCallback - соответствующийINodeChangingCallback ценность.

getNodeType()

public abstract int getNodeType()

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

Возвращает: int - Тип этого узла. Возвращаемое значение является одним изNodeType константы.

getPageColor()

public Color getPageColor()

Получает цвет страницы документа. Это свойство является упрощенной версиейgetBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

Это свойство предоставляет простой способ указать сплошной цвет страницы для документа. Установка этого свойства создает и устанавливает соответствующийgetBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

Если цвет страницы не задан (например, в документе нет формы фона), возвращает нулевой цвет.

Возвращает: java.awt.Color — цвет страницы документа.

getParentNode()

public CompositeNode getParentNode()

Получает непосредственного родителя этого узла.

Если узел был только что создан и еще не добавлен в дерево, или если он был удален из дерева, родитель имеет значение null.

Возвращает: CompositeNode - Непосредственный родитель этого узла.

getPreviousSibling()

public Node getPreviousSibling()

Получает узел, непосредственно предшествующий этому узлу. Если предыдущего узла нет, возвращается нуль.

Возвращает: Node - Узел, непосредственно предшествующий этому узлу.

getRange()

public Range getRange()

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

Возвращает: Range - АRange объект, который представляет часть документа, содержащегося в этом узле.

getResourceLoadingCallback()

public IResourceLoadingCallback getResourceLoadingCallback()

Позволяет контролировать загрузку внешних ресурсов.

Возвращает: IResourceLoadingCallback - соответствующийIResourceLoadingCallback ценность.

getStyles()

public StyleCollection getStyles()

Возвращает набор стилей, определенных в документе.

Для получения дополнительной информации см. описаниеStyleCollection учебный класс.

Возвращает: StyleCollection - Набор стилей, определенных в документе.

getText()

public String getText()

Получает текст этого узла и всех его дочерних элементов.

Возвращаемая строка включает все управляющие и специальные символы, как описано вControlChar.

Возвращает: java.lang.String

getWarningCallback()

public IWarningCallback getWarningCallback()

Вызывается во время различных процедур обработки документов при обнаружении проблемы, которая может привести к потере точности данных или форматирования. Документ может генерировать предупреждения на любом этапе своего существования, поэтому важно настроить обратный вызов предупреждения как можно раньше, чтобы избежать потери предупреждений. Например, такие свойства, какDocument.getPageCount() на самом деле создать макет документа, который позже используется для рендеринга, и предупреждения макета могут быть потеряны, если обратный вызов предупреждения указан только для вызовов рендеринга позже.

Возвращает: IWarningCallback - соответствующийIWarningCallback ценность.

hasChildNodes()

public boolean hasChildNodes()

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

Возвращает: boolean — Истинно, если у этого узла есть дочерние узлы.

hashCode()

public native int hashCode()

Возвращает: инт

importNode(Node srcNode, boolean isImportChildren)

public Node importNode(Node srcNode, boolean isImportChildren)

Импортирует узел из другого документа в текущий документ.

Этот метод используетImportFormatMode.USE_DESTINATION_STYLES возможность разрешить форматирование.

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

Прежде чем узел из другого документа можно будет вставить в этот документ, его необходимо импортировать. Во время импорта свойства документа, такие как ссылки на стили и списки, переводятся из оригинала в импортируемый документ. После того, как узел был импортирован, его можно вставить в соответствующее место документа с помощьюCompositeNode.insertBefore(com.aspose.words.Node, com.aspose.words.Node) или жеCompositeNode.insertAfter(com.aspose.words.Node, com.aspose.words.Node).

Если исходный узел уже принадлежит целевому документу, то создается просто глубокий клон исходного узла.

Параметры:

Параметр	Тип	Описание
srcNode	Node	Импортируемый узел.
isImportChildren	boolean	Значение true для рекурсивного импорта всех дочерних узлов; в противном случае ложно.

Возвращает: Node Клонированный узел, принадлежащий текущему документу.

importNode(Node srcNode, boolean isImportChildren, int importFormatMode)

public Node importNode(Node srcNode, boolean isImportChildren, int importFormatMode)

Параметры:

Параметр	Тип	Описание
srcNode	Node
isImportChildren	boolean
importFormatMode	int

Возвращает: Node

indexOf(Node child)

public int indexOf(Node child)

Возвращает индекс указанного дочернего узла в массиве дочерних узлов. Возвращает -1, если узел не найден среди дочерних узлов.

Параметры:

Параметр	Тип	Описание
child	Node

Возвращает: инт

insertAfter(Node newChild, Node refChild)

public Node insertAfter(Node newChild, Node refChild)

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

Если refChild имеет значение null, вставляет newChild в начало списка дочерних узлов.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Параметры:

Параметр	Тип	Описание
newChild	Node	Узел для вставки.
refChild	Node	Узел, который является эталонным узлом. newNode размещается после refNode.

Возвращает: Node - Вставленный узел.

insertBefore(Node newChild, Node refChild)

public Node insertBefore(Node newChild, Node refChild)

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

Если refChild имеет значение null, вставляет newChild в конец списка дочерних узлов.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Параметры:

Параметр	Тип	Описание
newChild	Node	Узел для вставки.
refChild	Node	Узел, который является эталонным узлом. Новый дочерний элемент помещается перед этим узлом.

Возвращает: Node - Вставленный узел.

isComposite()

public boolean isComposite()

Возвращает true, так как этот узел может иметь дочерние узлы.

Возвращает: boolean — True, так как этот узел может иметь дочерние узлы.

iterator()

public Iterator iterator()

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

Возвращает: java.util.Iterator

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

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

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Следующий узел в порядке предварительного заказа. Null, если достигнут rootNode.

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

Параметры:

Параметр	Тип	Описание
nodeType	int

Возвращает: java.lang.String

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

prependChild(Node newChild)

public Node prependChild(Node newChild)

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

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Параметры:

Параметр	Тип	Описание
newChild	Node	Добавляемый узел.

Возвращает: Node - Добавлен узел.

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

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

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Предыдущий узел в порядке предварительного заказа. Null, если достигнут rootNode.

remove()

public void remove()

Удаляет себя из родителя.

removeAllChildren()

public void removeAllChildren()

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

removeChild(Node oldChild)

public Node removeChild(Node oldChild)

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

Родительский элемент oldChild устанавливается равным нулю после удаления узла.

Параметры:

Параметр	Тип	Описание
oldChild	Node	Узел для удаления.

Возвращает: Node - Удаленный узел.

removeSmartTags()

public void removeSmartTags()

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

selectNodes(String xpath)

public NodeList selectNodes(String xpath)

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

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

Параметры:

Параметр	Тип	Описание
xpath	java.lang.String	Выражение XPath.

Возвращает: NodeList - Список узлов, соответствующих запросу XPath.

selectSingleNode(String xpath)

public Node selectSingleNode(String xpath)

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

Параметры:

Параметр	Тип	Описание
xpath	java.lang.String	Выражение XPath.

Возвращает: Node - Первый узел, соответствующий запросу XPath, или нуль, если соответствующий узел не найден.

setBackgroundShape(Shape value)

public void setBackgroundShape(Shape value)

Устанавливает форму фона документа. Может быть нулевым.

Microsoft Word поддерживает только свойства заливки фоновой фигуры. Все остальные свойства игнорируются.

Параметры:

Параметр	Тип	Описание
value	Shape	Форма фона документа.

setCustomNodeId(int value)

public void setCustomNodeId(int value)

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение.

setNodeChangingCallback(INodeChangingCallback value)

public void setNodeChangingCallback(INodeChangingCallback value)

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

Параметры:

Параметр	Тип	Описание
value	INodeChangingCallback	СоответствующийINodeChangingCallback ценность.

setPageColor(Color value)

public void setPageColor(Color value)

Устанавливает цвет страницы документа. Это свойство является упрощенной версиейgetBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

Если цвет страницы не задан (например, в документе нет формы фона), возвращает нулевой цвет.

Параметры:

Параметр	Тип	Описание
value	java.awt.Color	Цвет страницы документа.

setResourceLoadingCallback(IResourceLoadingCallback value)

public void setResourceLoadingCallback(IResourceLoadingCallback value)

Позволяет контролировать загрузку внешних ресурсов.

Параметры:

Параметр	Тип	Описание
value	IResourceLoadingCallback	СоответствующийIResourceLoadingCallback ценность.

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Параметры:

Параметр	Тип	Описание
value	IWarningCallback	СоответствующийIWarningCallback ценность.

toString()

public String toString()

Возвращает: java.lang.String

toString(SaveOptions saveOptions)

public String toString(SaveOptions saveOptions)

Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Параметры:

Параметр	Тип	Описание
saveOptions	SaveOptions	Указывает параметры, управляющие способом сохранения узла.

Возвращает: java.lang.String — содержимое узла в указанном формате.

toString(int saveFormat)

public String toString(int saveFormat)

Параметры:

Параметр	Тип	Описание
saveFormat	int

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

Параметр	Тип	Описание
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

Параметр	Тип	Описание
arg0	long
arg1	int

Document DocumentBuilder