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

NameDescription
MathDelimiter(MathematicalText)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathematicalTextThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathSubscriptElement)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathSubscriptElementThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathRadical)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathRadicalThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(BaseScript)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementBaseScriptThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathBox)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathBoxThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathNaryOperator)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathNaryOperatorThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathFunction)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathFunctionThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathLeftSubSuperscriptElement)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathLeftSubSuperscriptElementThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathRightSubSuperscriptElement)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathRightSubSuperscriptElementThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathFraction)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathFractionThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathBar)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathBarThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathBorderBox)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathBorderBoxThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathBlock)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathBlockThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathLimit)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathLimitThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathElementBase)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathElementBaseThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathMatrix)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathMatrixThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathSuperscriptElement)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathSuperscriptElementThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathGroupingCharacter)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathGroupingCharacterThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathDelimiter)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathDelimiterThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathAccent)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathAccentThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

MathDelimiter

NameDescription
MathDelimiter(MathArray)Initializes MathDelimiter with the specified element as single base argument

Parameters:

NameTypeDescription
elementMathArrayThe base element to which the delimiter is applied. Can be null.

Returns: MathDelimiter

Error

ErrorCondition
InvalidOperationExceptionThrows then element is a container for another elements, such as MathBlock. In this case, you need to call a different constructor with IEnumerable argument.

delimit

NameDescription
delimit(char)Delimits arguments using the specified delimiter character

Parameters:

NameTypeDescription
separatorCharacterchardelimiter character

Returns: MathDelimiter


enclose

NameDescription
enclose(char, char)Encloses a math element in specified characters such as parenthesis or another characters as framing

Parameters:

NameTypeDescription
beginningCharactercharBeginning character (usually left bracket)
endingCharactercharEnding character (usually right bracket)

Returns: MathDelimiter


getArguments

NameDescription
getArguments()One or more mathematical elements separated by delimiter characters

Returns: MathBlock


getBeginningCharacter

NameDescription
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

NameDescription
getChildren()Get children elements

Returns: MathematicalText, MathSubscriptElement, MathRadical, BaseScript, MathBox, MathNaryOperator, MathFunction, MathLeftSubSuperscriptElement, MathRightSubSuperscriptElement, MathFraction, MathBar, MathBorderBox, MathBlock, MathLimit, MathElementBase, MathMatrix, MathSuperscriptElement, MathGroupingCharacter, MathDelimiter, MathAccent, MathArray


getDelimiterShape

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
getSeparatorCharacter()Delimiter Separator Character specifies the character that separates arguments in the delimiter object. The default: '

Returns: char


setBeginningCharacter

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
setSeparatorCharacter(char)Delimiter Separator Character specifies the character that separates arguments in the delimiter object. The default: '