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

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 OfficeMath instances and some other nodes.

In this version of Aspose.Words, 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 Math nodes or modify existing except deleting them.

OfficeMath can only be a child of Paragraph.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
auto officeMath = System::DynamicCast<Aspose::Words::Math::OfficeMath>(doc->GetChild(Aspose::Words::NodeType::OfficeMath, 0, true));
// OfficeMath nodes that are children of other OfficeMath nodes are always inline
// The node we are working with is a base node, so its location and display type can be changed
ASSERT_EQ(Aspose::Words::Math::MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(Aspose::Words::NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
// Used by OOXML and WML formats
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
// We can change the location and display type of the OfficeMath node
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

#include <Aspose.Words.Cpp/Model/Math/OfficeMath.h>

+ Inheritance diagram for Aspose::Words::Math::OfficeMath:

Public Member Functions

bool Accept (SharedPtr< DocumentVisitor > visitor) override
 Accepts a visitor. More...
 
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...
 
SharedPtr< 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...
 
OfficeMathJustification get_Justification ()
 Gets/sets Office Math justification. More...
 
MathObjectType get_MathObjectType () const
 Gets type MathObjectType of this Office Math object. More...
 
NodeType get_NodeType () const override
 Returns NodeType.OfficeMath. More...
 
SharedPtr< Paragraphget_ParentParagraph ()
 Retrieves the parent Paragraph of this node. More...
 
SharedPtr< OfficeMathRendererGetMathRenderer ()
 Creates and returns an object that can be used to render this equation into an image. More...
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
void set_DisplayType (OfficeMathDisplayType value)
 Setter for get_DisplayType. More...
 
void set_EquationXmlEncoding (SharedPtr< Encoding > value)
 Setter for get_EquationXmlEncoding. More...
 
void set_Justification (OfficeMathJustification value)
 Setter for get_Justification. More...
 
- Public Member Functions inherited from CompositeNode
SharedPtr< NodeAppendChild (SharedPtr< Node > newChild)
 Adds the specified node to the end of the list of child nodes for this node. More...
 
SharedPtr< NodeCollectionget_ChildNodes ()
 Gets all immediate child nodes of this node. More...
 
SharedPtr< CompositeNodeget_Container () override
 
int32_t get_Count ()
 Gets the number of immediate children of this node. More...
 
SharedPtr< Nodeget_FirstChild () const
 Gets the first child of the node. More...
 
bool get_HasChildNodes ()
 Returns true if this node has any child nodes. More...
 
bool get_IsComposite () override
 Returns true as this node can have child nodes. More...
 
SharedPtr< Nodeget_LastChild () const
 Gets the last child of the node. More...
 
SharedPtr< NodeGetChild (NodeType nodeType, int32_t index, bool isDeep)
 Returns an Nth child node that matches the specified type. More...
 
SharedPtr< NodeCollectionGetChildNodes (NodeType nodeType, bool isDeep)
 Returns a live collection of child nodes that match the specified type. More...
 
SharedPtr< NodeGetCurrentNode () override
 
SharedPtr< IEnumerator< SharedPtr< Node > > > GetEnumerator () override
 Provides support for the for each style iteration over the child nodes of this node. More...
 
SharedPtr< NodeGetNextMatchingNode (SharedPtr< Node > curNode) override
 
String GetText () override
 Gets the text of this node and of all its children. More...
 
int32_t IndexOf (SharedPtr< Node > child)
 Returns the index of the specified child node in the child node array. More...
 
SharedPtr< NodeInsertAfter (SharedPtr< Node > newChild, SharedPtr< Node > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
SharedPtr< NodeInsertBefore (SharedPtr< Node > newChild, SharedPtr< Node > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
SharedPtr< NodePrependChild (SharedPtr< Node > newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
void RemoveAllChildren ()
 Removes all the child nodes of the current node. More...
 
SharedPtr< NodeRemoveChild (SharedPtr< Node > oldChild)
 Removes the specified child node. More...
 
void RemoveSmartTags ()
 Removes all SmartTag descendant nodes of the current node. More...
 
SharedPtr< NodeListSelectNodes (String xpath)
 Selects a list of nodes matching the XPath expression. More...
 
SharedPtr< NodeSelectSingleNode (String xpath)
 Selects the first Node that matches the XPath expression. More...
 
- Public Member Functions inherited from Node
SharedPtr< NodeClone (bool isCloneChildren)
 Creates a duplicate of the node. More...
 
virtual SharedPtr< DocumentBaseget_Document () const
 Gets the document to which this node belongs. More...
 
SharedPtr< Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
 
SharedPtr< CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
 
SharedPtr< Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
 
SharedPtr< Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
 
SharedPtr< CompositeNodeGetAncestor (NodeType ancestorType)
 Gets the first ancestor of the specified NodeType. More...
 
template<typename T >
GetAncestorOf ()
 
SharedPtr< NodeNextPreOrder (SharedPtr< Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
 
SharedPtr< NodePreviousPreOrder (SharedPtr< Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
 
void Remove ()
 Removes itself from the parent. More...
 
String ToString (SaveFormat saveFormat)
 Exports the content of the node into a string in the specified format. More...
 
String ToString (SharedPtr< SaveOptions > saveOptions)
 Exports the content of the node into a string using the specified save options. More...
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
EnumeratorBasedIterator< T, IEnumerator< T > > begin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cbegin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cend () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > end () noexcept
 
bool LINQ_All (std::function< bool(T)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(T)> predicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
bool LINQ_Contains (T value)
 
int LINQ_Count ()
 
int LINQ_Count (const Func< T, bool > &predicate)
 
LINQ_ElementAt (int index)
 
LINQ_First ()
 
LINQ_First (const Func< T, bool > &predicate)
 
LINQ_FirstOrDefault ()
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 
LINQ_Last ()
 
LINQ_LastOrDefault ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 
ArrayPtr< T > LINQ_ToArray ()
 
SharedPtr< List< T > > LINQ_ToList ()
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 

Static Public Member Functions

static const TypeInfoType ()
 
- Static Public Member Functions inherited from CompositeNode
static const TypeInfoType ()
 
- Static Public Member Functions inherited from Node
static String NodeTypeToString (NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
 
static const TypeInfoType ()
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
typedef IEnumerator< T > IEnumeratorType
 
typedef T ValueType
 

Member Function Documentation

◆ Accept()

bool Aspose::Words::Math::OfficeMath::Accept ( System::SharedPtr< Aspose::Words::DocumentVisitor visitor)
overridevirtual

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.

Implements Aspose::Words::Node.

◆ 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 Inline for nested Office Math.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
auto officeMath = System::DynamicCast<Aspose::Words::Math::OfficeMath>(doc->GetChild(Aspose::Words::NodeType::OfficeMath, 0, true));
// OfficeMath nodes that are children of other OfficeMath nodes are always inline
// The node we are working with is a base node, so its location and display type can be changed
ASSERT_EQ(Aspose::Words::Math::MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(Aspose::Words::NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
// Used by OOXML and WML formats
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
// We can change the location and display type of the OfficeMath node
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

◆ 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.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
auto officeMath = System::DynamicCast<Aspose::Words::Math::OfficeMath>(doc->GetChild(Aspose::Words::NodeType::OfficeMath, 0, true));
// OfficeMath nodes that are children of other OfficeMath nodes are always inline
// The node we are working with is a base node, so its location and display type can be changed
ASSERT_EQ(Aspose::Words::Math::MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(Aspose::Words::NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
// Used by OOXML and WML formats
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
// We can change the location and display type of the OfficeMath node
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

◆ 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 Inline.

Inline justification cannot be set to the Office Math with display format type Display.

Corresponding DisplayType has to be set before setting Office Math justification.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
auto officeMath = System::DynamicCast<Aspose::Words::Math::OfficeMath>(doc->GetChild(Aspose::Words::NodeType::OfficeMath, 0, true));
// OfficeMath nodes that are children of other OfficeMath nodes are always inline
// The node we are working with is a base node, so its location and display type can be changed
ASSERT_EQ(Aspose::Words::Math::MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(Aspose::Words::NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
// Used by OOXML and WML formats
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
// We can change the location and display type of the OfficeMath node
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

◆ get_MathObjectType()

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

Gets type MathObjectType of this Office Math object.

◆ get_NodeType()

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

Returns NodeType.OfficeMath.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
auto officeMath = System::DynamicCast<Aspose::Words::Math::OfficeMath>(doc->GetChild(Aspose::Words::NodeType::OfficeMath, 0, true));
// OfficeMath nodes that are children of other OfficeMath nodes are always inline
// The node we are working with is a base node, so its location and display type can be changed
ASSERT_EQ(Aspose::Words::Math::MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(Aspose::Words::NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
// Used by OOXML and WML formats
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
// We can change the location and display type of the OfficeMath node
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

Implements Aspose::Words::Node.

◆ get_ParentParagraph()

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

Retrieves the parent Paragraph of this node.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
auto officeMath = System::DynamicCast<Aspose::Words::Math::OfficeMath>(doc->GetChild(Aspose::Words::NodeType::OfficeMath, 0, true));
// OfficeMath nodes that are children of other OfficeMath nodes are always inline
// The node we are working with is a base node, so its location and display type can be changed
ASSERT_EQ(Aspose::Words::Math::MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(Aspose::Words::NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
// Used by OOXML and WML formats
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
// We can change the location and display type of the OfficeMath node
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

◆ 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 OfficeMathRenderer constructor and passes this object as a parameter.

Returns
The renderer object for this equation.
Examples

Shows how to convert specific object into image

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
// Get OfficeMath node from the document and render this as image (you can also do the same with the Shape node)
auto math = System::DynamicCast<Aspose::Words::Math::OfficeMath>(doc->GetChild(Aspose::Words::NodeType::OfficeMath, 0, true));
math->GetMathRenderer()->Save(ArtifactsDir + u"Shape.SaveShapeObjectAsImage.png", MakeObject<ImageSaveOptions>(Aspose::Words::SaveFormat::Png));

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Math::OfficeMath::GetType ( ) const
overridevirtual

Reimplemented from Aspose::Words::CompositeNode.

◆ Is()

virtual bool Aspose::Words::Math::OfficeMath::Is ( const System::TypeInfo target) const
overridevirtual

Reimplemented from Aspose::Words::CompositeNode.

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

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

◆ Type()

static const System::TypeInfo& Aspose::Words::Math::OfficeMath::Type ( )
static
@ Left
Left justification of Math Paragraph.
@ OfficeMath
An Office Math object. Can be equation, function, matrix or one of other mathematical objects....
@ OMathPara
Math paragraph, or display math zone, that contains one or more OMath elements that are in display mo...
@ Png
Renders a page of the document and saves it as a PNG file.
@ Display
The Office Math is displayed on its own line.