Word.Interfaces.FontUpdateData interface

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

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies a value that indicates 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 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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

color?: string;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies whether contextual alternates are enabled for the font.

contextualAlternates?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

diacriticColor?: string;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

disableCharacterSpaceGrid?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApi 1.1 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

fill?: Word.Interfaces.FillFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

glow?: Word.Interfaces.GlowFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

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?: string;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

italic?: boolean;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

kerning?: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the ligature setting for the Font object.

ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

line?: Word.Interfaces.LineFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies a value that represents the name of the font.

name?: string;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

nameAscii?: string;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

nameBidirectional?: string;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the East Asian font name.

nameFarEast?: string;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

nameOther?: string;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the number form setting for an OpenType font.

numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the number spacing setting for the font.

numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

position?: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

reflection?: Word.Interfaces.ReflectionFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the scaling percentage applied to the font.

scaling?: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies a value that represents the font size in points.

size?: number;

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

sizeBidirectional?: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the spacing between characters.

spacing?: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApi 1.1 ]

Specifies the stylistic set for the font.

stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApi 1.1 ]

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

Remarks

[ API set: WordApi 1.1 ]

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

textColor?: Word.Interfaces.ColorFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

textShadow?: Word.Interfaces.ShadowFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

Property Value

Remarks

[ API set: WordApi 1.1 ]

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

underlineColor?: string;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]