Word.Interfaces.FontLoadOptions interface

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

Specifies whether the font is bold. true if the font is formatted as bold, otherwise, false.

bold?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name.

color?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies whether the font has a double strikethrough. true if the font is formatted as double strikethrough text, otherwise, false.

doubleStrikeThrough?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies whether the font is tagged as hidden. true if the font is formatted as hidden text, otherwise, false.

hidden?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.2 ]

Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.

highlightColor?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies whether the font is italicized. true if the font is italicized, otherwise, false.

italic?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies the name of the font.

name?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies the font size in points.

size?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies whether the font has a strikethrough. true if the font is formatted as strikethrough text, otherwise, false.

strikeThrough?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies whether the font is a subscript. true if the font is formatted as subscript, otherwise, false.

subscript?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies whether the font is a superscript. true if the font is formatted as superscript, otherwise, false.

superscript?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

Specifies the font's underline type. none if the font isn't underlined.

underline?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]