Aspose::Words::Math::OfficeMath Class Reference

Represents an Office Math object such as function, equation, matrix or alike. Can contain child elements including runs of mathematical text, bookmarks, comments, other Aspose::Words::Math::OfficeMath instances and some other nodes. More...

#include "Aspose.Words.Cpp/Model/Math/OfficeMath.h"

Inherits Aspose::Words::CompositeNode, IInline, and ITrackableNode.

Public Member Functions

virtual Aspose::Words::NodeType get_NodeType () const
 Returns NodeType.OfficeMath. More...
 
System::SharedPtr< Aspose::Words::Paragraphget_ParentParagraph ()
 Retrieves the parent Aspose::Words::Paragraph of this node. More...
 
System::SharedPtr< Aspose::Words::Paragraphget_ParentParagraph_IInline ()
 
System::SharedPtr< Aspose::Words::DocumentBaseget_Document_IInline ()
 
System::SharedPtr< Aspose::Words::RunPr > get_RunPr_IInline ()
 
void set_RunPr_IInline (System::SharedPtr< Aspose::Words::RunPr > value)
 
Aspose::Words::Math::MathObjectType get_MathObjectType ()
 Gets type Aspose::Words::Math::OfficeMath::get_MathObjectType of this Office Math object. More...
 
System::SharedPtr< System::Text::Encodingget_EquationXmlEncoding () const
 Gets/sets an encoding that was used to encode equation XML, if this office math object is read from equation XML. We use the encoding on saving a document to write in same encoding that it was read. More...
 
void set_EquationXmlEncoding (System::SharedPtr< System::Text::Encoding > value)
 Setter for Aspose::Words::Math::OfficeMath::get_EquationXmlEncoding. More...
 
Aspose::Words::Math::OfficeMathJustification get_Justification ()
 Gets/sets Office Math justification. More...
 
void set_Justification (Aspose::Words::Math::OfficeMathJustification value)
 Setter for Aspose::Words::Math::OfficeMath::get_Justification. More...
 
Aspose::Words::Math::OfficeMathDisplayType get_DisplayType ()
 Gets/sets Office Math display format type which represents whether an equation is displayed inline with the text or displayed on its own line. More...
 
void set_DisplayType (Aspose::Words::Math::OfficeMathDisplayType value)
 Setter for Aspose::Words::Math::OfficeMath::get_DisplayType. More...
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_InsertRevision ()
 
void set_InsertRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_DeleteRevision ()
 
void set_DeleteRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveFromRevision ()
 
void set_MoveFromRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveToRevision ()
 
void set_MoveToRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)
 Accepts a visitor. More...
 
System::SharedPtr< Aspose::Words::Rendering::OfficeMathRendererGetMathRenderer ()
 Creates and returns an object that can be used to render this equation into an image. More...
 
virtual System::String ToString () const
 
System::SharedPtr< System::ObjectGetDirectRunAttr (int32_t fontAttr)
 
System::SharedPtr< System::ObjectFetchInheritedRunAttr (int32_t fontAttr)
 
void SetRunAttr (int32_t fontAttr, System::SharedPtr< System::Object > value)
 
void RemoveRunAttr (int32_t key)
 
void ClearRunAttrs ()
 
System::SharedPtr< Aspose::Words::RunPr > GetExpandedRunPr_IInline (Aspose::Words::RunPrExpandFlags flags)
 
- 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 an Office Math object such as function, equation, matrix or alike. Can contain child elements including runs of mathematical text, bookmarks, comments, other Aspose::Words::Math::OfficeMath instances and some other nodes.

In this version of Aspose.Words, Aspose::Words::Math::OfficeMath nodes do not provide public methods and properties to create or modify a OfficeMath object. In this version you are not able to instantiate Aspose::Words::Math nodes or modify existing except deleting them.

Aspose::Words::Math::OfficeMath can only be a child of Aspose::Words::Paragraph.

Member Function Documentation

◆ Accept()

virtual bool Aspose::Words::Math::OfficeMath::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::VisitOfficeMathStart(System::SharedPtr<Aspose::Words::Math::OfficeMath>), then calls Aspose::Words::Node::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) for all child nodes of the Office Math and calls Aspose::Words::DocumentVisitor::VisitOfficeMathEnd(System::SharedPtr<Aspose::Words::Math::OfficeMath>) at the end.

Implements Aspose::Words::Node.

◆ ClearRunAttrs()

void Aspose::Words::Math::OfficeMath::ClearRunAttrs ( )

◆ FetchInheritedRunAttr()

System::SharedPtr<System::Object> Aspose::Words::Math::OfficeMath::FetchInheritedRunAttr ( int32_t  fontAttr)

◆ get_DeleteRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Math::OfficeMath::get_DeleteRevision ( )

