Edit

Share via

Excel.Interfaces.RangeFontData interface

  • Reference
Package:
excel

An interface describing the data returned by calling rangeFont.toJSON().

Properties

bold

Represents the bold status of the font.
color

HTML color code representation of the text color (e.g., #FF0000 represents Red).
italic

Specifies the italic status of the font.
name

Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters.
size

Font size.
strikethrough

Specifies the strikethrough status of font. A null value indicates that the entire range doesn't have a uniform strikethrough setting.
subscript

Specifies the subscript status of font. Returns true if all the fonts of the range are subscript. Returns false if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns null otherwise.
superscript

Specifies the superscript status of font. Returns true if all the fonts of the range are superscript. Returns false if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns null otherwise.
tintAndShade

Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the entire range doesn't have a uniform font tintAndShade setting.
underline

Type of underline applied to the font. See Excel.RangeUnderlineStyle for details.

Property Details

bold

Represents the bold status of the font.

TypeScript 
bold?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

color

HTML color code representation of the text color (e.g., #FF0000 represents Red).

TypeScript 
color?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

italic

Specifies the italic status of the font.

TypeScript 
italic?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

name

Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters.

TypeScript 
name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

size

Font size.

TypeScript 
size?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

strikethrough

Specifies the strikethrough status of font. A null value indicates that the entire range doesn't have a uniform strikethrough setting.

TypeScript 
strikethrough?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

subscript

Specifies the subscript status of font. Returns true if all the fonts of the range are subscript. Returns false if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns null otherwise.

TypeScript 
subscript?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

superscript

Specifies the superscript status of font. Returns true if all the fonts of the range are superscript. Returns false if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns null otherwise.

TypeScript 
superscript?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

tintAndShade

Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the entire range doesn't have a uniform font tintAndShade setting.

TypeScript 
tintAndShade?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

underline

Type of underline applied to the font. See Excel.RangeUnderlineStyle for details.

TypeScript 
underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";

Property Value

Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"

Remarks

[ API set: ExcelApi 1.1 ]