MathPhantom

MathPhantom class

Represents a phantom math object (<m:phant>) that affects the layout of its child element without necessarily displaying it. A phantom can hide its base expression while preserving its width, height, or depth to align formulas or reserve space. Visibility and geometry behavior are controlled by properties such as Show, ZeroWid, ZeroAsc, ZeroDesc, and Transp.

MathPhantom

Name	Description
MathPhantom(MathFunction)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathFunction	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathBorderBox)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathBorderBox	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathBox)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathBox	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathSubscriptElement)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathSubscriptElement	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathRightSubSuperscriptElement)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathRightSubSuperscriptElement	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathAccent)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathAccent	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathNaryOperator)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathNaryOperator	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathSuperscriptElement)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathSuperscriptElement	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathDelimiter)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathDelimiter	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathLeftSubSuperscriptElement)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathLeftSubSuperscriptElement	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathLimit)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathLimit	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathPhantom)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathPhantom	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathBlock)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathBlock	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(BaseScript)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	BaseScript	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathElementBase)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathElementBase	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathMatrix)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathMatrix	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathRadical)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathRadical	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathGroupingCharacter)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathGroupingCharacter	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathFraction)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathFraction	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathArray)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathArray	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathBar)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathBar	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

MathPhantom

Name	Description
MathPhantom(MathematicalText)	Initializes a new instance of the MathPhantom class using the specified base math element.

Parameters:

Name	Type	Description
element	MathematicalText	The base IMathElement whose visibility and layout will be controlled by the phantom. This element defines the content that may be hidden or shown, while still affecting the geometric alignment of the surrounding math. The phantom element is used to reserve or suppress the visual space of its base expression without necessarily displaying it. It corresponds to the OMML element {@code <m:phant>}.

Returns: MathPhantom

getBase

Name	Description
getBase ()	Base argument

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

getChildren

Name	Description
getChildren ()	Get children elements

getShow

Name	Description
getShow ()	Gets or sets a value indicating whether the base element is displayed. When false, the base element is hidden but may still occupy space depending on other phantom settings. Corresponds to the OMML attribute m:show.

Returns: boolean

getTransp

Name	Description
getTransp ()	Gets or sets a value indicating whether the phantom is transparent for class-based spacing rules. When true, operators and symbols inside the phantom still affect mathematical spacing around the phantom (as if visible). When false, class-based spacing is ignored. Corresponds to the OMML attribute m:transp.

Returns: boolean

getZeroAsc

Name	Description
getZeroAsc ()	Gets or sets a value indicating whether the ascent (height above baseline) of the base element should be treated as zero. When true, the phantom does not raise the baseline of the surrounding math line. Corresponds to the OMML attribute m:zeroAsc.

Returns: boolean

getZeroDesc

Name	Description
getZeroDesc ()	Gets or sets a value indicating whether the descent (depth below baseline) of the base element should be treated as zero. When true, the phantom does not lower the baseline of the surrounding math line. Corresponds to the OMML attribute m:zeroDesc.

Returns: boolean

getZeroWidth

Name	Description
getZeroWidth ()	Gets or sets a value indicating whether the width of the base element should be treated as zero. When true, the phantom does not reserve horizontal space for its base. Corresponds to the OMML attribute m:zeroWid.

Returns: boolean

setShow

Name	Description
setShow (boolean)	Gets or sets a value indicating whether the base element is displayed. When false, the base element is hidden but may still occupy space depending on other phantom settings. Corresponds to the OMML attribute m:show.

setTransp

Name	Description
setTransp (boolean)	Gets or sets a value indicating whether the phantom is transparent for class-based spacing rules. When true, operators and symbols inside the phantom still affect mathematical spacing around the phantom (as if visible). When false, class-based spacing is ignored. Corresponds to the OMML attribute m:transp.

setZeroAsc

Name	Description
setZeroAsc (boolean)	Gets or sets a value indicating whether the ascent (height above baseline) of the base element should be treated as zero. When true, the phantom does not raise the baseline of the surrounding math line. Corresponds to the OMML attribute m:zeroAsc.

setZeroDesc

Name	Description
setZeroDesc (boolean)	Gets or sets a value indicating whether the descent (depth below baseline) of the base element should be treated as zero. When true, the phantom does not lower the baseline of the surrounding math line. Corresponds to the OMML attribute m:zeroDesc.

setZeroWidth

Name	Description
setZeroWidth (boolean)	Gets or sets a value indicating whether the width of the base element should be treated as zero. When true, the phantom does not reserve horizontal space for its base. Corresponds to the OMML attribute m:zeroWid.