Font

Font class

Encapsulates the font object used in a spreadsheet.

class Font;

Methods

Method	Description
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.
getName()	Gets or sets the name of the Font.
setName(string)	Gets or sets the name of the Font.

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;

getName()

Gets or sets the name of the Font.

getName() : string;

setName(string)

Gets or sets the name of the Font.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.