Aspose::Words::Math Namespace Reference

Detailed Description

The Aspose.Words.Math namespace contains classes that represent Office Math elements.

Classes
class	OfficeMath
	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. To learn more, visit the Working with OfficeMath documentation article. More...

Enumerations
enum class	MathObjectType
	Specifies type of an Office Math object. More...
enum class	OfficeMathDisplayType
	Specifies the display format type of the equation. More...
enum class	OfficeMathJustification
	Specifies the justification of the equation. More...

Enumeration Type Documentation

MathObjectType

enum class Aspose::Words::Math::MathObjectType

strong

Specifies type of an Office Math object.

Examples

Shows how to print the node structure of every office math node in a document.

void OfficeMathToText()
{
    auto doc = MakeObject<Document>(MyDir + u"DocumentVisitor-compatible features.docx");
    auto visitor = MakeObject<ExDocumentVisitor::OfficeMathStructurePrinter>();
 
    // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
    // and then traverses all the node's children in a depth-first manner.
    // The visitor can read and modify each visited node.
    doc->Accept(visitor);
 
    std::cout << visitor->GetText() << std::endl;
}
 
class OfficeMathStructurePrinter : public DocumentVisitor
{
public:
    OfficeMathStructurePrinter() : mVisitorIsInsideOfficeMath(false), mDocTraversalDepth(0)
    {
        mBuilder = MakeObject<System::Text::StringBuilder>();
        mVisitorIsInsideOfficeMath = false;
    }
 
    String GetText()
    {
        return mBuilder->ToString();
    }
 
    VisitorAction VisitRun(SharedPtr<Run> run) override
    {
        if (mVisitorIsInsideOfficeMath)
        {
            IndentAndAppendLine(String(u"[Run] \"") + run->GetText() + u"\"");
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitOfficeMathStart(SharedPtr<OfficeMath> officeMath) override
    {
        IndentAndAppendLine(String(u"[OfficeMath start] Math object type: ") + System::ObjectExt::ToString(officeMath->get_MathObjectType()));
        mDocTraversalDepth++;
        mVisitorIsInsideOfficeMath = true;
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitOfficeMathEnd(SharedPtr<OfficeMath> officeMath) override
    {
        mDocTraversalDepth--;
        IndentAndAppendLine(u"[OfficeMath end]");
        mVisitorIsInsideOfficeMath = false;
 
        return VisitorAction::Continue;
    }
 
private:
    bool mVisitorIsInsideOfficeMath;
    int mDocTraversalDepth;
    SharedPtr<System::Text::StringBuilder> mBuilder;
 
    void IndentAndAppendLine(String text)
    {
        for (int i = 0; i < mDocTraversalDepth; i++)
        {
            mBuilder->Append(u"|  ");
        }
 
        mBuilder->AppendLine(text);
    }
};

Enumerator
OMath	Instance of mathematical text.
OMathPara	Math paragraph, or display math zone, that contains one or more OMath elements that are in display mode.
Accent	Accent function, consisting of a base and a combining diacritical mark.
Bar	Bar function, consisting of a base argument and an overbar or underbar.
BorderBox	Border Box object, consisting of a border drawn around an instance of mathematical text (such as a formula or equation)
Box	Box object, which is used to group components of an equation or other instance of mathematical text.
Delimiter	Delimiter object, consisting of opening and closing delimiters (such as parentheses, braces, brackets, and vertical bars), and an element contained inside.
Degree	Degree in the mathematical radical.
Argument	Argument object. Encloses Office Math entities when they are used as arguments to other Office Math entities.
Array	Array object, consisting of one or more equations, expressions, or other mathematical text runs that can be vertically justified as a unit with respect to surrounding text on the line.
Fraction	Fraction object, consisting of a numerator and denominator separated by a fraction bar.
Denominator	Denominator of a fraction object.
Numerator	Numerator of the Fraction object.
Function	Function-Apply object, which consists of a function name and an argument element acted upon.
FunctionName	Name of the function. For example, function names are sin and cos.
GroupCharacter	Group-Character object, consisting of a character drawn above or below text, often with the purpose of visually grouping items.
Limit	Lower limit of the LowerLimit object and the upper limit of the UpperLimit function.
LowerLimit	Lower-Limit object, consisting of text on the baseline and reduced-size text immediately below it.
UpperLimit	Upper-Limit object, consisting of text on the baseline and reduced-size text immediately above it.
Matrix	Matrix object, consisting of one or more elements laid out in one or more rows and one or more columns.
MatrixRow	Single row of the matrix.
NAry	N-ary object, consisting of an n-ary object, a base (or operand), and optional upper and lower limits.
Phantom	Phantom object.
Radical	Radical object, consisting of a radical, a base element, and an optional degree .
SubscriptPart	Subscript of the object that can have subscript part.
SuperscriptPart	Superscript of the superscript object.
PreSubSuperscript	Pre-Sub-Superscript object, which consists of a base element and a subscript and superscript placed to the left of the base.
Subscript	Subscript object, which consists of a base element and a reduced-size script placed below and to the right.
SubSuperscript	Sub-superscript object, which consists of a base element, a reduced-size script placed below and to the right, and a reduced-size script placed above and to the right.
Supercript	Superscript object, which consists of a base element and a reduced-size script placed above and to the right.

OfficeMathDisplayType

enum class Aspose::Words::Math::OfficeMathDisplayType

strong

Specifies the display format type of the equation.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
 
// OfficeMath nodes that are children of other OfficeMath nodes are always inline.
// The node we are working with is the base node to change its location and display type.
ASSERT_EQ(MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
 
// OOXML and WML formats use the "EquationXmlEncoding" property.
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
 
// Change the location and display type of the OfficeMath node.
officeMath->set_DisplayType(OfficeMathDisplayType::Display);
officeMath->set_Justification(OfficeMathJustification::Left);
 
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

Enumerator
Display	The Office Math is displayed on its own line.
Inline	The Office Math is displayed inline with the text.

OfficeMathJustification

enum class Aspose::Words::Math::OfficeMathJustification

strong

Specifies the justification of the equation.

Examples

Shows how to set office math display formatting.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
 
// OfficeMath nodes that are children of other OfficeMath nodes are always inline.
// The node we are working with is the base node to change its location and display type.
ASSERT_EQ(MathObjectType::OMathPara, officeMath->get_MathObjectType());
ASSERT_EQ(NodeType::OfficeMath, officeMath->get_NodeType());
ASPOSE_ASSERT_EQ(officeMath->get_ParentNode(), officeMath->get_ParentParagraph());
 
// OOXML and WML formats use the "EquationXmlEncoding" property.
ASSERT_TRUE(officeMath->get_EquationXmlEncoding() == nullptr);
 
// Change the location and display type of the OfficeMath node.
officeMath->set_DisplayType(OfficeMathDisplayType::Display);
officeMath->set_Justification(OfficeMathJustification::Left);
 
doc->Save(ArtifactsDir + u"Shape.OfficeMath.docx");

Enumerator
CenterGroup	Justifies instances of mathematical text to the left with respect to each other, and centers the group of mathematical text (the Math Paragraph) with respect to the page.
Center	Centers each instance of mathematical text individually with respect to margins.
Left	Left justification of Math Paragraph.
Right	Right Justification of Math Paragraph.
Inline	Inline position of Math.
Default	Default value CenterGroup.