Word.Interfaces.FontLoadOptions interface

Represents a font.

[ API set: WordApi 1.1 ]

Properties

$all
bold

Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false.

[ API set: WordApi 1.1 ]

color

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

[ API set: WordApi 1.1 ]

doubleStrikeThrough

Gets or sets a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false.

[ API set: WordApi 1.1 ]

highlightColor

Gets or sets 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.

[ API set: WordApi 1.1 ]

italic

Gets or sets a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false.

[ API set: WordApi 1.1 ]

name

Gets or sets a value that represents the name of the font.

[ API set: WordApi 1.1 ]

size

Gets or sets a value that represents the font size in points.

[ API set: WordApi 1.1 ]

strikeThrough

Gets or sets a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false.

[ API set: WordApi 1.1 ]

subscript

Gets or sets a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false.

[ API set: WordApi 1.1 ]

superscript

Gets or sets a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false.

[ API set: WordApi 1.1 ]

underline

Gets or sets a value that indicates the font's underline type. 'None' if the font is not underlined.

[ API set: WordApi 1.1 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

bold

Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false.

[ API set: WordApi 1.1 ]

bold?: boolean;

Property Value

boolean

color

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

[ API set: WordApi 1.1 ]

color?: boolean;

Property Value

boolean

doubleStrikeThrough

Gets or sets a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false.

[ API set: WordApi 1.1 ]

doubleStrikeThrough?: boolean;

Property Value

boolean

highlightColor

Gets or sets 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.

[ API set: WordApi 1.1 ]

highlightColor?: boolean;

Property Value

boolean

italic

Gets or sets a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false.

[ API set: WordApi 1.1 ]

italic?: boolean;

Property Value

boolean

name

Gets or sets a value that represents the name of the font.

[ API set: WordApi 1.1 ]

name?: boolean;

Property Value

boolean

size

Gets or sets a value that represents the font size in points.

[ API set: WordApi 1.1 ]

size?: boolean;

Property Value

boolean

strikeThrough

Gets or sets a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false.

[ API set: WordApi 1.1 ]

strikeThrough?: boolean;

Property Value

boolean

subscript

Gets or sets a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false.

[ API set: WordApi 1.1 ]

subscript?: boolean;

Property Value

boolean

superscript

Gets or sets a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false.

[ API set: WordApi 1.1 ]

superscript?: boolean;

Property Value

boolean

underline

Gets or sets a value that indicates the font's underline type. 'None' if the font is not underlined.

[ API set: WordApi 1.1 ]

underline?: boolean;

Property Value

boolean