MathDelimiter
MathDelimiter class
Specifies the delimiter object, consisting of opening and closing characters (such as parentheses,
braces, brackets, and vertical bars), and one or more mathematical elements inside, separated by a specified character.
Examples: (?2); [?2|?2]
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathSubscriptElement) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathSubscriptElement | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathDelimiter) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathDelimiter | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathBar) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathBar | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathArray) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathArray | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathGroupingCharacter) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathGroupingCharacter | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathBlock) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathBlock | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathFraction) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathFraction | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathNaryOperator) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathNaryOperator | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathRadical) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathRadical | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathElementBase) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathElementBase | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathFunction) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathFunction | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathematicalText) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathematicalText | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(BaseScript) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | BaseScript | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathBox) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathBox | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathSuperscriptElement) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathSuperscriptElement | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathLimit) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathLimit | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
Parameters:
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathMatrix) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathMatrix | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
Parameters:
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathBorderBox) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathBorderBox | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
MathDelimiter
| Name | Description |
|---|
| MathDelimiter(MathAccent) | Initializes MathDelimiter with the specified element as single base argument |
Parameters:
| Name | Type | Description |
|---|
| element | MathAccent | The base element to which the delimiter is applied. Can be null. |
Returns:
MathDelimiter
Error
| Error | Condition |
|---|
| InvalidOperationException | Throws then element is a container for another elements, such as MathBlock. In this case, you need to call a different function with IEnumerable argument. |
delimit
| Name | Description |
|---|
| delimit (char) | Delimits arguments using the specified delimiter character |
Parameters:
| Name | Type | Description |
|---|
| separatorCharacter | char | delimiter character |
Returns:
MathDelimiter
enclose
| Name | Description |
|---|
| enclose (char, char) | Encloses a math element in specified characters such as parenthesis or another characters as framing |
Parameters:
| Name | Type | Description |
|---|
| beginningCharacter | char | Beginning character (usually left bracket) |
| endingCharacter | char | Ending character (usually right bracket) |
Returns:
MathDelimiter
getArguments
| Name | Description |
|---|
| getArguments () | One or more mathematical elements separated by delimiter characters |
Returns:
MathBlock
getBeginningCharacter
| Name | Description |
|---|
| getBeginningCharacter () | Delimiter Beginning Character specifies the beginning, or opening, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default: ‘(’. |
Returns:
char
getChildren
| Name | Description |
|---|
| getChildren () | Get children elements |
Returns:
MathSubscriptElement, MathDelimiter, MathBar, MathArray, MathGroupingCharacter, MathBlock, MathFraction, MathNaryOperator, MathRadical, MathElementBase, MathFunction, MathematicalText, BaseScript, MathBox, MathSuperscriptElement, MathLimit, MathLeftSubSuperscriptElement, MathMatrix, MathRightSubSuperscriptElement, MathBorderBox, MathAccent
getDelimiterShape
| Name | Description |
|---|
| getDelimiterShape () | Specifies the shape of delimiters in the delimiter object. When is MathDelimiterShape.Centered, delimiters are centered around the math axis of the mathematical text and still be made to fit the entire height of their contents. When is MathDelimiterShape.Match, their height and shape are altered to exactly match their contents. |
Returns:
int
getEndingCharacter
| Name | Description |
|---|
| getEndingCharacter () | Delimiter Ending Character specifies the ending, or closing, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default: ‘)’. |
Returns:
char
getGrowToMatchOperandHeight
| Name | Description |
|---|
| getGrowToMatchOperandHeight () | Specifies the growth of BeginningCharacter, SeparatorCharacter, EndingCharacter When true, the delimiters grows vertically to match its operand height. The default value is true |
Returns:
boolean
getSeparatorCharacter
| Name | Description |
|---|
| getSeparatorCharacter () | Delimiter Separator Character specifies the character that separates arguments in the delimiter object. The default: ' |
Returns:
char
setBeginningCharacter
| Name | Description |
|---|
| setBeginningCharacter (char) | Delimiter Beginning Character specifies the beginning, or opening, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default: ‘(’. |
setDelimiterShape
| Name | Description |
|---|
| setDelimiterShape (int) | Specifies the shape of delimiters in the delimiter object. When is MathDelimiterShape.Centered, delimiters are centered around the math axis of the mathematical text and still be made to fit the entire height of their contents. When is MathDelimiterShape.Match, their height and shape are altered to exactly match their contents. |
setEndingCharacter
| Name | Description |
|---|
| setEndingCharacter (char) | Delimiter Ending Character specifies the ending, or closing, delimiter character. Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces. The default: ‘)’. |
setGrowToMatchOperandHeight
| Name | Description |
|---|
| setGrowToMatchOperandHeight (boolean) | Specifies the growth of BeginningCharacter, SeparatorCharacter, EndingCharacter When true, the delimiters grows vertically to match its operand height. The default value is true |
setSeparatorCharacter
| Name | Description |
|---|
| setSeparatorCharacter (char) | Delimiter Separator Character specifies the character that separates arguments in the delimiter object. The default: ' |