BuildingBlock

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

public class BuildingBlock extends CompositeNode

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

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

BuildingBlock может содержать толькоSection узлы.

BuildingBlock может быть только ребенкомGlossaryDocument.

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

СоответствуетdocPart, docPartPr а такжеdocPartBody элементы в OOXML.

Конструкторы

Конструктор	Описание
BuildingBlock(GlossaryDocument glossaryDoc)	Инициализирует новый экземпляр этого класса.

Методы

Метод	Описание
accept(DocumentVisitor visitor)	Принимает посетителя.
appendChild(Node newChild)	Добавляет указанный узел в конец списка дочерних узлов для этого узла.
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
equals(Object arg0)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getBehavior()	Определяет поведение, которое должно применяться, когда содержимое стандартного блока вставляется в основной документ.
getCategory()	Указывает категоризацию второго уровня для стандартного блока.
getChild(int nodeType, int index, boolean isDeep)
getChildNodes()	Получает все непосредственные дочерние узлы этого узла.
getChildNodes(int nodeType, boolean isDeep)
getClass()
getContainer()
getCount()	Получает количество непосредственных дочерних элементов этого узла.
getCurrentNode()
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDescription()	Получает описание, связанное с этим стандартным блоком.
getDocument()	Получает документ, которому принадлежит этот узел.
getFirstChild()	Получает первый дочерний элемент узла.
getFirstSection()	Получает первый раздел в стандартном блоке.
getGallery()	Задает категоризацию первого уровня для стандартного блока в целях классификации или сортировки пользовательского интерфейса.
getGuid()	Получает идентификатор (128-разрядный GUID), однозначно идентифицирующий этот стандартный блок.
getLastChild()	Получает последний дочерний элемент узла.
getLastSection()	Получает последний раздел в стандартном блоке.
getName()	Получает имя этого стандартного блока.
getNextMatchingNode(Node curNode)
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeType()	ВозвращаетNodeType.BUILDING_BLOCK ценность.
getParentNode()	Получает непосредственного родителя этого узла.
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getSections()	Возвращает коллекцию, представляющую все разделы стандартного блока.
getText()	Получает текст этого узла и всех его дочерних элементов.
getType()	Задает тип стандартного блока.
hasChildNodes()	Возвращает true, если у этого узла есть дочерние узлы.
hashCode()
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.
setBehavior(int value)	Определяет поведение, которое должно применяться, когда содержимое стандартного блока вставляется в основной документ.
setCategory(String value)	Указывает категоризацию второго уровня для стандартного блока.
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
setDescription(String value)	Задает описание, связанное с этим стандартным блоком.
setGallery(int value)	Задает категоризацию первого уровня для стандартного блока в целях классификации или сортировки пользовательского интерфейса.
setGuid(UUID value)	Задает идентификатор (128-разрядный GUID), однозначно идентифицирующий этот стандартный блок.
setName(String value)	Задает имя этого стандартного блока.
setType(int value)	Задает тип стандартного блока.
toString()
toString(SaveOptions saveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

BuildingBlock(GlossaryDocument glossaryDoc)

public BuildingBlock(GlossaryDocument glossaryDoc)

Инициализирует новый экземпляр этого класса.

КогдаBuildingBlock создан, он принадлежит указанному документу глоссария, но еще не является частью документа глоссария иNode.getParentNode() нулевой .

Чтобы добавитьBuildingBlock кGlossaryDocument использоватьCompositeNode.appendChild(com.aspose.words.Node).

Параметры:

Параметр	Тип	Описание
glossaryDoc	GlossaryDocument	Документ владельца.

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

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

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

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

Параметры:

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

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

ЗвонкиDocumentVisitor.visitBuildingBlockStart(com.aspose.words.BuildingBlock) , затем звонитNode.accept(com.aspose.words.DocumentVisitor) для всех дочерних узлов этого строительного блока, затем вызываетDocumentVisitor.visitBuildingBlockEnd(com.aspose.words.BuildingBlock).

Примечание. Узел стандартного блока и его дочерние элементы не посещаются, когда вы выполняете посетителя над узлом.Document . Если вы хотите выполнить посетителя над строительным блоком, вам нужно выполнить посетителя надGlossaryDocument или позвоните по телефонуaccept(com.aspose.words.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.

getBehavior()

public int getBehavior()

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

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изBuildingBlockBehavior константы.

getCategory()

public String getCategory()

Указывает категоризацию второго уровня для стандартного блока.

Стандартные блоки в пользовательском интерфейсе Microsoft Word объединены в галереи. КаждыйgetGallery() / setGallery(int) может иметь несколько категорий. Каждый блок внутриgetCategory() / setCategory(java.lang.String) имеетgetName() / setName(java.lang.String).

Не может быть нулевым и не может быть пустой строкой.

СоответствуетdocPartPr.category.name элемент в OOXML.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

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.

getDescription()

public String getDescription()

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

Описание может содержать любое строковое содержимое, обычно дополнительную информацию.

Не может быть null , но может быть пустой строкой.

СоответствуетdocPartPr.description элемент в OOXML.

Возвращает: java.lang.String — описание, связанное с этим строительным блоком.

getDocument()

public DocumentBase getDocument()

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

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

Возвращает: DocumentBase - Документ, которому принадлежит этот узел.

getFirstChild()

public Node getFirstChild()

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

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

getFirstSection()

public Section getFirstSection()

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

Возвращает: Section - Первая секция в строительном блоке.

getGallery()

public int getGallery()

Задает категоризацию первого уровня для стандартного блока в целях классификации или сортировки пользовательского интерфейса.

СоответствуетdocPartPr.category.gallery элемент в OOXML.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изBuildingBlockGallery константы.

getGuid()

public UUID getGuid()

Получает идентификатор (128-разрядный GUID), однозначно идентифицирующий этот стандартный блок.

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

СоответствуетdocPartPr.guid элемент в OOXML.

Возвращает: java.util.UUID — идентификатор (128-битный GUID), однозначно идентифицирующий этот строительный блок.

getLastChild()

public Node getLastChild()

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

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

getLastSection()

public Section getLastSection()

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

Возвращает: Section - Последний раздел в строительном блоке.

getName()

public String getName()

Получает имя этого стандартного блока.

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

Не может быть нулевым и не может быть пустой строкой.

СоответствуетdocPartPr.name элемент в OOXML.

Возвращает: java.lang.String — имя этого стандартного блока.

getNextMatchingNode(Node curNode)

public Node getNextMatchingNode(Node curNode)

Параметры:

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

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

getNextSibling()

public Node getNextSibling()

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

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

getNodeType()

public int getNodeType()

ВозвращаетNodeType.BUILDING_BLOCK ценность.

Возвращает: интервал -NodeType.BUILDING_BLOCK ценность. Возвращаемое значение является одним изNodeType константы.

getParentNode()

public CompositeNode getParentNode()

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

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

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

getPreviousSibling()

public Node getPreviousSibling()

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

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

getRange()

public Range getRange()

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

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

getSections()

public SectionCollection getSections()

Возвращает коллекцию, представляющую все разделы стандартного блока.

Возвращает: SectionCollection - Коллекция, представляющая все разделы в строительном блоке.

getText()

public String getText()

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

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

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

getType()

public int getType()

Задает тип стандартного блока.

Тип стандартного блока может влиять на видимость и поведение стандартного блока в Microsoft Word.

СоответствуетdocPartPr.types элемент в OOXML.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изBuildingBlockType константы.

hasChildNodes()

public boolean hasChildNodes()

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

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

hashCode()

public native int hashCode()

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

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, или нуль, если соответствующий узел не найден.

setBehavior(int value)

public void setBehavior(int value)

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изBuildingBlockBehavior константы.

setCategory(String value)

public void setCategory(String value)

Указывает категоризацию второго уровня для стандартного блока.

Не может быть нулевым и не может быть пустой строкой.

СоответствуетdocPartPr.category.name элемент в OOXML.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение java.lang.String.

setCustomNodeId(int value)

public void setCustomNodeId(int value)

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

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

Параметры:

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

setDescription(String value)

public void setDescription(String value)

Задает описание, связанное с этим стандартным блоком.

Описание может содержать любое строковое содержимое, обычно дополнительную информацию.

Не может быть null , но может быть пустой строкой.

СоответствуетdocPartPr.description элемент в OOXML.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Описание, связанное с этим стандартным блоком.

setGallery(int value)

public void setGallery(int value)

СоответствуетdocPartPr.category.gallery элемент в OOXML.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изBuildingBlockGallery константы.

setGuid(UUID value)

public void setGuid(UUID value)

Задает идентификатор (128-разрядный GUID), однозначно идентифицирующий этот стандартный блок.

СоответствуетdocPartPr.guid элемент в OOXML.

Параметры:

Параметр	Тип	Описание
value	java.util.UUID	Идентификатор (128-разрядный GUID), однозначно идентифицирующий этот стандартный блок.

setName(String value)

public void setName(String value)

Задает имя этого стандартного блока.

Не может быть нулевым и не может быть пустой строкой.

СоответствуетdocPartPr.name элемент в OOXML.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Имя этого строительного блока.

setType(int value)

public void setType(int value)

Задает тип стандартного блока.

Тип стандартного блока может влиять на видимость и поведение стандартного блока в Microsoft Word.

СоответствуетdocPartPr.types элемент в OOXML.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изBuildingBlockType константы.

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

BuildVersionInfo BuildingBlockBehavior