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.

Inheritance:MathMatrix → MathElementBase

The MathMatrix type exposes the following members:

Constructors

Constructor	Description
`__init__`	Initializes a new instance of the MathMatrix class.

Properties

Property	Description
`row_count`	Number of rows in the matrix
`column_count`	Number of columns in the matrix
`hide_placeholders`	Hide the placeholders for empty matrix elements Default: false
`base_justification`	Specifies the vertical justification respect to surrounding text. Possible values are top, bottom, and center. Default: Center
`min_column_width`	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.
`column_gap_rule`	The type of horizontal spacing between columns of a matrix; Horizontal spacing units can be ems or points (stored as twips). Default: SingleSpacingGap (0)
`column_gap`	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
`row_gap_rule`	The type of vertical spacing between rows of a matrix; Vertical spacing units can be lines or points (stored as twips). Default: SingleSpacingGap (0)
`row_gap`	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

Methods

Method	Description
`join`	Joins a mathematical element and forms a mathematical block
`join`	Joins a mathematical text and forms a mathematical block
`divide`	Creates a fraction with this numerator and specified denominator
`divide`	Creates a fraction with this numerator and specified denominator
`divide`	Creates a fraction of the specified type with this numerator and specified denominator
`divide`	Creates a fraction of the specified type with this numerator and specified denominator
`enclose`	Encloses a math element in parenthesis
`enclose`	Encloses a math element in specified characters such as parenthesis or another characters as framing
`function`	Takes a function of an argument using this instance as the function name
`function`	Takes a function of an argument using this instance as the function name
`as_argument_of_function`	Takes specified function using this instance as the argument
`as_argument_of_function`	Takes specified function using this instance as the argument
`as_argument_of_function`	Takes specified function using this instance as the argument
`as_argument_of_function`	Takes specified function using this instance as the argument and specified additional argument
`as_argument_of_function`	Takes specified function using this instance as the argument and specified additional argument
`set_subscript`	Creates subscript
`set_subscript`	Creates subscript
`set_superscript`	Creates superscript
`set_superscript`	Creates superscript
`set_sub_superscript_on_the_right`	Creates subscript and superscript on the right
`set_sub_superscript_on_the_right`	Creates subscript and superscript on the right
`set_sub_superscript_on_the_left`	Creates subscript and superscript on the left
`set_sub_superscript_on_the_left`	Creates subscript and superscript on the left
`radical`	Specifies the mathematical root of the given degree from the specified argument.
`radical`	Specifies the mathematical root of the given degree from the specified argument.
`set_upper_limit`	Takes upper limit
`set_upper_limit`	Takes upper limit
`set_lower_limit`	Takes lower limit
`set_lower_limit`	Takes lower limit
`nary`	Creates a N-ary operator
`nary`	Creates a N-ary operator
`integral`	Takes the integral
`integral`	Takes the integral
`integral`	Takes the integral without limits
`integral`	Takes the integral
`integral`	Takes the integral
`group`	Places this element in a group using a bottom curly bracket
`group`	Places this element in a group using a grouping character such as bottom curly bracket or another
`to_border_box`	Places this element in a border-box
`to_border_box`	Places this element in a border-box
`to_math_array`	Puts in a vertical array
`accent`	Sets an accent mark (a character on the top of this element)
`overbar`	Sets a bar on the top of this element
`underbar`	Sets a bar on the bottom of this element
`to_box`	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.
`get_column_alignment`	Get the horizontal alignment of the specified column
`set_column_alignment`	Set the horizontal alignment of the specified column
`set_columns_alignment`	Set the horizontal alignment of the specified columns
`insert_row_before`	Insert a new row before the specified one Initially all elements in the new row are None.
`insert_row_after`	Insert a new row after the specified one Initially all elements in the new row are None.
`delete_row`	Deletes the specified row
`insert_column_before`	Insert a new column before the specified one Initially all elements in the new column are None.
`insert_column_after`	Insert a new column after the specified one Initially all elements in the new column are None.
`delete_column`	Deletes the specified column
`get_children`	Get children elements

MathMatrix class

MathMatrix class

Constructors

Properties

Methods

See Also