Edit

Share via

Excel.Interfaces.ShapeFontLoadOptions interface

Package:
excel

Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.

Remarks

[ API set: ExcelApi 1.9 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
bold

Represents the bold status of font. Returns null if the TextRange includes both bold and non-bold text fragments.
color

HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns null if the TextRange includes text fragments with different colors.
italic

Represents the italic status of font. Returns null if the TextRange includes both italic and non-italic text fragments.
name

Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
size

Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
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. Returns null if the TextRange includes text fragments with different underline styles. See Excel.ShapeFontUnderlineStyle for details.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

bold

Represents the bold status of font. Returns null if the TextRange includes both bold and non-bold text fragments.

bold?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

color

HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns null if the TextRange includes text fragments with different colors.

color?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

italic

Represents the italic status of font. Returns null if the TextRange includes both italic and non-italic text fragments.

italic?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

name

Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

size

Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.

size?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

strikethrough

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

subscript

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

superscript

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

tintAndShade

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

underline

Type of underline applied to the font. Returns null if the TextRange includes text fragments with different underline styles. See Excel.ShapeFontUnderlineStyle for details.

underline?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]