◆ get_DisplayType()

Aspose::Words::Math::OfficeMathDisplayType Aspose::Words::Math::OfficeMath::get_DisplayType ( )

Gets/sets Office Math display format type which represents whether an equation is displayed inline with the text or displayed on its own line.

Display format type has effect for top level Office Math only.

Returned display format type is always Aspose::Words::Math::OfficeMathDisplayType::Inline for nested Office Math.

◆ get_Document_IInline()

System::SharedPtr<Aspose::Words::DocumentBase> Aspose::Words::Math::OfficeMath::get_Document_IInline ( )

◆ get_EquationXmlEncoding()

System::SharedPtr<System::Text::Encoding> Aspose::Words::Math::OfficeMath::get_EquationXmlEncoding ( ) const

Gets/sets an encoding that was used to encode equation XML, if this office math object is read from equation XML. We use the encoding on saving a document to write in same encoding that it was read.

◆ get_InsertRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Math::OfficeMath::get_InsertRevision ( )

◆ get_Justification()

Aspose::Words::Math::OfficeMathJustification Aspose::Words::Math::OfficeMath::get_Justification ( )

Gets/sets Office Math justification.

Justification cannot be set to the Office Math with display format type Aspose::Words::Math::OfficeMathDisplayType::Inline.

Inline justification cannot be set to the Office Math with display format type Aspose::Words::Math::OfficeMathDisplayType::Display.

Corresponding Aspose::Words::Math::OfficeMath::get_DisplayType has to be set before setting Office Math justification.

◆ get_MathObjectType()

Aspose::Words::Math::MathObjectType Aspose::Words::Math::OfficeMath::get_MathObjectType ( )

◆ get_MoveFromRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Math::OfficeMath::get_MoveFromRevision ( )

◆ get_MoveToRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Math::OfficeMath::get_MoveToRevision ( )

◆ get_NodeType()

virtual Aspose::Words::NodeType Aspose::Words::Math::OfficeMath::get_NodeType ( ) const
virtual

◆ get_ParentParagraph()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::Math::OfficeMath::get_ParentParagraph ( )

Retrieves the parent Aspose::Words::Paragraph of this node.

◆ get_ParentParagraph_IInline()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::Math::OfficeMath::get_ParentParagraph_IInline ( )

◆ get_RunPr_IInline()

System::SharedPtr<Aspose::Words::RunPr> Aspose::Words::Math::OfficeMath::get_RunPr_IInline ( )

◆ GetDirectRunAttr()

System::SharedPtr<System::Object> Aspose::Words::Math::OfficeMath::GetDirectRunAttr ( int32_t  fontAttr)

◆ GetExpandedRunPr_IInline()

System::SharedPtr<Aspose::Words::RunPr> Aspose::Words::Math::OfficeMath::GetExpandedRunPr_IInline ( Aspose::Words::RunPrExpandFlags  flags)

◆ GetMathRenderer()

System::SharedPtr<Aspose::Words::Rendering::OfficeMathRenderer> Aspose::Words::Math::OfficeMath::GetMathRenderer ( )

Creates and returns an object that can be used to render this equation into an image.

This method just invokes the Aspose::Words::Rendering::OfficeMathRenderer constructor and passes this object as a parameter.

Returns
The renderer object for this equation.

◆ RemoveRunAttr()

void Aspose::Words::Math::OfficeMath::RemoveRunAttr ( int32_t  key)

◆ set_DeleteRevision()

void Aspose::Words::Math::OfficeMath::set_DeleteRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_DisplayType()

void Aspose::Words::Math::OfficeMath::set_DisplayType ( Aspose::Words::Math::OfficeMathDisplayType  value)

◆ set_EquationXmlEncoding()

void Aspose::Words::Math::OfficeMath::set_EquationXmlEncoding ( System::SharedPtr< System::Text::Encoding value)

◆ set_InsertRevision()

void Aspose::Words::Math::OfficeMath::set_InsertRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_Justification()

void Aspose::Words::Math::OfficeMath::set_Justification ( Aspose::Words::Math::OfficeMathJustification  value)

◆ set_MoveFromRevision()

void Aspose::Words::Math::OfficeMath::set_MoveFromRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ set_MoveToRevision()

void Aspose::Words::Math::OfficeMath::set_MoveToRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ set_RunPr_IInline()

void Aspose::Words::Math::OfficeMath::set_RunPr_IInline ( System::SharedPtr< Aspose::Words::RunPr >  value)

◆ SetRunAttr()

void Aspose::Words::Math::OfficeMath::SetRunAttr ( int32_t  fontAttr,
System::SharedPtr< System::Object value 
)

◆ ToString()

virtual System::String Aspose::Words::Math::OfficeMath::ToString ( ) const
virtual