IMathBox class

IMathBox class

Specifies the logical boxing (packaging) of mathematical element. For example, a boxed object can 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. For example, the “==” operator should be boxed to prevent line breaks.

The IMathBox type exposes the following members:

Properties

PropertyDescription
baseBase argument
operator_emulatorOperator Emulator.
When true, the box and its contents behave as a single operator and inherit the properties of an operator.
This means, for example, that the character can serve as a point for a line break and can be aligned to other operators.
Operator Emulators are often used when one or more glyphs combine to form an operator, such as ‘==’.
Default value: false
no_breakNo break.
This property specifies the “unbreakable” property on the object box. When true, no line breaks can occur within the box.
This can be important for operator emulators that consist of more than one binary operator.
When this element is not specified, breaks can occur inside box.
Default: true
differentialDifferential.
When true, the box acts as a differential (e.g., 𝑑𝑥 in an integrand), and receives the appropriate
horizontal spacing for the mathematical differential.
Default: false
alignment_pointWhen true, this operator emulator serves as an alignment point; that is,
designated alignment points in other equations can be aligned with it.
Default: false
explicit_breakExplicit break specifies whether there is a line break at the start of the Box object,
such that the line wraps at the start of the box object.
Specifies the number of the operator on the previous line of mathematical text which shall
be used as the alignment point for the current line of mathematical text
possible values: 1..255
Default: 0 (no explicit break)

Methods

MethodDescription
join
join
divide
divide
divide
divide
enclose
enclose
function
function
as_argument_of_function
as_argument_of_function
as_argument_of_function
as_argument_of_function
as_argument_of_function
set_subscript
set_subscript
set_superscript
set_superscript
set_sub_superscript_on_the_right
set_sub_superscript_on_the_right
set_sub_superscript_on_the_left
set_sub_superscript_on_the_left
radical
radical
set_upper_limit
set_upper_limit
set_lower_limit
set_lower_limit
nary
nary
integral
integral
integral
integral
integral
group
group
to_border_box
to_border_box
get_children
to_math_array
accent
overbar
underbar
to_box

See Also