asposediagram.api

Class TextBlock

Contains elements that specify the alignment, margins, and default tab stop positions of text in a shape's text block.

Property Getters/Setters Summary
methodgetBottomMargin()
method
           Determines the distance between the bottom border of the text block and the last line of text it contains. The default is 4 pt. This value is independent of the scale of the drawing. If the drawing is scaled, the bottom margin remains the same.
methodgetDefaultTabStop()
method
           Specifies the interval of the default tab stops in a text block.
methodgetDel()
method
setDel(value)
           A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
methodgetLeftMargin()
method
           Specifies the distance between the left border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the left margin remains the same.
methodgetRightMargin()
method
           Specifies the distance between the right border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the right margin remains the same.
methodgetTextBkgnd()
method
           Specifies the text background color for a shape.
methodgetTextBkgndTrans()
method
           Specifies the transparency level for the background color of a shape's text block, from 0 (completely opaque) to 1 (completely transparent).
methodgetTextDirection()
method
           Specifies the direction of the characters in a text block.
methodgetTopMargin()
method
           Specifies the distance between the top border of the text block and the first line of text it contains.
methodgetVerticalAlign()
method
           Specifies the vertical alignment of text within the text block.
 
Method Summary
methoddeepClone()
Creates deep copy of this instance.
 

    • Property Getters/Setters Detail

      • getDel/setDel : int 

        int getDel() / setDel(value)
        
        A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
      • getLeftMargin/setLeftMargin : DoubleValue 

        DoubleValue getLeftMargin() / setLeftMargin(value)
        
        Specifies the distance between the left border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the left margin remains the same.
      • getRightMargin/setRightMargin : DoubleValue 

        DoubleValue getRightMargin() / setRightMargin(value)
        
        Specifies the distance between the right border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the right margin remains the same.
      • getTopMargin/setTopMargin : DoubleValue 

        DoubleValue getTopMargin() / setTopMargin(value)
        
        Specifies the distance between the top border of the text block and the first line of text it contains.
      • getBottomMargin/setBottomMargin : DoubleValue 

        DoubleValue getBottomMargin() / setBottomMargin(value)
        
        Determines the distance between the bottom border of the text block and the last line of text it contains. The default is 4 pt. This value is independent of the scale of the drawing. If the drawing is scaled, the bottom margin remains the same.
      • getVerticalAlign/setVerticalAlign : VerticalAlign 

        VerticalAlign getVerticalAlign() / setVerticalAlign(value)
        
        Specifies the vertical alignment of text within the text block.
      • getTextBkgnd/setTextBkgnd : ColorValue 

        ColorValue getTextBkgnd() / setTextBkgnd(value)
        
        Specifies the text background color for a shape.
      • getDefaultTabStop/setDefaultTabStop : DoubleValue 

        DoubleValue getDefaultTabStop() / setDefaultTabStop(value)
        
        Specifies the interval of the default tab stops in a text block.
      • getTextDirection/setTextDirection : TextDirection 

        TextDirection getTextDirection() / setTextDirection(value)
        
        Specifies the direction of the characters in a text block.
      • getTextBkgndTrans/setTextBkgndTrans : DoubleValue 

        DoubleValue getTextBkgndTrans() / setTextBkgndTrans(value)
        
        Specifies the transparency level for the background color of a shape's text block, from 0 (completely opaque) to 1 (completely transparent).
    • Method Detail

      • deepClone

        Object deepClone()
        Creates deep copy of this instance.
        Returns: