GrapeCity.Documents.Word

GrapeCity.Documents.Word.OMathElement

Class OMathElement

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents an element inside an OMathStruct class instance.

public class OMathElement : ContentObject, IBrowsable<OMathElement>

Inheritance: object

ContentObject

OMathElement

Implements: IBrowsable<OMathElement>

Inherited Members: ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.ToString()

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

CanChangeRelativeSize

Gets whether the RelativeSize property can be changed.

public bool CanChangeRelativeSize { get; }

Property Value

bool

Column

Gets the OMathMatrixColumn of the element if it is a cell in the OMathMatrix structure.

public OMathMatrixColumn Column { get; }

Property Value

OMathMatrixColumn

DefaultRelativeSize

Gets the default value for the RelativeSize property.

public int DefaultRelativeSize { get; }

Property Value

int

ElementType

Gets the OMathElementType of the element.

public OMathElementType ElementType { get; }

Property Value

OMathElementType

MaxRelativeSize

Gets the maximum value for the RelativeSize property of the element.

public int MaxRelativeSize { get; }

Property Value

int

MinRelativeSize

Gets the minimum value for the RelativeSize property of the element.

public int MinRelativeSize { get; }

Property Value

int

Gets the next OMathElement in a collection.

public OMathElement Next { get; }

Property Value

OMathElement

ParentElement

Gets the parent OMathElement class instance.

public OMathElement ParentElement { get; }

Property Value

OMathElement

ParentOMath

Gets the parent OMath class instance.

public OMath ParentOMath { get; }

Property Value

OMath

ParentStruct

Gets the parent OMathStruct class instance.

public OMathStruct ParentStruct { get; }

Property Value

OMathStruct

Gets the previous OMathElement in a collection.

public OMathElement Previous { get; }

Property Value

OMathElement

RelativeSize

Gets or sets the element text size relative to the normal text size. For instance, 1 represents that it is one size larger than normal.

Allowed values are from MinRelativeSize to MaxRelativeSize, inclusive.

Default value defined in the DefaultRelativeSize property.

public int RelativeSize { get; set; }

Property Value

int

Row

Gets the OMathMatrixRow of the element if it is a cell in the OMathMatrix structure.

public OMathMatrixRow Row { get; }

Property Value

OMathMatrixRow

Methods

AddAccent()

Adds a new OMathAccent to the end of the Office Math element.

public OMathAccent AddAccent()

Returns

OMathAccent: The added OMathAccent instance.

AddAccent(string, string)

Adds a new OMathAccent to the end of the Office Math element.

public OMathAccent AddAccent(string baseText, string character = null)

Parameters

baseText string: The structure base element text.
character string: The structure accent character.

Returns

OMathAccent: The added OMathAccent instance.

AddBar()

Adds a new OMathBar to the end of the Office Math element.

public OMathBar AddBar()

Returns

OMathBar: The added OMathBar instance.

AddBar(string)

Adds a new OMathBar to the end of the Office Math element.

public OMathBar AddBar(string baseText)

Parameters

baseText string: The structure base element text.

Returns

OMathBar: The added OMathBar instance.

AddBorderBox()

Adds a new OMathBorderBox to the end of the Office Math element.

public OMathBorderBox AddBorderBox()

Returns

OMathBorderBox: The added OMathBorderBox instance.

AddBorderBox(string)

Adds a new OMathBorderBox to the end of the Office Math element.

public OMathBorderBox AddBorderBox(string baseText)

Parameters

baseText string: The structure base element text.

Returns

OMathBorderBox: The added OMathBorderBox instance.

AddBox()

Adds a new OMathBox to the end of the Office Math element.

public OMathBox AddBox()

Returns

OMathBox: The added OMathBox instance.

AddBox(string)

Adds a new OMathBox to the end of the Office Math element.

public OMathBox AddBox(string baseText)

Parameters

baseText string: The structure base element text.

Returns

OMathBox: The added OMathBox instance.

AddComplexField(string, string)

Adds a ComplexField to the end of the Office Math element.

public ComplexField AddComplexField(string code, string result)

Parameters

code string: The complex field code.
result string: The result text of the inserted field.

Returns

ComplexField: The added ComplexField.

AddComplexField(string)

Adds a ComplexField to the end of the Office Math element.

public ComplexField AddComplexField(string code)

Parameters

code string: The complex field code.

Returns

ComplexField: The added ComplexField.

AddContentControl(ContentControlType, bool)

Adds a ContentControl to the end of the Office Math element.

