Aspose::Words::BuildingBlocks::BuildingBlock Class Reference

Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry. More...

#include "Aspose.Words.Cpp/Model/BuildingBlocks/BuildingBlock.h"

Inherits Aspose::Words::CompositeNode.

Public Member Functions

virtual Aspose::Words::NodeType get_NodeType () const
 Returns the Aspose::Words::NodeType::BuildingBlock value. More...
 
System::SharedPtr< Aspose::Words::SectionCollectionget_Sections ()
 Returns a collection that represents all sections in the building block. More...
 
System::SharedPtr< Aspose::Words::Sectionget_FirstSection ()
 Gets the first section in the building block. More...
 
System::SharedPtr< Aspose::Words::Sectionget_LastSection ()
 Gets the last section in the building block. More...
 
System::String get_Name () const
 Gets or sets the name of this building block. More...
 
void set_Name (System::String value)
 Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Name. More...
 
System::Guid get_Guid () const
 Gets or sets an identifier (a 128-bit GUID) that uniquely identifies this building block. More...
 
void set_Guid (System::Guid value)
 Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Guid. More...
 
System::String get_Description () const
 Gets or sets the description associated with this building block. More...
 
void set_Description (System::String value)
 Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Description. More...
 
Aspose::Words::BuildingBlocks::BuildingBlockGallery get_Gallery () const
 Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting. More...
 
void set_Gallery (Aspose::Words::BuildingBlocks::BuildingBlockGallery value)
 Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery. More...
 
System::String get_Category () const
 Specifies the second-level categorization for the building block. More...
 
void set_Category (System::String value)
 Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Category. More...
 
Aspose::Words::BuildingBlocks::BuildingBlockBehavior get_Behavior () const
 Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document. More...
 
void set_Behavior (Aspose::Words::BuildingBlocks::BuildingBlockBehavior value)
 Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Behavior. More...
 
Aspose::Words::BuildingBlocks::BuildingBlockType get_Type () const
 Specifies the building block type. More...
 
void set_Type (Aspose::Words::BuildingBlocks::BuildingBlockType value)
 Setter for Aspose::Words::BuildingBlocks::BuildingBlock::get_Type. More...
 
 BuildingBlock (System::SharedPtr< Aspose::Words::BuildingBlocks::GlossaryDocument > glossaryDoc)
 Initializes a new instance of this class. More...
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)
 Accepts a visitor. More...
 
- Public Member Functions inherited from Aspose::Words::CompositeNode
virtual bool get_IsComposite ()
 Returns true as this node can have child nodes. More...
 
bool get_HasChildNodes ()
 Returns true if this node has any child nodes. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionget_ChildNodes ()
 Gets all immediate child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_FirstChild () const
 Gets the first child of the node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_LastChild () const
 Gets the last child of the node. More...
 
int32_t get_Count ()
 Gets the number of immediate children of this node. More...
 
System::SharedPtr< Aspose::Words::CompositeNodeget_Container ()
 
virtual System::String GetText ()
 Gets the text of this node and of all its children. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionGetChildNodes (Aspose::Words::NodeType nodeType, bool isDeep)
 Returns a live collection of child nodes that match the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeGetChild (Aspose::Words::NodeType nodeType, int32_t index, bool isDeep)
 Returns an Nth child node that matches the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeListSelectNodes (System::String xpath)
 Selects a list of nodes matching the XPath expression. More...
 
