TextOptions

TextOptions class

Represents the text options.

class TextOptions extends Font;

Constructors

Name	Description
constructor(Font)	Constructs from a parent object convertible to this.

Methods

Method	Description
getName()	Gets and sets the name of the shape.
setName(string)	Gets and sets the name of the shape.
getLanguageCode()	Gets and sets the user interface language.
setLanguageCode(CountryCode)	Gets and sets the user interface language.
getLatinName()	Gets and sets the latin name.
setLatinName(string)	Gets and sets the latin name.
getFarEastName()	Gets and sets the FarEast name.
setFarEastName(string)	Gets and sets the FarEast name.
getFill()	Represents the fill format of the text.
getOutline()	Represents the outline format of the text.
getShadow()	Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
getUnderlineColor()	Gets or sets the color of underline.
setUnderlineColor(CellsColor)	Gets or sets the color of underline.
getKerning()	Specifies the minimum font size at which character kerning will occur for this text run.
setKerning(number)	Specifies the minimum font size at which character kerning will occur for this text run.
getSpacing()	Specifies the spacing between characters within a text run.
setSpacing(number)	Specifies the spacing between characters within a text run.
getCharset()	Represent the character set.
setCharset(number)	Represent the character set.
isItalic()	Gets or sets a value indicating whether the font is italic.
setIsItalic(boolean)	Gets or sets a value indicating whether the font is italic.
isBold()	Gets or sets a value indicating whether the font is bold.
setIsBold(boolean)	Gets or sets a value indicating whether the font is bold.
getCapsType()	Gets and sets the text caps type.
setCapsType(TextCapsType)	Gets and sets the text caps type.
getStrikeType()	Gets the strike type of the text.
setStrikeType(TextStrikeType)	Gets the strike type of the text.
isStrikeout()	Gets or sets a value indicating whether the font is single strikeout.
setIsStrikeout(boolean)	Gets or sets a value indicating whether the font is single strikeout.
getScriptOffset()	Gets and sets the script offset,in unit of percentage
setScriptOffset(number)	Gets and sets the script offset,in unit of percentage
isSuperscript()	Gets or sets a value indicating whether the font is super script.
setIsSuperscript(boolean)	Gets or sets a value indicating whether the font is super script.
isSubscript()	Gets or sets a value indicating whether the font is subscript.
setIsSubscript(boolean)	Gets or sets a value indicating whether the font is subscript.
getUnderline()	Gets or sets the font underline type.
setUnderline(FontUnderlineType)	Gets or sets the font underline type.
getDoubleSize()	Gets and sets the double size of the font.
setDoubleSize(number)	Gets and sets the double size of the font.
getSize()	Gets or sets the size of the font.
setSize(number)	Gets or sets the size of the font.
getThemeColor()	Gets and sets the theme color.
setThemeColor(ThemeColor)	Gets and sets the theme color.
getColor()	Gets or sets the System.Drawing.Color of the font.
setColor(Color)	Gets or sets the System.Drawing.Color of the font.
getArgbColor()	Gets and sets the color with a 32-bit ARGB value.
setArgbColor(number)	Gets and sets the color with a 32-bit ARGB value.
isNormalizeHeights()	Indicates whether the normalization of height that is to be applied to the text run.
setIsNormalizeHeights(boolean)	Indicates whether the normalization of height that is to be applied to the text run.
getSchemeType()	Gets and sets the scheme type of the font.
setSchemeType(FontSchemeType)	Gets and sets the scheme type of the font.
equals(Font)	Checks if two fonts are equals.
toString()	Returns a string represents the current Cell object.

constructor(Font)

Constructs from a parent object convertible to this.

constructor(obj: Font);

Parameters:

Parameter	Type	Description
obj	Font	The parent object.

getName()

Gets and sets the name of the shape.

getName() : string;

setName(string)

Gets and sets the name of the shape.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getLanguageCode()

Gets and sets the user interface language.

getLanguageCode() : CountryCode;

Returns

CountryCode

setLanguageCode(CountryCode)

Gets and sets the user interface language.

setLanguageCode(value: CountryCode) : void;

Parameters:

Parameter	Type	Description
value	CountryCode	The value to set.

getLatinName()

Gets and sets the latin name.

getLatinName() : string;

setLatinName(string)

Gets and sets the latin name.

setLatinName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getFarEastName()

Gets and sets the FarEast name.

getFarEastName() : string;

setFarEastName(string)

Gets and sets the FarEast name.

setFarEastName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getFill()

Represents the fill format of the text.

getFill() : FillFormat;

Returns

FillFormat

getOutline()

Represents the outline format of the text.

getOutline() : LineFormat;

Returns

LineFormat

getShadow()

Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.

getShadow() : ShadowEffect;

Returns

ShadowEffect

getUnderlineColor()

Gets or sets the color of underline.