public ContentControl AddContentControl(ContentControlType type, bool fillContent = true)

Parameters

type ContentControlType: The new content control type.
fillContent bool: Whether to fill the new control content with default data.

Returns

ContentControl: The added ContentControl.

AddDelimiter()

Adds a new OMathDelimiter to the end of the Office Math element.

public OMathDelimiter AddDelimiter()

Returns

OMathDelimiter: The added OMathDelimiter instance.

AddDelimiter(string[], string, string, string)

Adds a new OMathDelimiter to the end of the Office Math element.

public OMathDelimiter AddDelimiter(string[] itemsText, string beginCharacter = null, string endCharacter = null, string separatorCharacter = null)

Parameters

itemsText string[]: The structure items text array.
beginCharacter string: The stricture beginning, or opening character.
endCharacter string: The structure ending, or closing character.
separatorCharacter string: The structure character that separates items.

Returns

OMathDelimiter: The added OMathDelimiter instance.

AddEndnote(string, char, string)

Adds an Endnote to the end of the Office Math element.

public Endnote AddEndnote(string text, char referenceCharacter, string referenceFontName)

Parameters

text string: The endnote text.
referenceCharacter char: The endnote reference symbol.
referenceFontName string: The endnote reference symbol font.

Returns

Endnote: The added Endnote.

AddEndnote(string, string)

Adds an Endnote to the end of the Office Math element.

public Endnote AddEndnote(string text, string reference)

Parameters

text string: The endnote text.
reference string: The endnote reference text.

Returns

Endnote: The added Endnote.

AddEndnote(string)

Adds an Endnote to the end of the Office Math element.

public Endnote AddEndnote(string text = null)

Parameters

text string: The endnote text.

Returns

Endnote: The added Endnote.

AddEquationArray()

Adds a new OMathEquationArray to the end of the Office Math element.

public OMathEquationArray AddEquationArray()

Returns

OMathEquationArray: The added OMathEquationArray instance.

AddEquationArray(string[])

Adds a new OMathEquationArray to the end of the Office Math element.

public OMathEquationArray AddEquationArray(string[] itemsText)

Parameters

itemsText string[]: The structure items text array.

Returns

OMathEquationArray: The added OMathEquationArray instance.

AddFootnote(string, char, string)

Adds a Footnote to the end of the Office Math element.

public Footnote AddFootnote(string text, char referenceCharacter, string referenceFontName)

Parameters

text string: The footnote text.
referenceCharacter char: The footnote reference symbol.
referenceFontName string: The footnote reference symbol font.

Returns

Footnote: The added Footnote.

AddFootnote(string, string)

Adds a Footnote to the end of the Office Math element.

public Footnote AddFootnote(string text, string reference)

Parameters

text string: The footnote text.
reference string: The footnote reference text.

Returns

Footnote: The added Footnote.

AddFootnote(string)

Adds a Footnote to the end of the Office Math element.

public Footnote AddFootnote(string text = null)

Parameters

text string: The footnote text.

Returns

Footnote: The added Footnote.

AddFraction()

Adds a new OMathFraction to the end of the Office Math element.

public OMathFraction AddFraction()

Returns

OMathFraction: The added OMathFraction instance.

AddFraction(string, string, OMathFractionType?)

Adds a new OMathFraction to the end of the Office Math element.

public OMathFraction AddFraction(string numeratorText, string denominatorText, OMathFractionType? fractionType)

Parameters

numeratorText string: The structure numerator element text.
denominatorText string: The structure denominator element text.
fractionType OMathFractionType?: The fraction type.

Returns

OMathFraction: The added OMathFraction instance.

AddFunction()

Adds a new OMathFunction to the end of the Office Math element.

public OMathFunction AddFunction()

Returns

OMathFunction: The added OMathFunction instance.

AddFunction(string, string)

Adds a new OMathFunction to the end of the Office Math element.

public OMathFunction AddFunction(string nameText, string argumentText)

Parameters

nameText string: The structure name element text.
argumentText string: The structure argument element text.

Returns

OMathFunction: The added OMathFunction instance.

AddGroupCharacter()

Adds a new OMathGroupCharacter to the end of the Office Math element.

public OMathGroupCharacter AddGroupCharacter()

Returns

OMathGroupCharacter: The added OMathGroupCharacter instance.

AddGroupCharacter(string, string)

Adds a new OMathGroupCharacter to the end of the Office Math element.

public OMathGroupCharacter AddGroupCharacter(string baseText, string character = null)

Parameters

baseText string: The structure base element text.
character string: The structure group character.

