PowerPoint.FontProperties interface

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.

Represents the font attributes, such as font name, size, and color.

Properties

allCaps

Represents whether the font uses all caps, where lowercase letters are shown as capital letters.

bold

Represents the bold status of font.

color

Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").

doubleStrikethrough

Represents the double-strikethrough status of the font.

italic

Represents the italic status of font.

name

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

size

Represents the font size in points (e.g., 11).

smallCaps

Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.

strikethrough

Represents the strikethrough status of the font.

subscript

Represents the subscript status of the font.

superscript

Represents the superscript status of the font.

underline

Type of underline applied to the font. See PowerPoint.ShapeFontUnderlineStyle for details.

Property Details

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.

Represents whether the font uses all caps, where lowercase letters are shown as capital letters.

allCaps?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

bold

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.

Represents the bold status of font.

bold?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

color

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.

Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").

color?: string | undefined;

Property Value

string | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

doubleStrikethrough

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.

Represents the double-strikethrough status of the font.

doubleStrikethrough?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

italic

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.

Represents the italic status of font.

italic?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

name

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.

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

name?: string | undefined;

Property Value

string | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

size

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.

Represents the font size in points (e.g., 11).

size?: number | undefined;

Property Value

number | undefined

Remarks

[ API set: PowerPointApi 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.

Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.

smallCaps?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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.

Represents the strikethrough status of the font.

strikethrough?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi 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.

Represents the subscript status of the font.

subscript?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi 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.

Represents the superscript status of the font.

superscript?: boolean | undefined;

Property Value

boolean | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

underline

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.

Type of underline applied to the font. See PowerPoint.ShapeFontUnderlineStyle for details.

underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;

Property Value

PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]