aspose.cells

Class TextParagraph

Represents the text paragraph setting.

Property Getters/Setters Summary
functiongetAlignmentType()
function
           Gets and sets the text horizontal alignment type of the paragraph. The value of the property is TextAlignmentType integer constant.
functiongetBullet()
Gets the bullet.
functiongetChildren()
Gets all text runs in this paragraph. If this paragraph is empty, return paragraph itself.
functiongetDefaultTabSize()
function
           Gets and sets the default size for a tab character within this paragraph.
functiongetFirstLineIndent()
function
           Specifies the indent size that will be applied to the first line of text in the paragraph.
functiongetFont()
Returns the font of this object.
functiongetFontAlignType()
function
           Determines where vertically on a line of text the actual words are positioned. This deals with vertical placement of the characters with respect to the baselines. The value of the property is TextFontAlignType integer constant.
functionisEastAsianLineBreak()
function
           Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
functionisHangingPunctuation()
function
           Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
functionisLatinLineBreak()
function
           Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
functiongetLeftMargin()
function
           Specifies the left margin of the paragraph.
functiongetLength()
Gets the length of the characters.
functiongetLineSpace()
function
           Gets and sets the amount of vertical white space that will be used within a paragraph.
functiongetLineSpaceSizeType()
function
           Gets and sets the amount of vertical white space that will be used within a paragraph. The value of the property is LineSpaceSizeType integer constant.
functiongetRightMargin()
function
           Specifies the right margin of the paragraph.
functiongetSpaceAfter()
function
           Gets and sets the amount of vertical white space that will be present after a paragraph.
functiongetSpaceAfterSizeType()
function
           Gets and sets the amount of vertical white space that will be present after a paragraph. The value of the property is LineSpaceSizeType integer constant.
functiongetSpaceBefore()
function
           Gets and sets the amount of vertical white space that will be present before a paragraph.
functiongetSpaceBeforeSizeType()
function
           Gets and sets the amount of vertical white space that will be present before a paragraph. The value of the property is LineSpaceSizeType integer constant.
functiongetStartIndex()
Gets the start index of the characters.
functiongetStops()
Gets tab stop list.
functiongetTextOptions()
Returns the text options.
functiongetType()
Gets the type of text node. The value of the property is TextNodeType integer constant.
 
Method Summary
functionsetWordArtStyle(style)
Sets the preset WordArt style.
 

    • Property Getters/Setters Detail

      • getBullet : Bullet 

        function getBullet()
        
        Gets the bullet.
      • getType : Number 

        function getType()
        
        Gets the type of text node. The value of the property is TextNodeType integer constant.
      • getLineSpaceSizeType/setLineSpaceSizeType : Number 

        function getLineSpaceSizeType() / function setLineSpaceSizeType(value)
        
        Gets and sets the amount of vertical white space that will be used within a paragraph. The value of the property is LineSpaceSizeType integer constant.
      • getLineSpace/setLineSpace : Number 

        function getLineSpace() / function setLineSpace(value)
        
        Gets and sets the amount of vertical white space that will be used within a paragraph.
      • getSpaceAfterSizeType/setSpaceAfterSizeType : Number 

        function getSpaceAfterSizeType() / function setSpaceAfterSizeType(value)
        
        Gets and sets the amount of vertical white space that will be present after a paragraph. The value of the property is LineSpaceSizeType integer constant.
      • getSpaceAfter/setSpaceAfter : Number 

        function getSpaceAfter() / function setSpaceAfter(value)
        
        Gets and sets the amount of vertical white space that will be present after a paragraph.
      • getSpaceBeforeSizeType/setSpaceBeforeSizeType : Number 

        function getSpaceBeforeSizeType() / function setSpaceBeforeSizeType(value)
        
        Gets and sets the amount of vertical white space that will be present before a paragraph. The value of the property is LineSpaceSizeType integer constant.
      • getSpaceBefore/setSpaceBefore : Number 

        function getSpaceBefore() / function setSpaceBefore(value)
        
        Gets and sets the amount of vertical white space that will be present before a paragraph.
      • isLatinLineBreak/setLatinLineBreak : boolean 

        function isLatinLineBreak() / function setLatinLineBreak(value)
        
        Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
      • isEastAsianLineBreak/setEastAsianLineBreak : boolean 

        function isEastAsianLineBreak() / function setEastAsianLineBreak(value)
        
        Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
      • isHangingPunctuation/setHangingPunctuation : boolean 

        function isHangingPunctuation() / function setHangingPunctuation(value)
        
        Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
      • getRightMargin/setRightMargin : Number 

        function getRightMargin() / function setRightMargin(value)
        
        Specifies the right margin of the paragraph.
      • getLeftMargin/setLeftMargin : Number 

        function getLeftMargin() / function setLeftMargin(value)
        
        Specifies the left margin of the paragraph.
      • getFirstLineIndent/setFirstLineIndent : Number 

        function getFirstLineIndent() / function setFirstLineIndent(value)
        
        Specifies the indent size that will be applied to the first line of text in the paragraph.
      • getFontAlignType/setFontAlignType : Number 

        function getFontAlignType() / function setFontAlignType(value)
        
        Determines where vertically on a line of text the actual words are positioned. This deals with vertical placement of the characters with respect to the baselines. The value of the property is TextFontAlignType integer constant.
      • getAlignmentType/setAlignmentType : Number 

        function getAlignmentType() / function setAlignmentType(value)
        
        Gets and sets the text horizontal alignment type of the paragraph. The value of the property is TextAlignmentType integer constant.
      • getDefaultTabSize/setDefaultTabSize : Number 

        function getDefaultTabSize() / function setDefaultTabSize(value)
        
        Gets and sets the default size for a tab character within this paragraph.
      • getChildren : FontSetting[] 

        function getChildren()
        
        Gets all text runs in this paragraph. If this paragraph is empty, return paragraph itself.
      • getStartIndex : Number 

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

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

        function getFont()
        
        Returns the font of this object.
      • getTextOptions : TextOptions 

        function getTextOptions()
        
        Returns the text options.
    • Method Detail

      • setWordArtStyle

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