Aspose::Words::BuildingBlocks::BuildingBlock class
Contents
[
Hide
]BuildingBlock class
Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry. To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.
class BuildingBlock : public Aspose::Words::CompositeNode
Methods
| Method | Description |
|---|---|
| Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override | Accepts a visitor. |
| AcceptEnd(System::SharedPtr<Aspose::Words::DocumentVisitor>) override | Accepts a visitor for visiting the end of the BuildingBlock. |
| AcceptStart(System::SharedPtr<Aspose::Words::DocumentVisitor>) override | Accepts a visitor for visiting the start of the BuildingBlock. |
| AppendChild(T) | |
| BuildingBlock(const System::SharedPtr<Aspose::Words::BuildingBlocks::GlossaryDocument>&) | Initializes a new instance of this class. |
| Clone(bool) | Creates a duplicate of the node. |
| get_Behavior() const | Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document. |
| get_Category() const | Specifies the second-level categorization for the building block. |
| get_Count() | Gets the number of immediate children of this node. |
| get_CustomNodeId() const | Specifies custom node identifier. |
| get_Description() const | Gets or sets the description associated with this building block. |
| virtual get_Document() const | Gets the document to which this node belongs. |
| get_FirstChild() const | Gets the first child of the node. |
| get_FirstSection() | Gets the first section in the building block. |
| get_Gallery() const | Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting. |
| get_Guid() const | Gets or sets an identifier (a 128-bit GUID) that uniquely identifies this building block. |
| get_HasChildNodes() | Returns true if this node has any child nodes. |
| get_IsComposite() override | Returns true as this node can have child nodes. |
| get_LastChild() const | Gets the last child of the node. |
| get_LastSection() | Gets the last section in the building block. |
| get_Name() const | Gets or sets the name of this building block. |
| get_NextNode() const | |
| get_NextSibling() | Gets the node immediately following this node. |
| get_NodeType() const override | Returns the BuildingBlock value. |
| get_ParentNode() | Gets the immediate parent of this node. |
| get_PreviousSibling() | Gets the node immediately preceding this node. |
| get_PrevNode() const | |
| get_Range() | Returns a Range object that represents the portion of a document that is contained in this node. |
| get_Sections() | Returns a collection that represents all sections in the building block. |
| get_Type() const | Specifies the building block type. |
| GetAncestor(Aspose::Words::NodeType) | Gets the first ancestor of the specified NodeType. |
| GetAncestorOf() | |
| GetChild(Aspose::Words::NodeType, int32_t, bool) | Returns an Nth child node that matches the specified type. |
| GetChildNodes(Aspose::Words::NodeType, bool) | Returns a live collection of child nodes that match the specified type. |
| GetEnumerator() override | Provides support for the for each style iteration over the child nodes of this node. |
| GetText() override | Gets the text of this node and of all its children. |
| GetType() const override | |
| IndexOf(const System::SharedPtr<Aspose::Words::Node>&) | Returns the index of the specified child node in the child node array. |
| InsertAfter(T, const System::SharedPtr<Aspose::Words::Node>&) | |
| InsertBefore(T, const System::SharedPtr<Aspose::Words::Node>&) | |
| Is(const System::TypeInfo&) const override | |
| IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&) | |
| NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&) | Gets next node according to the pre-order tree traversal algorithm. |
| static NodeTypeToString(Aspose::Words::NodeType) | A utility method that converts a node type enum value into a user friendly string. |
| PrependChild(T) | |
| PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&) | Gets the previous node according to the pre-order tree traversal algorithm. |
| Remove() | Removes itself from the parent. |
| RemoveAllChildren() | Removes all the child nodes of the current node. |
| RemoveChild(T) | |
| RemoveSmartTags() | Removes all SmartTag descendant nodes of the current node. |
| SelectNodes(const System::String&) | Selects a list of nodes matching the XPath expression. |
| SelectSingleNode(const System::String&) | Selects the first Node that matches the XPath expression. |
| set_Behavior(Aspose::Words::BuildingBlocks::BuildingBlockBehavior) | Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document. |
| set_Category(const System::String&) | Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Category. |
| set_CustomNodeId(int32_t) | Setter for Aspose::Words::Node::get_CustomNodeId. |
| set_Description(const System::String&) | Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Description. |
| set_Gallery(Aspose::Words::BuildingBlocks::BuildingBlockGallery) | Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery. |
| set_Guid(System::Guid) | Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Guid. |
| set_Name(const System::String&) | Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Name. |
| set_NextNode(const System::SharedPtr<Aspose::Words::Node>&) | |
| set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&) | |
| set_Type(Aspose::Words::BuildingBlocks::BuildingBlockType) | Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Type. |
| SetParent(const System::SharedPtr<Aspose::Words::Node>&) | |
| SetTemplateWeakPtr(uint32_t) override | |
| ToString(Aspose::Words::SaveFormat) | Exports the content of the node into a string in the specified format. |
| ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&) | Exports the content of the node into a string using the specified save options. |
| static Type() |
Remarks
BuildingBlock can contain only Section nodes.
BuildingBlock can only be a child of GlossaryDocument.
You can create new building blocks and insert them into a glossary document. You can modify or delete existing building blocks. You can copy or move building blocks between documents. You can insert content of a building block into a document.
Corresponds to the docPart, docPartPr and docPartBody elements in OOXML.
See Also
- Class CompositeNode
- Namespace Aspose::Words::BuildingBlocks
- Library Aspose.Words for C++