asposecells.api

Class GroupCharacterEquationNode

This class specifies the Group-Character function, consisting of a character drawn above or below text, often with the purpose of visually grouping items.

Property Getters/Setters Summary
methodgetChrType()
method
setChrType(value)
           Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant.
methodgetEquationType()
Get the equation type of the current node The value of the property is EquationNodeType integer constant.
methodgetFont()
Returns the font of this object.
methodgetGroupChr()
method
           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.
methodgetLength()
Gets the length of the characters.
methodgetParentNode()
method
           Specifies the parent node of the current node
methodgetPosition()
method
           This attribute specifies the position of the character in the object The value of the property is EquationCharacterPositionType integer constant.
methodgetStartIndex()
Gets the start index of the characters.
methodgetTextOptions()
Returns the text options.
methodgetType()
Represents the type of the node. The value of the property is TextNodeType integer constant.
methodgetVertJc()
method
setVertJc(value)
           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.
 
Method Summary
methodaddChild(node)
Inserts the specified node at the end of the current node's list of child nodes.
methodaddChild(equationType)
Insert a node of the specified type at the end of the child node list of the current node.
methodequals(obj)
Determine whether the current equation node is equal to the specified node
methodgetChild(index)
Returns the node at the specified index among the children of the current node.
methodinsertAfter(equationType)
Inserts the specified node after the current node.
methodinsertBefore(equationType)
Inserts the specified node before the current node.
methodinsertChild(index, equationType)
Inserts a node of the specified type at the specified index position in the current node's child node list.
methodremove()
Removes itself from the parent.
methodremoveAllChildren()
Removes all the child nodes of the current node.
methodremoveChild(node)
Removes the specified node from the current node's children.
methodremoveChild(index)
Removes the node at the specified index from the current node's children.
methodsetWordArtStyle(style)
Sets the preset WordArt style.
 

    • Property Getters/Setters Detail

      • getGroupChr/setGroupChr : String 

        String getGroupChr() / setGroupChr(value)
        
        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.
      • getChrType/setChrType : int 

        int getChrType() / setChrType(value)
        
        Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant.
      • getPosition/setPosition : int 

        int getPosition() / setPosition(value)
        
        This attribute specifies the position of the character in the object The value of the property is EquationCharacterPositionType integer constant.
      • getVertJc/setVertJc : int 

        int getVertJc() / setVertJc(value)
        
        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.
      • getParentNode/setParentNode : EquationNode 

        EquationNode getParentNode() / setParentNode(value)
        
        Specifies the parent node of the current node
      • getType : int 

        int getType()
        
        Represents the type of the node. The value of the property is TextNodeType integer constant.
      • getEquationType : int 

        int getEquationType()
        
        Get the equation type of the current node The value of the property is EquationNodeType integer constant.
      • getStartIndex : int 

        int getStartIndex()
        
        Gets the start index of the characters.
      • getLength : int 

        int getLength()
        
        Gets the length of the characters.
      • getFont : Font 

        Font getFont()
        
        Returns the font of this object.
    • Method Detail

      • equals

        boolean equals(obj)
        Determine whether the current equation node is equal to the specified node
        Parameters:
        obj: Object - The specified node
        Returns:
      • addChild

        EquationNode addChild(equationType)
        Insert a node of the specified type at the end of the child node list of the current node.
        Parameters:
        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

         addChild(node)
        Inserts the specified node at the end of the current node's list of child nodes.
        Parameters:
        node: EquationNode - The specified node
      • insertChild

        EquationNode insertChild(index, equationType)
        Inserts a node of the specified type at the specified index position in the current node's child node list.
        Parameters:
        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

        EquationNode insertAfter(equationType)
        Inserts the specified node after the current node.
        Parameters:
        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

        EquationNode insertBefore(equationType)
        Inserts the specified node before the current node.
        Parameters:
        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

        EquationNode getChild(index)
        Returns the node at the specified index among the children of the current node.
        Parameters:
        index: int - Index of the node
        Returns:
        Returns the corresponding node if the specified node exists, otherwise returns null.
      • remove

         remove()
        Removes itself from the parent.
      • removeChild

         removeChild(node)
        Removes the specified node from the current node's children.
        Parameters:
        node: EquationNode - Node to be deleted.
      • removeChild

         removeChild(index)
        Removes the node at the specified index from the current node's children.
        Parameters:
        index: int - Index of the node
      • removeAllChildren

         removeAllChildren()
        Removes all the child nodes of the current node.
      • setWordArtStyle

         setWordArtStyle(style)
        Sets the preset WordArt style. Only for the text of shape/chart.
        Parameters:
        style: int - A PresetWordArtStyle value. The preset WordArt style.