Edit

Share via

Word.Interfaces.FontLoadOptions interface

Package:
word

Represents a font.

Remarks

[ API set: WordApi 1.1 ]

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

Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows:

  • true: All the text has the All Caps attribute.

  • false: None of the text has the All Caps attribute.

  • null: Returned if some, but not all, of the text has the All Caps attribute.
bold

Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false.
boldBidirectional

Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows:

  • true: All the text is bold.

  • false: None of the text is bold.

  • null: Returned if some, but not all, of the text is bold.
color

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

Specifies a ColorIndex value that represents the color for the font.
colorIndexBidirectional

Specifies the color for the Font object in a right-to-left language document.
contextualAlternates

Specifies whether contextual alternates are enabled for the font.
diacriticColor

Specifies the color to be used for diacritics for the Font object. You can provide the value in the '#RRGGBB' format.
disableCharacterSpaceGrid

Specifies whether Microsoft Word ignores the number of characters per line for the corresponding Font object.
doubleStrikeThrough

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

Specifies whether the font is formatted as embossed. The possible values are as follows:

  • true: All the text is embossed.

  • false: None of the text is embossed.

  • null: Returned if some, but not all, of the text is embossed.
emphasisMark

Specifies an EmphasisMark value that represents the emphasis mark for a character or designated character string.
engrave

Specifies whether the font is formatted as engraved. The possible values are as follows:

  • true: All the text is engraved.

  • false: None of the text is engraved.

  • null: Returned if some, but not all, of the text is engraved.
fill

Returns a FillFormat object that contains fill formatting properties for the font used by the range of text.
glow

Returns a GlowFormat object that represents the glow formatting for the font used by the range of text.
hidden

Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
highlightColor

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

Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false.
italicBidirectional

Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows:

  • true: All the text is italicized.

  • false: None of the text is italicized.

  • null: Returned if some, but not all, of the text is italicized.
kerning

Specifies the minimum font size for which Microsoft Word will adjust kerning automatically.
ligature

Specifies the ligature setting for the Font object.
line

Returns a LineFormat object that specifies the formatting for a line.
name

Specifies a value that represents the name of the font.
nameAscii

Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127).
nameBidirectional

Specifies the font name in a right-to-left language document.
nameFarEast

Specifies the East Asian font name.
nameOther

Specifies the font used for characters with codes from 128 through 255.
numberForm

Specifies the number form setting for an OpenType font.
numberSpacing

Specifies the number spacing setting for the font.
outline

Specifies if the font is formatted as outlined. The possible values are as follows:

  • true: All the text is outlined.

  • false: None of the text is outlined.

  • null: Returned if some, but not all, of the text is outlined.
position

Specifies the position of text (in points) relative to the base line.
reflection

Returns a ReflectionFormat object that represents the reflection formatting for a shape.
scaling

Specifies the scaling percentage applied to the font.
shadow

Specifies if the font is formatted as shadowed. The possible values are as follows:

  • true: All the text is shadowed.

  • false: None of the text is shadowed.

  • null: Returned if some, but not all, of the text is shadowed.
size

Specifies a value that represents the font size in points.
sizeBidirectional

Specifies the font size in points for right-to-left text.
smallCaps

Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows:

  • true: All the text has the Small Caps attribute.

  • false: None of the text has the Small Caps attribute.

  • null: Returned if some, but not all, of the text has the Small Caps attribute.
spacing

Specifies the spacing between characters.
strikeThrough

Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false.
stylisticSet

Specifies the stylistic set for the font.
subscript

Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false.
superscript

Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false.
textColor

Returns a ColorFormat object that represents the color for the font.
textShadow

Returns a ShadowFormat object that specifies the shadow formatting for the font.
threeDimensionalFormat

Returns a ThreeDimensionalFormat object that contains 3-dimensional (3D) effect formatting properties for the font.
underline

Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
underlineColor

Specifies the color of the underline for the Font object. You can provide the value in the '#RRGGBB' format.

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

allCaps

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 whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows:

  • true: All the text has the All Caps attribute.

  • false: None of the text has the All Caps attribute.

  • null: Returned if some, but not all, of the text has the All Caps attribute.

allCaps?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

bold

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

bold?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

boldBidirectional

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 whether the font is formatted as bold in a right-to-left language document. The possible values are as follows:

  • true: All the text is bold.

  • false: None of the text is bold.

  • null: Returned if some, but not all, of the text is bold.

boldBidirectional?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

color

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

color?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

colorIndex

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 ColorIndex value that represents the color for the font.

colorIndex?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

colorIndexBidirectional

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 color for the Font object in a right-to-left language document.

colorIndexBidirectional?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

contextualAlternates

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 whether contextual alternates are enabled for the font.

contextualAlternates?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

