Aspose::Words::BuildingBlocks::GlossaryDocument Class Reference

Represents the root element for a glossary document within a Word document. A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks. More...

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

Inherits Aspose::Words::DocumentBase.

Public Member Functions

virtual Aspose::Words::NodeType get_NodeType () const
 Returns the Aspose::Words::NodeType::GlossaryDocument value. More...
 
System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlockCollectionget_BuildingBlocks ()
 Returns a typed collection that represents all building blocks in the glossary document. More...
 
System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlockget_FirstBuildingBlock ()
 Gets the first building block in the glossary document. More...
 
System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlockget_LastBuildingBlock ()
 Gets the last building block in the glossary document. More...
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)
 Accepts a visitor. More...
 
System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlockGetBuildingBlock (Aspose::Words::BuildingBlocks::BuildingBlockGallery gallery, System::String category, System::String name)
 Finds a building block using the specified gallery, category and name. More...
 
- Public Member Functions inherited from Aspose::Words::DocumentBase
virtual System::SharedPtr< Aspose::Words::DocumentBaseget_Document ()
 Gets the document to which this node belongs. More...
 
System::SharedPtr< Aspose::Words::INodeChangingCallback > get_NodeChangingCallback ()
 Called when a node is inserted or removed in the document. More...
 
void set_NodeChangingCallback (System::SharedPtr< Aspose::Words::INodeChangingCallback > value)
 Setter for Aspose::Words::DocumentBase::get_NodeChangingCallback. More...
 
System::SharedPtr< Aspose::Words::Loading::IResourceLoadingCallback > get_ResourceLoadingCallback () const
 Allows to control how external resources are loaded. More...
 
void set_ResourceLoadingCallback (System::SharedPtr< Aspose::Words::Loading::IResourceLoadingCallback > value)
 Setter for Aspose::Words::DocumentBase::get_ResourceLoadingCallback. More...
 
System::SharedPtr< Aspose::Words::Fonts::FontInfoCollectionget_FontInfos () const
 Provides access to properties of fonts used in this document. More...
 
System::SharedPtr< Aspose::Words::StyleCollectionget_Styles () const
 Returns a collection of styles defined in the document. More...
 
System::SharedPtr< Aspose::Words::Lists::ListCollectionget_Lists () const
 Provides access to the list formatting used in the document. More...
 
System::SharedPtr< Aspose::Words::IWarningCallback > get_WarningCallback () const
 Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss. More...
 
void set_WarningCallback (System::SharedPtr< Aspose::Words::IWarningCallback > value)
 Setter for Aspose::Words::DocumentBase::get_WarningCallback. More...
 
System::SharedPtr< Aspose::Words::Drawing::Shapeget_BackgroundShape () const
 Gets or sets the background shape of the document. Can be null. More...
 
void set_BackgroundShape (System::SharedPtr< Aspose::Words::Drawing::Shape > value)
 Setter for Aspose::Words::DocumentBase::get_BackgroundShape. More...
 
System::Drawing::Color get_PageColor ()
 Gets or sets the page color of the document. This property is a simpler version of Aspose::Words::DocumentBase::get_BackgroundShape. More...
 
void set_PageColor (System::Drawing::Color value)
 Setter for Aspose::Words::DocumentBase::get_PageColor. More...
 
System::SharedPtr< Aspose::Words::NodeImportNode (System::SharedPtr< Aspose::Words::Node > srcNode, bool isImportChildren)
 
System::SharedPtr< Aspose::Words::NodeImportNode (System::SharedPtr< Aspose::Words::Node > srcNode, bool isImportChildren, Aspose::Words::ImportFormatMode importFormatMode)
 
- 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 ~CompositeNode ()
 
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...
 
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...
 

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)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Represents the root element for a glossary document within a Word document. A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks.

Some documents, usually templates, can contain AutoText, AutoCorrect entries and/or Building Blocks (also known as glossary document entries, document parts or building blocks).

To access building blocks, you need to load a document into a Aspose::Words::Document object. Building blocks will be available via the Aspose::Words::Document::get_GlossaryDocument property.

Aspose::Words::BuildingBlocks::GlossaryDocument can contain any number of Aspose::Words::BuildingBlocks::BuildingBlock objects. Each Aspose::Words::BuildingBlocks::BuildingBlock represents one document part.

Corresponds to the glossaryDocument and docParts elements in OOXML.

See also
Aspose::Words::Document, Aspose::Words::Document::get_GlossaryDocument, Aspose::Words::BuildingBlocks::BuildingBlock

Member Function Documentation

◆ Accept()

virtual bool Aspose::Words::BuildingBlocks::GlossaryDocument::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::VisitGlossaryDocumentStart(System::SharedPtr<Aspose::Words::BuildingBlocks::GlossaryDocument>), then calls Aspose::Words::Node::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) for all child nodes of this node and then calls Aspose::Words::DocumentVisitor::VisitGlossaryDocumentEnd(System::SharedPtr<Aspose::Words::BuildingBlocks::GlossaryDocument>) at the end.

Note: A glossary document 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 glossary document, you need to call Aspose::Words::BuildingBlocks::GlossaryDocument::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>).

Implements Aspose::Words::Node.

◆ get_BuildingBlocks()

System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlockCollection> Aspose::Words::BuildingBlocks::GlossaryDocument::get_BuildingBlocks ( )

Returns a typed collection that represents all building blocks in the glossary document.

◆ get_FirstBuildingBlock()

System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlock> Aspose::Words::BuildingBlocks::GlossaryDocument::get_FirstBuildingBlock ( )

Gets the first building block in the glossary document.

Returns null if there are no building blocks available.

◆ get_LastBuildingBlock()

System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlock> Aspose::Words::BuildingBlocks::GlossaryDocument::get_LastBuildingBlock ( )

Gets the last building block in the glossary document.

Returns null if there are no building blocks available.

◆ get_NodeType()

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

◆ GetBuildingBlock()

System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlock> Aspose::Words::BuildingBlocks::GlossaryDocument::GetBuildingBlock ( Aspose::Words::BuildingBlocks::BuildingBlockGallery  gallery,
System::String  category,
System::String  name 
)

Finds a building block using the specified gallery, category and name.

This is a convenience method that iterates over all building blocks in this collection and returns the first building block that matches the specified gallery, category and name.

Microsoft Word organizes building blocks into galleries. The galleries are predefined using the Aspose::Words::BuildingBlocks::BuildingBlockGallery enum. Within each gallery, building blocks can be organized into one or more categories. The category name is a string. Each building block has a name. A building block name is not guaranteed to be unique.

Parameters
galleryThe gallery criteria.
categoryThe category criteria. Can be null, in which case it will not be used for comparison.
nameThe building block name criteria.
Returns
The matching building block or null if a match was not found.