Font

Font class

Encapsulates the font object used in a spreadsheet.

class Font;

Example

const { Workbook, Color, SaveFormat } = AsposeCells;

//Instantiating a Workbook object
var workbook = new Workbook();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(0);
//Accessing the "A1" cell from the worksheet
var cell = worksheet.cells.get("A1");
//Adding some value to the "A1" cell
cell.putValue("Hello Aspose!");
var style = cell.getStyle();
var font = style.font;
//Setting the font name to "Times New Roman"
font.setName("Times New Roman");
//Setting font size to 14
font.setSize(14);
//setting font color as Red
font.color = Color.Red;
cell.setStyle(style);
//Saving the Excel file
var uint8Array = workbook.save(SaveFormat.Xlsx);

Properties

Property	Type	Description
charset	number	Represent the character set.
isItalic	boolean	Gets or sets a value indicating whether the font is italic.
isBold	boolean	Gets or sets a value indicating whether the font is bold.
capsType	TextCapsType	Gets and sets the text caps type.
strikeType	TextStrikeType	Gets the strike type of the text.
isStrikeout	boolean	Gets or sets a value indicating whether the font is single strikeout.
scriptOffset	number	Gets and sets the script offset,in unit of percentage
isSuperscript	boolean	Gets or sets a value indicating whether the font is super script.
isSubscript	boolean	Gets or sets a value indicating whether the font is subscript.
underline	FontUnderlineType	Gets or sets the font underline type.
doubleSize	number	Gets and sets the double size of the font.
size	number	Gets or sets the size of the font.
themeColor	ThemeColor	Gets and sets the theme color.
color	Color	Gets or sets the Color of the font.
argbColor	number	Gets and sets the color with a 32-bit ARGB value.
isNormalizeHeights	boolean	Indicates whether the normalization of height that is to be applied to the text run.
schemeType	FontSchemeType	Gets and sets the scheme type of the font.

Methods

Method	Description
equals(Font)	Checks if two fonts are equals.
getName()	Gets or sets the name of the Font.
setName(string)	Gets or sets the name of the Font.
toString()	Returns a string represents the current Cell object.

charset

Represent the character set.

charset : number;

isItalic

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

isItalic : boolean;

isBold

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

isBold : boolean;

capsType

Gets and sets the text caps type.

capsType : TextCapsType;

strikeType

Gets the strike type of the text.

strikeType : TextStrikeType;

isStrikeout

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

isStrikeout : boolean;

scriptOffset

Gets and sets the script offset,in unit of percentage

scriptOffset : number;

isSuperscript

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

isSuperscript : boolean;

isSubscript

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

isSubscript : boolean;

underline

Gets or sets the font underline type.

underline : FontUnderlineType;

doubleSize

Gets and sets the double size of the font.

doubleSize : number;

size

Gets or sets the size of the font.

size : number;

themeColor

Gets and sets the theme color.

themeColor : ThemeColor;

Remarks

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

color

Gets or sets the Color of the font.

color : Color;

argbColor

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

argbColor : number;

isNormalizeHeights

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

isNormalizeHeights : boolean;

schemeType

Gets and sets the scheme type of the font.

schemeType : FontSchemeType;

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.

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.

Example

const { Workbook } = AsposeCells;

var workbook = new Workbook();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(0);
//Accessing the "A1" cell from the worksheet
var cell = worksheet.cells.get("A1");
//Adding some value to the "A1" cell
cell.putValue("Hello Aspose!");
var style = cell.getStyle();
var font = style.font;
font.setName("Times New Roman");
cell.setStyle(style);

toString()

Returns a string represents the current Cell object.

toString() : string;