aspose.cells

Class TextOptions

Represents the text options.

Property Getters/Setters Summary
functiongetArgbColor()
function
           Gets and sets the color with a 32-bit ARGB value.
functiongetCapsType()
function
           Gets and sets the text caps type. The value of the property is TextCapsType integer constant.
functiongetCharset()
function
setCharset(value)
           Represent the character set.
functiongetColor()
function
setColor(value)
           Gets or sets the com.aspose.cells.Color of the font.
functiongetDoubleSize()
function
           Gets and sets the double size of the font.
functiongetFarEastName()
function
           Gets and sets the FarEast name.
functiongetFill()
Represents the fill format of the text.
functionisBold()
function
setBold(value)
           Gets or sets a value indicating whether the font is bold.
functionisItalic()
function
setItalic(value)
           Gets or sets a value indicating whether the font is italic.
functionisNormalizeHeights()
function
           Indicates whether the normalization of height that is to be applied to the text run.
functionisStrikeout()
function
           Gets or sets a value indicating whether the font is single strikeout.
functionisSubscript()
function
           Gets or sets a value indicating whether the font is subscript.
functionisSuperscript()
function
           Gets or sets a value indicating whether the font is super script.
functiongetKerning()
function
setKerning(value)
           Specifies the minimum font size at which character kerning will occur for this text run.
functiongetLanguageCode()
function
           Gets and sets the user interface language. The value of the property is CountryCode integer constant.
functiongetLatinName()
function
           Gets and sets the latin name.
functiongetName()
function
setName(value)
           Gets and sets the name of the shape.
functiongetOutline()
Represents the outline format of the text.
functiongetSchemeType()
function
           Gets and sets the scheme type of the font. The value of the property is FontSchemeType integer constant.
functiongetScriptOffset()
function
           Gets and sets the script offset,in unit of percentage
functiongetShadow()
Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
functiongetSize()
function
setSize(value)
           Gets or sets the size of the font.
functiongetSpacing()
function
setSpacing(value)
           Specifies the spacing between characters within a text run.
functiongetStrikeType()
function
           Gets the strike type of the text. The value of the property is TextStrikeType integer constant.
functiongetThemeColor()
function
           Gets and sets the theme color.
functiongetUnderline()
function
           Gets or sets the font underline type. The value of the property is FontUnderlineType integer constant.
functiongetUnderlineColor()
function
           Gets or sets the color of underline.
 
Method Summary
functionequals(font)
Checks if two fonts are equals.
functiontoString()
Returns a string represents the current Cell object.
 

    • Property Getters/Setters Detail

      • getName/setName : String 

        function getName() / function setName(value)
        
        Gets and sets the name of the shape.
      • getLanguageCode/setLanguageCode : Number 

        function getLanguageCode() / function setLanguageCode(value)
        
        Gets and sets the user interface language. The value of the property is CountryCode integer constant.
      • getLatinName/setLatinName : String 

        function getLatinName() / function setLatinName(value)
        
        Gets and sets the latin name.
      • getFarEastName/setFarEastName : String 

        function getFarEastName() / function setFarEastName(value)
        
        Gets and sets the FarEast name.
      • getFill : FillFormat 

        function getFill()
        
        Represents the fill format of the text.
      • getOutline : LineFormat 

        function getOutline()
        
        Represents the outline format of the text.
      • getShadow : ShadowEffect 

        function getShadow()
        
        Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
      • getUnderlineColor/setUnderlineColor : CellsColor 

        function getUnderlineColor() / function setUnderlineColor(value)
        
        Gets or sets the color of underline.
      • getKerning/setKerning : Number 

        function getKerning() / function setKerning(value)
        
        Specifies the minimum font size at which character kerning will occur for this text run.
      • getSpacing/setSpacing : Number 

        function getSpacing() / function setSpacing(value)
        
        Specifies the spacing between characters within a text run.
      • getCharset/setCharset : Number 

        function getCharset() / function setCharset(value)
        
        Represent the character set.
      • isItalic/setItalic : boolean 

        function isItalic() / function setItalic(value)
        
        Gets or sets a value indicating whether the font is italic.
      • isBold/setBold : boolean 

        function isBold() / function setBold(value)
        
        Gets or sets a value indicating whether the font is bold.
      • getCapsType/setCapsType : Number 

        function getCapsType() / function setCapsType(value)
        
        Gets and sets the text caps type. The value of the property is TextCapsType integer constant.
      • getStrikeType/setStrikeType : Number 

        function getStrikeType() / function setStrikeType(value)
        
        Gets the strike type of the text. The value of the property is TextStrikeType integer constant.
      • isStrikeout/setStrikeout : boolean 

        function isStrikeout() / function setStrikeout(value)
        
        Gets or sets a value indicating whether the font is single strikeout.
      • getScriptOffset/setScriptOffset : Number 

        function getScriptOffset() / function setScriptOffset(value)
        
        Gets and sets the script offset,in unit of percentage
      • isSuperscript/setSuperscript : boolean 

        function isSuperscript() / function setSuperscript(value)
        
        Gets or sets a value indicating whether the font is super script.
      • isSubscript/setSubscript : boolean 

        function isSubscript() / function setSubscript(value)
        
        Gets or sets a value indicating whether the font is subscript.
      • getUnderline/setUnderline : Number 

        function getUnderline() / function setUnderline(value)
        
        Gets or sets the font underline type. The value of the property is FontUnderlineType integer constant.
      • getDoubleSize/setDoubleSize : Number 

        function getDoubleSize() / function setDoubleSize(value)
        
        Gets and sets the double size of the font.
      • getSize/setSize : Number 

        function getSize() / function setSize(value)
        
        Gets or sets the size of the font.
      • getThemeColor/setThemeColor : ThemeColor 

        function getThemeColor() / function setThemeColor(value)
        
        Gets and sets the theme color. If the font color is not a theme color, NULL will be returned.
      • getColor/setColor : Color 

        function getColor() / function setColor(value)
        
        Gets or sets the com.aspose.cells.Color of the font.
      • getArgbColor/setArgbColor : Number 

        function getArgbColor() / function setArgbColor(value)
        
        Gets and sets the color with a 32-bit ARGB value.
      • isNormalizeHeights/setNormalizeHeights : boolean 

        function isNormalizeHeights() / function setNormalizeHeights(value)
        
        Indicates whether the normalization of height that is to be applied to the text run.
      • getSchemeType/setSchemeType : Number 

        function getSchemeType() / function setSchemeType(value)
        
        Gets and sets the scheme type of the font. The value of the property is FontSchemeType integer constant.
    • Method Detail

      • equals

        function equals(font)
        Checks if two fonts are equals.
        Parameters:
        font: Font - Compared font object.
        Returns:
        True if equal to the compared font object.
      • toString

        function toString()
        Returns a string represents the current Cell object.
        Returns: