MathMatrix

MathMatrix class

Specifies the Matrix object, consisting of child elements laid out in one or more rows and columns. It is important to note that matrices do not have built in delimiters. To place the matrix in the brackets you should use the delimiter object (IMathDelimiter). Null arguments can be used to create gaps in matrices.

public sealed class MathMatrix : MathElementBase, IMathMatrix

Constructors

Name Description
MathMatrix(int, int) Initializes a new instance of the MathMatrix class.

Properties

Name Description
BaseJustification { get; set; } Specifies the vertical justification respect to surrounding text. Possible values are top, bottom, and center. Default: Center
ColumnCount { get; } Number of columns in the matrix
ColumnGap { get; set; } The value of horizontal spacing between columns of a matrix; If the ColumnGapRule is set to 3 (“Exactly”), then the unit is interpreted as twips (1/20th of a point) If the ColumnGapRule is set to 4 (“Multiple”), then the unit is interpreted as number of 0.5 em increments. In other cases ignored. Default: 0
ColumnGapRule { get; set; } The type of horizontal spacing between columns of a matrix; Horizontal spacing units can be ems or points (stored as twips). Default: SingleSpacingGap (0)
HidePlaceholders { get; set; } Hide the placeholders for empty matrix elements Default: false
Item { get; set; } Element of matrix
MinColumnWidth { get; set; } Minimum column width in twips (1/20th of a point) The gap spacing (also referred to as “Column Gap” or “Gap Width”) is added to the MinColumnWidth to determine the total Matrix Column Spacing (distance between the same edges of different columns). Default: 0.
RowCount { get; } Number of rows in the matrix
RowGap { get; set; } The value of vertical spacing between rows of a matrix; If the RowGapRule is set to 3 (“Exactly”), then the unit is interpreted as twips (1/20th of a point) If the RowGapRule is set to 4 (“Multiple”), then the unit is interpreted as half-lines. Default: 0
RowGapRule { get; set; } The type of vertical spacing between rows of a matrix; Vertical spacing units can be lines or points (stored as twips). Default: SingleSpacingGap (0)

Methods

Name Description
Accent(char) Sets an accent mark (a character on the top of this element)
AsArgumentOfFunction(IMathElement) Takes specified function using this instance as the argument
AsArgumentOfFunction(MathFunctionsOfOneArgument) Takes specified function using this instance as the argument
AsArgumentOfFunction(string) Takes specified function using this instance as the argument
AsArgumentOfFunction(MathFunctionsOfTwoArguments, IMathElement) Takes specified function using this instance as the argument and specified additional argument
AsArgumentOfFunction(MathFunctionsOfTwoArguments, string) Takes specified function using this instance as the argument and specified additional argument
DeleteColumn(int) Deletes the specified column
DeleteRow(int) Deletes the specified row
Divide(IMathElement) Creates a fraction with this numerator and specified denominator
Divide(string) Creates a fraction with this numerator and specified denominator
Divide(IMathElement, MathFractionTypes) Creates a fraction of the specified type with this numerator and specified denominator
Divide(string, MathFractionTypes) Creates a fraction of the specified type with this numerator and specified denominator
Enclose() Encloses a math element in parenthesis
virtual Enclose(char, char) Encloses a math element in specified characters such as parenthesis or another characters as framing
Function(IMathElement) Takes a function of an argument using this instance as the function name
Function(string) Takes a function of an argument using this instance as the function name
GetChildren() Get children elements
GetColumnAlignment(int) Get the horizontal alignment of the specified column
Group() Places this element in a group using a bottom curly bracket
Group(char, MathTopBotPositions, MathTopBotPositions) Places this element in a group using a grouping character such as bottom curly bracket or another
InsertColumnAfter(int) Insert a new column after the specified one Initially all elements in the new column are null.
InsertColumnBefore(int) Insert a new column before the specified one Initially all elements in the new column are null.
InsertRowAfter(int) Insert a new row after the specified one Initially all elements in the new row are null.
InsertRowBefore(int) Insert a new row before the specified one Initially all elements in the new row are null.
Integral(MathIntegralTypes) Takes the integral without limits
Integral(MathIntegralTypes, IMathElement, IMathElement) Takes the integral
Integral(MathIntegralTypes, string, string) Takes the integral
Integral(MathIntegralTypes, IMathElement, IMathElement, MathLimitLocations) Takes the integral
Integral(MathIntegralTypes, string, string, MathLimitLocations) Takes the integral
virtual Join(IMathElement) Joins a mathematical element and forms a mathematical block
virtual Join(string) Joins a mathematical text and forms a mathematical block
Nary(MathNaryOperatorTypes, IMathElement, IMathElement) Creates a N-ary operator
Nary(MathNaryOperatorTypes, string, string) Creates a N-ary operator
Overbar() Sets a bar on the top of this element
Radical(IMathElement) Specifies the mathematical root of the given degree from the specified argument.
Radical(string) Specifies the mathematical root of the given degree from the specified argument.
SetColumnAlignment(int, MathHorizontalAlignment) Set the horizontal alignment of the specified column
SetColumnsAlignment(int, uint, MathHorizontalAlignment) Set the horizontal alignment of the specified columns
SetLowerLimit(IMathElement) Takes lower limit
SetLowerLimit(string) Takes lower limit
SetSubscript(IMathElement) Creates subscript
SetSubscript(string) Creates subscript
SetSubSuperscriptOnTheLeft(IMathElement, IMathElement) Creates subscript and superscript on the left
SetSubSuperscriptOnTheLeft(string, string) Creates subscript and superscript on the left
SetSubSuperscriptOnTheRight(IMathElement, IMathElement) Creates subscript and superscript on the right
SetSubSuperscriptOnTheRight(string, string) Creates subscript and superscript on the right
SetSuperscript(IMathElement) Creates superscript
SetSuperscript(string) Creates superscript
SetUpperLimit(IMathElement) Takes upper limit
SetUpperLimit(string) Takes upper limit
ToBorderBox() Places this element in a border-box
ToBorderBox(bool, bool, bool, bool, bool, bool, bool, bool) Places this element in a border-box
ToBox() Places this element in a non-visual box (logical grouping) which is used to group components of an equation or other instance of mathematical text. A boxed object can (for example) serve as an operator emulator with or without an alignment point, serve as a line break point, or be grouped such as not to allow line breaks within.
virtual ToMathArray() Puts in a vertical array
Underbar() Sets a bar on the bottom of this element

Examples

Example:

[C#]
IMathMatrix matrix = new MathMatrix(2, 3);
matrix[0, 0] = new MathematicalText("item.1.1");

See Also