Returns

OMathGroupCharacter: The added OMathGroupCharacter instance.

AddHyperlink()

Adds a Hyperlink to the end of the Office Math element.

public Hyperlink AddHyperlink()

Returns

Hyperlink: The added Hyperlink.

AddHyperlink(string, string, string, string)

Adds a Hyperlink to the end of the Office Math element.

public Hyperlink AddHyperlink(string anchor, string text, string screenTip = null, string target = null)

Parameters

anchor string: The name of a bookmark in the current document which shall be the target of this hyperlink.
text string: The display text of the specified hyperlink.
screenTip string: The text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.
target string: The name of the frame or window in which you want to load the specified hyperlink.

Returns

Hyperlink: The added Hyperlink.

AddHyperlink(Uri, string, string, string, string)

Adds a Hyperlink to the end of the Office Math element.

public Hyperlink AddHyperlink(Uri address, string anchor, string text, string screenTip = null, string target = null)

Parameters

address System.Uri: The address for the specified link. The address can be an e-mail address, an Internet address, or a file name.
anchor string: The name of a bookmark in the current document which shall be the target of this hyperlink.
text string: The display text of the specified hyperlink.
screenTip string: The text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.
target string: The name of the frame or window in which you want to load the specified hyperlink.

Returns

Hyperlink: The added Hyperlink.

AddLimitLower()

Adds a new OMathLimitLower to the end of the Office Math element.

public OMathLimitLower AddLimitLower()

Returns

OMathLimitLower: The added OMathLimitLower instance.

AddLimitLower(string, string)

Adds a new OMathLimitLower to the end of the Office Math element.

public OMathLimitLower AddLimitLower(string baseText, string limitText)

Parameters

baseText string: The structure base element text.
limitText string: The structure limit element text.

Returns

OMathLimitLower: The added OMathLimitLower instance.

AddLimitUpper()

Adds a new OMathLimitUpper to the end of the Office Math element.

public OMathLimitUpper AddLimitUpper()

Returns

OMathLimitUpper: The added OMathLimitUpper instance.

AddLimitUpper(string, string)

Adds a new OMathLimitUpper to the end of the Office Math element.

public OMathLimitUpper AddLimitUpper(string baseText, string limitText)

Parameters

baseText string: The structure base element text.
limitText string: The structure limit element text.

Returns

OMathLimitUpper: The added OMathLimitUpper instance.

AddMatrix()

Adds a new OMathMatrix to the end of the Office Math element.

public OMathMatrix AddMatrix()

Returns

OMathMatrix: The added OMathMatrix instance.

AddMatrix(int, int)

Adds a new OMathMatrix to the end of the Office Math element.

public OMathMatrix AddMatrix(int rows, int columns)

Parameters

rows int: Count of rows in the matrix.
columns int: Count of columns in the matrix.

Returns

OMathMatrix: The added OMathMatrix instance.

AddMatrix(int?[,])

Adds a new OMathMatrix to the end of the Office Math element.

public OMathMatrix AddMatrix(int?[,] cellsValue)

Parameters

cellsValue int?[,]: The structure cells value array.

Returns

OMathMatrix: The added OMathMatrix instance.

AddMatrix(string[,])

Adds a new OMathMatrix to the end of the Office Math element.

public OMathMatrix AddMatrix(string[,] cellsText)

Parameters

cellsText string[,]: The structure cells text array.

Returns

OMathMatrix: The added OMathMatrix instance.

AddNary()

Adds a new OMathNary to the end of the Office Math element.

public OMathNary AddNary()

Returns

OMathNary: The added OMathNary instance.

AddNary(string, string, string, string)

Adds a new OMathNary to the end of the Office Math element.

public OMathNary AddNary(string baseText, string subscriptText, string superscriptText, string character = null)

Parameters

baseText string: The structure base element text.
subscriptText string: The structure subscript element text.
superscriptText string: The structure superscript element text.
character string: The n-ary character.

Returns

OMathNary: The added OMathNary instance.

AddOMathStruct(OMathStructType)

Adds a new OMathStruct to the end of the Office Math element.

public OMathStruct AddOMathStruct(OMathStructType type)

Parameters

type OMathStructType: The Office Math structure type.

Returns

OMathStruct: The added OMathStruct instance.

AddPhantom()

Adds a new OMathPhantom to the end of the Office Math element.

public OMathPhantom AddPhantom()

Returns

OMathPhantom: The added OMathPhantom instance.

AddPhantom(string, bool)

Adds a new OMathPhantom to the end of the Office Math element.