getUnderlineColor() : CellsColor;

Returns

CellsColor

setUnderlineColor(CellsColor)

Gets or sets the color of underline.

setUnderlineColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getKerning()

Specifies the minimum font size at which character kerning will occur for this text run.

getKerning() : number;

setKerning(number)

Specifies the minimum font size at which character kerning will occur for this text run.

setKerning(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSpacing()

Specifies the spacing between characters within a text run.

getSpacing() : number;

setSpacing(number)

Specifies the spacing between characters within a text run.

setSpacing(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getCharset()

Represent the character set.

getCharset() : number;

setCharset(number)

Represent the character set.

setCharset(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isItalic()

Gets or sets a value indicating whether the font is italic.

isItalic() : boolean;

setIsItalic(boolean)

Gets or sets a value indicating whether the font is italic.

setIsItalic(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isBold()

Gets or sets a value indicating whether the font is bold.

isBold() : boolean;

setIsBold(boolean)

Gets or sets a value indicating whether the font is bold.

setIsBold(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCapsType()

Gets and sets the text caps type.

getCapsType() : TextCapsType;

Returns

TextCapsType

setCapsType(TextCapsType)

Gets and sets the text caps type.

setCapsType(value: TextCapsType) : void;

Parameters:

Parameter	Type	Description
value	TextCapsType	The value to set.

getStrikeType()

Gets the strike type of the text.

getStrikeType() : TextStrikeType;

Returns

TextStrikeType

setStrikeType(TextStrikeType)

Gets the strike type of the text.

setStrikeType(value: TextStrikeType) : void;

Parameters:

Parameter	Type	Description
value	TextStrikeType	The value to set.

isStrikeout()

Gets or sets a value indicating whether the font is single strikeout.

isStrikeout() : boolean;

setIsStrikeout(boolean)

Gets or sets a value indicating whether the font is single strikeout.

setIsStrikeout(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getScriptOffset()

Gets and sets the script offset,in unit of percentage

getScriptOffset() : number;

setScriptOffset(number)

Gets and sets the script offset,in unit of percentage

setScriptOffset(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isSuperscript()

Gets or sets a value indicating whether the font is super script.

isSuperscript() : boolean;

setIsSuperscript(boolean)

Gets or sets a value indicating whether the font is super script.

setIsSuperscript(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isSubscript()

Gets or sets a value indicating whether the font is subscript.

isSubscript() : boolean;

setIsSubscript(boolean)

Gets or sets a value indicating whether the font is subscript.

setIsSubscript(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getUnderline()

Gets or sets the font underline type.

getUnderline() : FontUnderlineType;

Returns

FontUnderlineType

setUnderline(FontUnderlineType)

Gets or sets the font underline type.

setUnderline(value: FontUnderlineType) : void;

Parameters:

Parameter	Type	Description
value	FontUnderlineType	The value to set.

getDoubleSize()

Gets and sets the double size of the font.

getDoubleSize() : number;

setDoubleSize(number)

Gets and sets the double size of the font.

setDoubleSize(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSize()

Gets or sets the size of the font.

getSize() : number;

setSize(number)

Gets or sets the size of the font.

setSize(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getThemeColor()

Gets and sets the theme color.

getThemeColor() : ThemeColor;

Returns

ThemeColor

Remarks

If the font color is not a theme color, NULL will be returned.

setThemeColor(ThemeColor)

Gets and sets the theme color.

setThemeColor(value: ThemeColor) : void;

Parameters:

Parameter	Type	Description
value	ThemeColor	The value to set.

Remarks

If the font color is not a theme color, NULL will be returned.

getColor()

Gets or sets the System.Drawing.Color of the font.

getColor() : Color;

Returns

Color

setColor(Color)

Gets or sets the System.Drawing.Color of the font.

setColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getArgbColor()

Gets and sets the color with a 32-bit ARGB value.

getArgbColor() : number;

setArgbColor(number)

Gets and sets the color with a 32-bit ARGB value.

setArgbColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isNormalizeHeights()

Indicates whether the normalization of height that is to be applied to the text run.

isNormalizeHeights() : boolean;

setIsNormalizeHeights(boolean)

Indicates whether the normalization of height that is to be applied to the text run.

setIsNormalizeHeights(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSchemeType()

Gets and sets the scheme type of the font.

getSchemeType() : FontSchemeType;

Returns

FontSchemeType

setSchemeType(FontSchemeType)

Gets and sets the scheme type of the font.

setSchemeType(value: FontSchemeType) : void;

Parameters:

Parameter	Type	Description
value	FontSchemeType	The value to set.

equals(Font)

Checks if two fonts are equals.

equals(font: Font) : boolean;

Parameters:

Parameter	Type	Description
font	Font	Compared font object.

Returns

True if equal to the compared font object.

toString()

Returns a string represents the current Cell object.

toString() : string;