Class

WordEquation

OfficeIMO.Word

Edit on GitHub

Namespace: OfficeIMO.Word
Assembly: OfficeIMO.Word
Source revision: 0eef6a5756b9 with working tree changes
Source: WordEquation.cs:105
Base: WordElement

Encapsulates an OMML equation or a legacy Word EQ field.

Inheritance

WordElement
WordEquation

Usage

Explore 9 API references to this type

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

Returned or exposed by 9

Methods

public void Remove() #

WordEquation.cs:202

Removes the equation and its backing markup from the document.

public WordEquation SetExpression(OfficeMathExpression expression) #

WordEquation.cs:128

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

Parameters

expression OfficeIMO.Drawing.OfficeMathExpression required

Returns

WordEquation

public OfficeDrawing ToDrawing(OfficeMathRenderOptions? options = null) #

WordEquation.cs:124

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

Parameters

options OfficeIMO.Drawing.OfficeMathRenderOptions? = null optional

Returns

OfficeDrawing

public string ToEquationFieldInstruction() #

WordEquation.cs:196

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

Returns

string

public OfficeMathExpression ToExpression() #

WordEquation.cs:119

Projects this equation into the reusable OfficeIMO math expression tree.

Returns

OfficeMathExpression

public string ToLatex() #

WordEquation.cs:105

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

Returns

string

public string ToMathMl() #

WordEquation.cs:108

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

Returns

string

Inherited Methods

Properties

public WordParagraph Paragraph { get; } #

WordEquation.cs:19

Gets the paragraph handle containing this equation.

public WordEquationRepresentation Representation { get; } #

WordEquation.cs:66

Gets the native equation representation.

public string Text { get; set; } #

WordEquation.cs:76

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; } #

WordEquation.cs:99

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

public string? FieldInstruction { get; } #

WordEquation.cs:102

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