Get Started

API Reference

Class

WordEquation

Edit on GitHub
Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Source OfficeIMO.Word/WordEquation.cs:99
Base WordElement

Encapsulates an OMML equation or a legacy Word EQ field.

Inheritance

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

public Void Remove() #
OfficeIMO.Word/WordEquation.cs:196
Returns: Void

Removes the equation and its backing markup from the document.

public WordEquation SetExpression(OfficeMathExpression expression) #
OfficeIMO.Word/WordEquation.cs:122
Returns: WordEquation

Replaces this equation with an editable OMML representation of a shared expression.

Parameters

expression OfficeIMO.Drawing.OfficeMathExpression requiredposition: 0
public OfficeDrawing ToDrawing(OfficeMathRenderOptions options = null) #
OfficeIMO.Word/WordEquation.cs:118
Returns: OfficeDrawing

Renders this equation through the shared dependency-free math renderer.

Parameters

options OfficeIMO.Drawing.OfficeMathRenderOptions = null optionalposition: 0
public String ToEquationFieldInstruction() #
OfficeIMO.Word/WordEquation.cs:190
Returns: String

Projects OMML to a legacy Word EQ instruction, or returns the existing EQ instruction.

public OfficeMathExpression ToExpression() #
OfficeIMO.Word/WordEquation.cs:113
Returns: OfficeMathExpression

Projects this equation into the reusable OfficeIMO math expression tree.

public String ToLatex() #
OfficeIMO.Word/WordEquation.cs:99
Returns: String

Projects the equation to LaTeX. Field-backed equations fall back to their cached display text.

public String ToMathMl() #
OfficeIMO.Word/WordEquation.cs:102
Returns: String

Projects the equation to MathML. Field-backed equations use a safe mtext fallback.

Properties

public WordEquationRepresentation Representation { get; } #
OfficeIMO.Word/WordEquation.cs:60

Gets the native equation representation.

public String Text { get; set; } #
OfficeIMO.Word/WordEquation.cs:70

Gets or sets deterministic visible equation text. Setting OMML text replaces the structured expression with one math text run; setting an EQ field updates its cached display result.

public String Omml { get; } #
OfficeIMO.Word/WordEquation.cs:93

Gets raw OMML when the equation is backed by DOCX math markup; otherwise null.

public String FieldInstruction { get; } #
OfficeIMO.Word/WordEquation.cs:96

Gets the raw EQ field instruction when the equation is field-backed; otherwise null.