diacriticColor

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 color to be used for diacritics for the Font object. You can provide the value in the '#RRGGBB' format.

diacriticColor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

disableCharacterSpaceGrid

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 whether Microsoft Word ignores the number of characters per line for the corresponding Font object.

disableCharacterSpaceGrid?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

doubleStrikeThrough

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

doubleStrikeThrough?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

emboss

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 whether the font is formatted as embossed. The possible values are as follows:

  • true: All the text is embossed.

  • false: None of the text is embossed.

  • null: Returned if some, but not all, of the text is embossed.

emboss?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

emphasisMark

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 an EmphasisMark value that represents the emphasis mark for a character or designated character string.

emphasisMark?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

engrave

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 whether the font is formatted as engraved. The possible values are as follows:

  • true: All the text is engraved.

  • false: None of the text is engraved.

  • null: Returned if some, but not all, of the text is engraved.

engrave?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

fill

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.

Returns a FillFormat object that contains fill formatting properties for the font used by the range of text.

fill?: Word.Interfaces.FillFormatLoadOptions;

Property Value

Word.Interfaces.FillFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

glow

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.

Returns a GlowFormat object that represents the glow formatting for the font used by the range of text.

glow?: Word.Interfaces.GlowFormatLoadOptions;

Property Value

Word.Interfaces.GlowFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

hidden

Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.

hidden?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

highlightColor

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

boolean

Remarks

[ API set: WordApi 1.1 ]

italic

Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false.

italic?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

italicBidirectional

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 whether the font is italicized in a right-to-left language document. The possible values are as follows:

  • true: All the text is italicized.

  • false: None of the text is italicized.

  • null: Returned if some, but not all, of the text is italicized.

italicBidirectional?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

kerning

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 minimum font size for which Microsoft Word will adjust kerning automatically.

kerning?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

ligature

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 ligature setting for the Font object.

ligature?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

line

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.

Returns a LineFormat object that specifies the formatting for a line.

line?: Word.Interfaces.LineFormatLoadOptions;

Property Value

Word.Interfaces.LineFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

name

Specifies a value that represents the name of the font.

name?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

nameAscii

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 font used for Latin text (characters with character codes from 0 (zero) through 127).

nameAscii?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

nameBidirectional

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 font name in a right-to-left language document.

nameBidirectional?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

nameFarEast

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 East Asian font name.

nameFarEast?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

nameOther

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 font used for characters with codes from 128 through 255.

nameOther?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

numberForm

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 number form setting for an OpenType font.

numberForm?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

numberSpacing

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 number spacing setting for the font.

numberSpacing?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

outline

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 if the font is formatted as outlined. The possible values are as follows:

  • true: All the text is outlined.

  • false: None of the text is outlined.

  • null: Returned if some, but not all, of the text is outlined.

outline?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

position

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 position of text (in points) relative to the base line.

position?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

reflection

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.

Returns a ReflectionFormat object that represents the reflection formatting for a shape.

reflection?: Word.Interfaces.ReflectionFormatLoadOptions;

Property Value

Word.Interfaces.ReflectionFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

scaling

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 scaling percentage applied to the font.

scaling?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

shadow

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 if the font is formatted as shadowed. The possible values are as follows:

  • true: All the text is shadowed.

  • false: None of the text is shadowed.

  • null: Returned if some, but not all, of the text is shadowed.

shadow?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

size

Specifies a value that represents the font size in points.

size?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

sizeBidirectional

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 font size in points for right-to-left text.

sizeBidirectional?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

smallCaps

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 whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows:

  • true: All the text has the Small Caps attribute.

  • false: None of the text has the Small Caps attribute.

  • null: Returned if some, but not all, of the text has the Small Caps attribute.

smallCaps?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

spacing

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 spacing between characters.

spacing?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

strikeThrough

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

strikeThrough?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

stylisticSet

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 stylistic set for the font.

stylisticSet?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

subscript

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

subscript?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

superscript

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

superscript?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

textColor

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.

Returns a ColorFormat object that represents the color for the font.

textColor?: Word.Interfaces.ColorFormatLoadOptions;

Property Value

Word.Interfaces.ColorFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textShadow

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.

Returns a ShadowFormat object that specifies the shadow formatting for the font.

textShadow?: Word.Interfaces.ShadowFormatLoadOptions;

Property Value

Word.Interfaces.ShadowFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

threeDimensionalFormat

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.

Returns a ThreeDimensionalFormat object that contains 3-dimensional (3D) effect formatting properties for the font.

threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions;

Property Value

Word.Interfaces.ThreeDimensionalFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

underline

Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.

underline?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

underlineColor

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 color of the underline for the Font object. You can provide the value in the '#RRGGBB' format.

underlineColor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]