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.
MathMatrix
| Name | Description |
|---|---|
| MathMatrix(int, int) | Initializes a new instance of the MathMatrix class. |
Parameters:
| Name | Type | Description |
|---|---|---|
| rowCount | int | row count |
| columnCount | int | column count |
Returns: MathMatrix
deleteColumn
| Name | Description |
|---|---|
| deleteColumn (int) | Deletes the specified column |
Parameters:
| Name | Type | Description |
|---|---|---|
| columnIndex | int | The zero-based index of the column to delete. |
Returns: void
Exception
| Error | Condition |
|---|---|
| ArgumentOutOfRangeException | If columnIndex less than zero or greater or equal to the ColumnCount |
deleteRow
| Name | Description |
|---|---|
| deleteRow (int) | Deletes the specified row |
Parameters:
| Name | Type | Description |
|---|---|---|
| rowIndex | int | The zero-based index of the row to delete. |
Returns: void
Exception
| Error | Condition |
|---|---|
| ArgumentOutOfRangeException | If rowIndex less than zero or greater or equal to the RowCount |
getBaseJustification
| Name | Description |
|---|---|
| getBaseJustification () | Specifies the vertical justification respect to surrounding text. Possible values are top, bottom, and center. Default: Center |
Returns: int
getChildren
| Name | Description |
|---|---|
| getChildren () | Get children elements |
Returns: MathLeftSubSuperscriptElement, MathMatrix, MathLimit, MathBlock, MathRadical, MathArray, MathDelimiter, MathNaryOperator, MathAccent, MathBorderBox, MathGroupingCharacter, MathBar, MathFunction, MathSuperscriptElement, MathSubscriptElement, BaseScript, MathematicalText, MathFraction, MathElementBase, MathBox, MathRightSubSuperscriptElement
getColumnAlignment
| Name | Description |
|---|---|
| getColumnAlignment (int) | Get the horizontal alignment of the specified column |
Parameters:
| Name | Type | Description |
|---|---|---|
| columnIndex | int | Zero-based column index |
Returns: int
getColumnCount
| Name | Description |
|---|---|
| getColumnCount () | Number of columns in the matrix |
Returns: int
getColumnGap
| Name | Description |
|---|---|
| getColumnGap () | 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 |
Returns: long
getColumnGapRule
| Name | Description |
|---|---|
| getColumnGapRule () | The type of horizontal spacing between columns of a matrix; Horizontal spacing units can be ems or points (stored as twips). Default: SingleSpacingGap (0) |
Returns: int
getHidePlaceholders
| Name | Description |
|---|---|
| getHidePlaceholders () | Hide the placeholders for empty matrix elements Default: false |
Returns: boolean
getMinColumnWidth
| Name | Description |
|---|---|
| getMinColumnWidth () | 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. |
Returns: long
getRowCount
| Name | Description |
|---|---|
| getRowCount () | Number of rows in the matrix |
Returns: int
getRowGap
| Name | Description |
|---|---|
| getRowGap () | 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 |
Returns: long
getRowGapRule
| Name | Description |
|---|---|
| getRowGapRule () | The type of vertical spacing between rows of a matrix; Vertical spacing units can be lines or points (stored as twips). Default: SingleSpacingGap (0) |
Returns: int
get_Item
| Name | Description |
|---|---|
| get_Item (int, int) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: MathLeftSubSuperscriptElement, MathMatrix, MathLimit, MathBlock, MathRadical, MathArray, MathDelimiter, MathNaryOperator, MathAccent, MathBorderBox, MathGroupingCharacter, MathBar, MathFunction, MathSuperscriptElement, MathSubscriptElement, BaseScript, MathematicalText, MathFraction, MathElementBase, MathBox, MathRightSubSuperscriptElement
insertColumnAfter
| Name | Description |
|---|---|
| insertColumnAfter (int) | Insert a new column after the specified one Initially all elements in the new column are null. |
Parameters:
| Name | Type | Description |
|---|---|---|
| columnIndex | int | Index of the column after which to insert a new one |
Returns: void
insertColumnBefore
| Name | Description |
|---|---|
| insertColumnBefore (int) | Insert a new column before the specified one Initially all elements in the new column are null. |
Parameters:
| Name | Type | Description |
|---|---|---|
| columnIndex | int | Index of the column before which to insert a new one |
Returns: void
insertRowAfter
| Name | Description |
|---|---|
| insertRowAfter (int) | Insert a new row after the specified one Initially all elements in the new row are null. |
Parameters:
| Name | Type | Description |
|---|---|---|
| rowIndex | int | Index of the row after which to insert a new one |
Returns: void
insertRowBefore
| Name | Description |
|---|---|
| insertRowBefore (int) | Insert a new row before the specified one Initially all elements in the new row are null. |
Parameters:
| Name | Type | Description |
|---|---|---|
| rowIndex | int | Index of the row before which to insert a new one |
Returns: void
setBaseJustification
| Name | Description |
|---|---|
| setBaseJustification (int) | Specifies the vertical justification respect to surrounding text. Possible values are top, bottom, and center. Default: Center |
Returns: void
setColumnAlignment
| Name | Description |
|---|---|
| setColumnAlignment (int, int) | Set the horizontal alignment of the specified column |
Parameters:
| Name | Type | Description |
|---|---|---|
| columnIndex | int | Zero-based column index |
| val | int | New value of horizontal alignment of specified column |
Returns: void
setColumnGap
| Name | Description |
|---|---|
| setColumnGap (long) | 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 |
Returns: void
setColumnGapRule
| Name | Description |
|---|---|
| setColumnGapRule (int) | The type of horizontal spacing between columns of a matrix; Horizontal spacing units can be ems or points (stored as twips). Default: SingleSpacingGap (0) |
Returns: void
setColumnsAlignment
| Name | Description |
|---|---|
| setColumnsAlignment (int, long, int) | Set the horizontal alignment of the specified columns |
Parameters:
| Name | Type | Description |
|---|---|---|
| columnIndex | int | Zero-based index of the first column to set alignment |
| columnsCount | long | The number of columns to specify the alignment |
| val | int | New value of horizontal alignment of specified column |
Returns: void
setHidePlaceholders
| Name | Description |
|---|---|
| setHidePlaceholders (boolean) | Hide the placeholders for empty matrix elements Default: false |
Returns: void
setMinColumnWidth
| Name | Description |
|---|---|
| setMinColumnWidth (long) | 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. |
Returns: void
setRowGap
| Name | Description |
|---|---|
| setRowGap (long) | 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 |
Returns: void
setRowGapRule
| Name | Description |
|---|---|
| setRowGapRule (int) | The type of vertical spacing between rows of a matrix; Vertical spacing units can be lines or points (stored as twips). Default: SingleSpacingGap (0) |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathLeftSubSuperscriptElement) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathMatrix) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathLimit) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathBlock) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathRadical) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathArray) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathDelimiter) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathNaryOperator) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathAccent) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathBorderBox) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathGroupingCharacter) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathBar) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathFunction) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathSuperscriptElement) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathSubscriptElement) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, BaseScript) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathematicalText) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathFraction) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathElementBase) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathBox) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void
set_Item
| Name | Description |
|---|---|
| set_Item (int, int, MathRightSubSuperscriptElement) | Element of matrix |
Parameters:
| Name | Type | Description |
|---|---|---|
| row | int | The zero-based index of the row to get item |
| column | int | The zero-based index of the column to get item |
Returns: void