public OMathPhantom AddPhantom(string argumentText, bool smash)

Parameters

argumentText string: The structure argument element text.
smash bool: Whether the argument element is visible but that the height is not taken into account in the spacing of the layout.

Returns

OMathPhantom: The added OMathPhantom instance.

AddPreSubSuperscript()

Adds a new OMathPreSubSuperscript to the end of the Office Math element.

public OMathPreSubSuperscript AddPreSubSuperscript()

Returns

OMathPreSubSuperscript: The added OMathPreSubSuperscript instance.

AddPreSubSuperscript(string, string, string)

Adds a new OMathPreSubSuperscript to the end of the Office Math element.

public OMathPreSubSuperscript AddPreSubSuperscript(string baseText, string subscriptText, string superscriptText)

Parameters

baseText string: The structure base element text.
subscriptText string: The structure subscript element text.
superscriptText string: The structure superscript element text.

Returns

OMathPreSubSuperscript: The added OMathPreSubSuperscript instance.

AddRadical()

Adds a new OMathRadical to the end of the Office Math element.

public OMathRadical AddRadical()

Returns

OMathRadical: The added OMathRadical instance.

AddRadical(string, string)

Adds a new OMathRadical to the end of the Office Math element.

public OMathRadical AddRadical(string radicandText, string degreeText)

Parameters

radicandText string: The structure radicand element text.
degreeText string: The structure degree element text.

Returns

OMathRadical: The added OMathRadical instance.

AddRun()

Adds a Run to the end of the Office Math element.

public Run AddRun()

Returns

Run: The added Run.

AddRun(Style)

Adds a Run to the end of the Office Math element.

public Run AddRun(Style style)

Parameters

style Style: The run character or linked paragraph style.

Returns

Run: The added Run.

AddRun(string, Style)

Adds a Run to the end of the Office Math element.

public Run AddRun(string text, Style style)

Parameters

text string: The text of the inserted Run
style Style: The run character or linked paragraph style.

Returns

Run: The added Run.

AddRun(string)

Adds a Run to the end of the Office Math element.

public Run AddRun(string text)

Parameters

text string: The text of the inserted Run

Returns

Run: The added Run.

AddSimpleField(string, string)

Adds a SimpleField to the end of the Office Math element.

public SimpleField AddSimpleField(string code, string result)

Parameters

code string: The field code.
result string: The result text of the inserted field.

Returns

SimpleField: The added SimpleField.

AddSimpleField(string)

Adds a SimpleField to the end of the Office Math element.

public SimpleField AddSimpleField(string code)

Parameters

code string: The field code.

Returns

SimpleField: The added SimpleField.

AddSubscript()

Adds a new OMathSubscript to the end of the Office Math element.

public OMathSubscript AddSubscript()

Returns

OMathSubscript: The added OMathSubscript instance.

AddSubscript(string, string)

Adds a new OMathSubscript to the end of the Office Math element.

public OMathSubscript AddSubscript(string baseText, string subscriptText)

Parameters

baseText string: The structure base element text.
subscriptText string: The structure subscript element text.

Returns

OMathSubscript: The added OMathSubscript instance.

AddSubSuperscript()

Adds a new OMathSubSuperscript to the end of the Office Math element.

public OMathSubSuperscript AddSubSuperscript()

Returns

OMathSubSuperscript: The added OMathSubSuperscript instance.

AddSubSuperscript(string, string, string)

Adds a new OMathSubSuperscript to the end of the Office Math element.

public OMathSubSuperscript AddSubSuperscript(string baseText, string subscriptText, string superscriptText)

Parameters

baseText string: The structure base element text.
subscriptText string: The structure subscript element text.
superscriptText string: The structure superscript element text.

Returns

OMathSubSuperscript: The added OMathSubSuperscript instance.

AddSuperscript()

Adds a new OMathSuperscript to the end of the Office Math element.

public OMathSuperscript AddSuperscript()

Returns

OMathSuperscript: The added OMathSuperscript instance.

AddSuperscript(string, string)

Adds a new OMathSuperscript to the end of the Office Math element.

public OMathSuperscript AddSuperscript(string baseText, string superscriptText)

Parameters

baseText string: The structure base element text.
superscriptText string: The structure superscript element text.

Returns

OMathSuperscript: The added OMathSuperscript instance.

Delete()

Deletes this content object from the parent Body.

Note that the position occupied by this content object in the parent can still be accessed (e.g. to insert new content) via a PersistentRange if one has previously been created with GetPersistentRange().

public override void Delete()