Edit

Excel.Interfaces.RangeFontLoadOptions interface

  • Reference
Package:
excel

This object represents the font attributes (font name, font size, color, etc.) for an object.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
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

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

bold

Represents the bold status of the font.

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).

color?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

italic

Specifies the italic status of the font.

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.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

size

Font size.

size?: boolean;

Property Value

boolean

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.

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.

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.

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.

tintAndShade?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

underline

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

underline?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]