GroupCharacterEquationNode
GroupCharacterEquationNode class
This class specifies the Group-Character function, consisting of a character drawn above or below text, often with the purpose of visually grouping items.
Properties
| Name | Type | Description |
|---|---|---|
| GroupChr | String | Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. Use thi |
| ChrType | int | Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant |
| Position | int | This attribute specifies the position of the character in the object The value of the property is EquationCharacterPosit |
| VertJc | int | This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifi |
| ParentNode | EquationNode | Specifies the parent node of the current node |
| Type | int | Represents the type of the node. The value of the property is TextNodeType integer constant. |
| EquationType | int | Get the equation type of the current node The value of the property is EquationNodeType integer constant. |
| StartIndex | int | Gets the start index of the characters. |
| Length | int | 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. |
GroupCharacterEquationNode.GroupChr property
Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. Use this property setting if you cannot find the character you need in a known type. It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted.
Type: String
GroupCharacterEquationNode.ChrType property
Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant.
Type: int
GroupCharacterEquationNode.Position property
This attribute specifies the position of the character in the object The value of the property is EquationCharacterPositionType integer constant.
Type: int
GroupCharacterEquationNode.VertJc property
This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline. The value of the property is EquationCharacterPositionType integer constant.
Type: int
GroupCharacterEquationNode.ParentNode property
Specifies the parent node of the current node
Type: EquationNode
GroupCharacterEquationNode.Type property
Represents the type of the node. The value of the property is TextNodeType integer constant.
Type: int
GroupCharacterEquationNode.EquationType property
Get the equation type of the current node The value of the property is EquationNodeType integer constant.
Type: int
GroupCharacterEquationNode.StartIndex property
Gets the start index of the characters.
Type: int
GroupCharacterEquationNode.Length property
Gets the length of the characters.
Type: int
GroupCharacterEquationNode.Font property
Returns the font of this object.
Type: Font
GroupCharacterEquationNode.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 | int | 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 | int | index value |
| equationType | int | 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 | int | 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 | int | 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 | int | 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 | int | 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 | int | A PresetWordArtStyle value. The preset WordArt style. |