BoxEquationNode
BoxEquationNode class
This class specifies the box function, which is used to group components of an equation.
Properties
| Name | Type | Description |
|---|---|---|
| ParentNode | EquationNode | Specifies the parent node of the current node |
| Type | Number | Represents the type of the node. The value of the property is TextNodeType integer constant. |
| EquationType | Number | Get the equation type of the current node The value of the property is EquationNodeType integer constant. |
| StartIndex | Number | Gets the start index of the characters. |
| Length | Number | Gets the length of the characters. |
| Font | Font | Returns the font of this object. |
| TextOptions | TextOptions | Returns the text options. |
Methods
| Name | Description |
|---|---|
| equals | Determine whether the current equation node is equal to the specified node |
| toLaTeX | |
| toMathML | |
| addChild | Insert a node of the specified type at the end of the child node list of the current node. |
| insertChild | Inserts a node of the specified type at the specified index position in the current node’s child node list. |
| insertAfter | Inserts the specified node after the current node. |
| insertBefore | Inserts the specified node before the current node. |
| getChild | Returns the node at the specified index among the children of the current node. |
| remove | Removes itself from the parent. |
| removeChild | Removes the specified node from the current node’s children. |
| removeAllChildren | Removes all the child nodes of the current node. |
| setWordArtStyle | Sets the preset WordArt style. |
Only for the text of shape/chart. |
BoxEquationNode.ParentNode property
Specifies the parent node of the current node
Type: EquationNode
BoxEquationNode.Type property
Represents the type of the node. The value of the property is TextNodeType integer constant.
Type: Number
BoxEquationNode.EquationType property
Get the equation type of the current node The value of the property is EquationNodeType integer constant.
Type: Number
BoxEquationNode.StartIndex property
Gets the start index of the characters.
Type: Number
BoxEquationNode.Length property
Gets the length of the characters.
Type: Number
BoxEquationNode.Font property
Returns the font of this object.
Type: Font
BoxEquationNode.TextOptions property
Returns the text options.
Type: TextOptions
equals(obj)
Determine whether the current equation node is equal to the specified node
| Parameter | Type | Description |
|---|---|---|
| obj | Object | The specified node |
toLaTeX()
toMathML()
addChild(equationType) (1 of 2)
Insert a node of the specified type at the end of the child node list of the current node.
| Parameter | Type | Description |
|---|---|---|
| equationType | Number | A EquationNodeType value. Types of Equation Nodes |
Returns: If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
addChild(node) (2 of 2)
Inserts the specified node at the end of the current node’s list of child nodes.
| Parameter | Type | Description |
|---|---|---|
| node | EquationNode | The specified node |
insertChild(index, equationType)
Inserts a node of the specified type at the specified index position in the current node’s child node list.
| Parameter | Type | Description |
|---|---|---|
| index | Number | index value |
| equationType | Number | A EquationNodeType value. Types of Equation Nodes |
Returns: If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
insertAfter(equationType)
Inserts the specified node after the current node.
| Parameter | Type | Description |
|---|---|---|
| equationType | Number | A EquationNodeType value. Types of Equation Nodes |
Returns: If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
insertBefore(equationType)
Inserts the specified node before the current node.
| Parameter | Type | Description |
|---|---|---|
| equationType | Number | A EquationNodeType value. Types of Equation Nodes |
Returns: If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
getChild(index)
Returns the node at the specified index among the children of the current node.
| Parameter | Type | Description |
|---|---|---|
| index | Number | Index of the node |
Returns: Returns the corresponding node if the specified node exists, otherwise returns null.
remove()
Removes itself from the parent.
removeChild(node) (1 of 2)
Removes the specified node from the current node’s children.
| Parameter | Type | Description |
|---|---|---|
| node | EquationNode | Node to be deleted. |
removeChild(index) (2 of 2)
Removes the node at the specified index from the current node’s children.
| Parameter | Type | Description |
|---|---|---|
| index | Number | Index of the node |
removeAllChildren()
Removes all the child nodes of the current node.
setWordArtStyle(style)
Sets the preset WordArt style.
Only for the text of shape/chart.
| Parameter | Type | Description |
|---|---|---|
| style | Number | A PresetWordArtStyle value. The preset WordArt style. |