asposecells.api

Class NaryEquationNode

This class specifies an n-ary operator equation consisting of an n-ary operator, a base (or operand), and optional upper and lower bounds.

Property Getters/Setters Summary
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.
methodisHideSubscript()
method
           Whether to display the lower bound
methodisHideSuperscript()
method
           Whether to display the upper bound
methodgetLength()
Gets the length of the characters.
methodgetLimitLocation()
method
           This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator. The value of the property is EquationLimitLocationType integer constant.
methodgetNaryGrow()
method
           This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height.
methodgetNaryOperator()
method
           an n-ary operator.e.g "∑". It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. Use this property setting if you cannot find the character you need in a known type.
methodgetNaryOperatorType()
method
           an n-ary operator.e.g "∑" The value of the property is EquationMathematicalOperatorType integer constant.
methodgetParentNode()
method
           Specifies the parent node of the current node
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.
 
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

      • isHideSubscript/setHideSubscript : boolean 

        boolean isHideSubscript() / setHideSubscript(value)
        
        Whether to display the lower bound
      • isHideSuperscript/setHideSuperscript : boolean 

        boolean isHideSuperscript() / setHideSuperscript(value)
        
        Whether to display the upper bound
      • getLimitLocation/setLimitLocation : int 

        int getLimitLocation() / setLimitLocation(value)
        
        This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator. The value of the property is EquationLimitLocationType integer constant.
      • getNaryOperator/setNaryOperator : String 

        String getNaryOperator() / setNaryOperator(value)
        
        an n-ary operator.e.g "∑". It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. 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.
      • getNaryOperatorType/setNaryOperatorType : int 

        int getNaryOperatorType() / setNaryOperatorType(value)
        
        an n-ary operator.e.g "∑" The value of the property is EquationMathematicalOperatorType integer constant.
      • getNaryGrow/setNaryGrow : boolean 

        boolean getNaryGrow() / setNaryGrow(value)
        
        This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height.
      • 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.