BuildingBlock

遗产： java.lang.Object, com.aspose.words.Node, com.aspose.words.CompositeNode

public class BuildingBlock extends CompositeNode

表示词汇表文档条目，例如 Building Block、AutoText 或 AutoCorrect 条目。

要了解更多信息，请访问**Aspose.Words Document Object Model (DOM)**文档文章。

BuildingBlock只能包含Section节点。

BuildingBlock只能是孩子GlossaryDocument.

您可以创建新的构建块并将它们插入到词汇表文档中。您可以修改或删除现有的构建基块。您可以在文档之间复制或移动构建块。您可以将构建块的内容插入到文档中。

对应于docPart, docPartPr和docPartBodyOOXML 中的元素。

构造器

构造函数	描述
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 - 如果所有节点都被访问，则为真；如果 DocumentVisitor 在访问所有节点之前停止操作，则返回 false。

来电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)

将指定节点添加到此节点的子节点列表的末尾。

如果 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 - 指定类型的祖先，如果未找到此类型的祖先，则为 null。

如果祖先类型等于 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.Class

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()

获取节点的第一个子节点。如果没有第一个子节点，则返回 null。

退货： Node - 节点的第一个孩子。

getFirstSection()

public Section getFirstSection()

获取构建块中的第一个部分。如果没有部分，则返回 null。

退货： Section - 积木中的第一部分。

getGallery()

public int getGallery()

为分类或用户界面排序指定构建基块的一级分类。

Microsoft Word 用户界面中的构建块被安排到画廊中。每个getGallery() / setGallery(int)可以有多个类别。一个内的每个块getCategory() / setCategory(java.lang.String)有个getName() / setName(java.lang.String).

对应于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()

获取节点的最后一个子节点。如果没有最后一个子节点，则返回 null。

退货： 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()

获取紧跟在该节点之后的节点。如果没有下一个节点，则返回 null。

退货： Node - 紧接此节点之后的节点。

getNodeType()

public int getNodeType()

返回NodeType.BUILDING_BLOCK价值。

退货： 诠释 - 的NodeType.BUILDING_BLOCK价值。返回值是其中之一NodeType常数。

getParentNode()

public CompositeNode getParentNode()

获取此节点的直接父级。

如果一个节点刚刚被创建并且还没有被添加到树中，或者如果它已经被从树中移除，则父节点为空。

退货： CompositeNode - 此节点的直接父节点。

getPreviousSibling()

public Node getPreviousSibling()

获取紧接在该节点之前的节点。如果前面没有节点，则返回 null。

退货： Node - 紧接在该节点之前的节点。

getRange()

public Range getRange()

返回一个Range表示包含在该节点中的文档部分的对象。

退货： Range - 一个Range表示包含在该节点中的文档部分的对象。

getSections()

public SectionCollection getSections()

返回代表构建块中所有部分的集合。

退货： SectionCollection 代表构建块中所有部分的集合。

getText()

public String getText()

获取此节点及其所有子节点的文本。

返回的字符串包括所有控制字符和特殊字符，如ControlChar.

退货： java.lang.字符串

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 已经在树中，则首先将其删除。

如果被插入的节点是从另一个文档创建的，你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。

参数：

范围	类型	描述
newChild	Node	要插入的节点。
refChild	Node	作为参考节点的节点。 newNode 放置在 refNode 之后。

退货： Node - 插入的节点。

insertBefore(Node newChild, Node refChild)

public Node insertBefore(Node newChild, Node refChild)

将指定节点插入到紧靠指定引用节点之前。

如果 refChild 为 null，则在子节点列表的末尾插入 newChild。

如果 newChild 已经在树中，则首先将其删除。

如果被插入的节点是从另一个文档创建的，你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。

参数：

范围	类型	描述
newChild	Node	要插入的节点。
refChild	Node	作为参考节点的节点。 newChild 放置在此节点之前。

退货： Node - 插入的节点。

isComposite()

public boolean isComposite()

返回 true，因为此节点可以有子节点。

退货： boolean - True 因为这个节点可以有子节点。

iterator()

public Iterator iterator()

为该节点的子节点上的每个样式迭代提供支持。

退货： java.util.迭代器

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

根据前序树遍历算法获取下一个节点。

参数：

范围	类型	描述
rootNode	Node	遍历的顶端节点（极限）。

退货： Node - 预定顺序中的下一个节点。如果到达根节点则为空。

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

参数：

范围	类型	描述
nodeType	int

退货： java.lang.字符串

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

prependChild(Node newChild)

public Node prependChild(Node newChild)

将指定节点添加到此节点的子节点列表的开头。

如果 newChild 已经在树中，则首先将其删除。

如果被插入的节点是从另一个文档创建的，你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。

参数：

范围	类型	描述
newChild	Node	要添加的节点。

退货： Node - 添加的节点。

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

根据前序树遍历算法获取上一个节点。

参数：

范围	类型	描述
rootNode	Node	遍历的顶端节点（极限）。

退货： Node 预购顺序中的前一个节点。如果到达根节点则为空。

remove()

public void remove()

从父级中移除自身。

removeAllChildren()

public void removeAllChildren()

移除当前节点的所有子节点。

removeChild(Node oldChild)

public Node removeChild(Node oldChild)

删除指定的子节点。

删除节点后，oldChild 的父级设置为 null。

参数：

范围	类型	描述
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 查询匹配的第一个节点，如果未找到匹配节点，则为 null。

setBehavior(int value)

public void setBehavior(int value)

指定将构建块的内容插入主文档时应应用的行为。

参数：

范围	类型	描述
value	int	对应的int值。该值必须是其中之一BuildingBlockBehavior常数。

setCategory(String value)

public void setCategory(String value)

指定构建基块的二级分类。

Microsoft Word 用户界面中的构建块被安排到画廊中。每个getGallery() / setGallery(int)可以有多个类别。一个内的每个块getCategory() / setCategory(java.lang.String)有个getName() / setName(java.lang.String).

不能为空且不能为空字符串。

对应于docPartPr.category.name OOXML 中的元素。

参数：

范围	类型	描述
value	java.lang.String	对应的java.lang.String值。

setCustomNodeId(int value)

public void setCustomNodeId(int value)

指定自定义节点标识符。

默认为零。

这个标识符可以任意设置和使用。例如，作为获取外部数据的密钥。

重要说明，指定的值不会保存到输出文件中，并且仅在节点生命周期内存在。

参数：

范围	类型	描述
value	int	对应的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)

为分类或用户界面排序指定构建基块的一级分类。

Microsoft Word 用户界面中的构建块被安排到画廊中。每个getGallery() / setGallery(int)可以有多个类别。一个内的每个块getCategory() / setCategory(java.lang.String)有个getName() / setName(java.lang.String).

对应于docPartPr.category.gallery OOXML 中的元素。

参数：

范围	类型	描述
value	int	对应的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	对应的int值。该值必须是其中之一BuildingBlockType常数。

toString()

public String toString()

退货： java.lang.字符串

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.字符串

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