System::SharedPtr< Aspose::Words::NodeSelectSingleNode (System::String xpath)
 Selects the first Node that matches the XPath expression. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Node > > > GetEnumerator ()
 Provides support for the for each style iteration over the child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::NodeAppendChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the end of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodePrependChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertAfter (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertBefore (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeRemoveChild (System::SharedPtr< Aspose::Words::Node > oldChild)
 Removes the specified child node. More...
 
void RemoveAllChildren ()
 Removes all the child nodes of the current node. More...
 
void RemoveSmartTags ()
 Removes all Aspose::Words::Markup::SmartTag descendant nodes of the current node. More...
 
int32_t IndexOf (System::SharedPtr< Aspose::Words::Node > child)
 Returns the index of the specified child node in the child node array. More...
 
System::SharedPtr< Aspose::Words::NodeGetNextMatchingNode (System::SharedPtr< Aspose::Words::Node > &curNode)
 
- Public Member Functions inherited from Aspose::Words::Node
System::SharedPtr< Aspose::Words::CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
 
virtual System::SharedPtr< Aspose::Words::DocumentBaseget_Document ()
 Gets the document to which this node belongs. More...
 
System::SharedPtr< Aspose::Words::Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
 
System::SharedPtr< Aspose::Words::Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
 
System::SharedPtr< Aspose::Words::NodeClone (bool isCloneChildren)
 
template<typename T >
GetAncestorOf ()
 
System::SharedPtr< Aspose::Words::CompositeNodeGetAncestor (Aspose::Words::NodeType ancestorType)
 Gets the first ancestor of the specified Aspose::Words::NodeType. More...
 
void Remove ()
 Removes itself from the parent. More...
 
System::SharedPtr< Aspose::Words::NodeNextPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
 
System::SharedPtr< Aspose::Words::NodePreviousPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
 
System::String ToString (Aspose::Words::SaveFormat saveFormat)
 Exports the content of the node into a string in the specified format. More...
 
System::String ToString (System::SharedPtr< Aspose::Words::Saving::SaveOptions > saveOptions)
 Exports the content of the node into a string using the specified save options. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Node > > IEnumeratorType
 Enumerator type. More...
 
- Static Public Member Functions inherited from Aspose::Words::Node
static System::String NodeTypeToString (Aspose::Words::NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 

Detailed Description

Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry.

Aspose::Words::BuildingBlocks::BuildingBlock can contain only Aspose::Words::Section nodes.

Aspose::Words::BuildingBlocks::BuildingBlock can only be a child of Aspose::Words::BuildingBlocks::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
Aspose::Words::BuildingBlocks::GlossaryDocument

Constructor & Destructor Documentation

◆ BuildingBlock()

Aspose::Words::BuildingBlocks::BuildingBlock::BuildingBlock ( System::SharedPtr< Aspose::Words::BuildingBlocks::GlossaryDocument glossaryDoc)

Initializes a new instance of this class.

When Aspose::Words::BuildingBlocks::BuildingBlock is created, it belongs to the specified glossary document, but is not yet part of the glossary document and Aspose::Words::Node::get_ParentNode is null.

To append Aspose::Words::BuildingBlocks::BuildingBlock to a Aspose::Words::BuildingBlocks::GlossaryDocument use Aspose::Words::CompositeNode::AppendChild(System::SharedPtr<Aspose::Words::Node>).

Parameters
glossaryDocThe owner document.

Member Function Documentation

◆ Accept()

virtual bool Aspose::Words::BuildingBlocks::BuildingBlock::Accept ( System::SharedPtr< Aspose::Words::DocumentVisitor visitor)
virtual

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Parameters
visitorThe visitor that will visit the nodes.
Returns
True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Calls Aspose::Words::DocumentVisitor::VisitBuildingBlockStart(System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlock>), then calls Aspose::Words::Node::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) for all child nodes of this building block, then calls Aspose::Words::DocumentVisitor::VisitBuildingBlockEnd(System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlock>).

Note: A building block node and its children are not visited when you execute a Visitor over a Aspose::Words::Document. If you want to execute a Visitor over a building block, you need to execute the visitor over Aspose::Words::BuildingBlocks::GlossaryDocument or call Aspose::Words::BuildingBlocks::BuildingBlock::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>).

Implements Aspose::Words::Node.

◆ get_Behavior()

Aspose::Words::BuildingBlocks::BuildingBlockBehavior Aspose::Words::BuildingBlocks::BuildingBlock::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()

System::String Aspose::Words::BuildingBlocks::BuildingBlock::get_Category ( ) const

Specifies the second-level categorization for the building block.

Building blocks in Microsoft Word user interface are arranged into Galleries. Each Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery can have multiple Categories. Each block within a Aspose::Words::BuildingBlocks::BuildingBlock::get_Category has a Aspose::Words::BuildingBlocks::BuildingBlock::get_Name.

Cannot be null and cannot be an empty string.

Corresponds to the docPartPr.category.name element in OOXML.

See also
Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery, Aspose::Words::BuildingBlocks::BuildingBlock::get_Name

◆ get_Description()

System::String Aspose::Words::BuildingBlocks::BuildingBlock::get_Description ( ) const

Gets or sets the description associated with this building block.

The description may contain any string content, usually additional information.

Cannot be null, but can be an empty string.

Corresponds to the docPartPr.description element in OOXML.

◆ get_FirstSection()

System::SharedPtr<Aspose::Words::Section> Aspose::Words::BuildingBlocks::BuildingBlock::get_FirstSection ( )

Gets the first section in the building block.

Returns null if there are no sections.

◆ get_Gallery()

Aspose::Words::BuildingBlocks::BuildingBlockGallery Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery ( ) const

Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting.

Building blocks in Microsoft Word user interface are arranged into Galleries. Each Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery can have multiple Categories. Each block within a Aspose::Words::BuildingBlocks::BuildingBlock::get_Category has a Aspose::Words::BuildingBlocks::BuildingBlock::get_Name.

Corresponds to the docPartPr.category.gallery element in OOXML.

See also
Aspose::Words::BuildingBlocks::BuildingBlock::get_Category, Aspose::Words::BuildingBlocks::BuildingBlock::get_Name

◆ get_Guid()

System::Guid Aspose::Words::BuildingBlocks::BuildingBlock::get_Guid ( ) const

Gets or sets an identifier (a 128-bit GUID) that uniquely identifies this building block.

Can be used by an application to uniquely reference a building block regardless of different naming due to localization.

Corresponds to the docPartPr.guid element in OOXML.

◆ get_LastSection()

System::SharedPtr<Aspose::Words::Section> Aspose::Words::BuildingBlocks::BuildingBlock::get_LastSection ( )

Gets the last section in the building block.

Returns null if there are no sections.

◆ get_Name()

System::String Aspose::Words::BuildingBlocks::BuildingBlock::get_Name ( ) const

Gets or sets the name of this building block.

The name may contain any string content, usually a friendly identifier. Multiple building blocks can have the same name.

Cannot be null and cannot be an empty string.

Corresponds to the docPartPr.name element in OOXML.

See also
Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery, Aspose::Words::BuildingBlocks::BuildingBlock::get_Category

◆ get_NodeType()

virtual Aspose::Words::NodeType Aspose::Words::BuildingBlocks::BuildingBlock::get_NodeType ( ) const
virtual

◆ get_Sections()

System::SharedPtr<Aspose::Words::SectionCollection> Aspose::Words::BuildingBlocks::BuildingBlock::get_Sections ( )

Returns a collection that represents all sections in the building block.

◆ get_Type()

Aspose::Words::BuildingBlocks::BuildingBlockType Aspose::Words::BuildingBlocks::BuildingBlock::get_Type ( ) const

Specifies the building block type.

The building block type can influence the visibility and behavior of the building block in Microsoft Word.

Corresponds to the docPartPr.types element in OOXML.

◆ set_Behavior()

void Aspose::Words::BuildingBlocks::BuildingBlock::set_Behavior ( Aspose::Words::BuildingBlocks::BuildingBlockBehavior  value)

◆ set_Category()

void Aspose::Words::BuildingBlocks::BuildingBlock::set_Category ( System::String  value)

◆ set_Description()

void Aspose::Words::BuildingBlocks::BuildingBlock::set_Description ( System::String  value)

◆ set_Gallery()

void Aspose::Words::BuildingBlocks::BuildingBlock::set_Gallery ( Aspose::Words::BuildingBlocks::BuildingBlockGallery  value)

◆ set_Guid()

void Aspose::Words::BuildingBlocks::BuildingBlock::set_Guid ( System::Guid  value)

◆ set_Name()

void Aspose::Words::BuildingBlocks::BuildingBlock::set_Name ( System::String  value)

◆ set_Type()

void Aspose::Words::BuildingBlocks::BuildingBlock::set_Type ( Aspose::Words::BuildingBlocks::BuildingBlockType  value)