Edit

Share via

PowerPoint.Interfaces.ShapeFontLoadOptions interface

  • Reference
Package:
powerpoint

Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.

Remarks

[ API set: PowerPointApi 1.4 ]

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 text in the TextRange is set to use the All Caps attribute 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 Capsattribute.

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

Specifies whether the text in the TextRange is set to bold. 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 HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns null if the TextRange contains text fragments with different colors.
doubleStrikethrough

Specifies whether the text in the TextRange is set to use the Double strikethrough attribute. The possible values are as follows:

  • true: All the text has the Double strikethrough attribute.

  • false: None of the text has the Double strikethrough attribute.

  • null: Returned if some, but not all, of the text has the Double strikethrough attribute.
italic

Specifies whether the text in the TextRange is set to italic. 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.
name

Specifies 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 is the Latin font name. Returns null if the TextRange contains text fragments with different font names.
size

Specifies the font size in points (e.g., 11). Returns null if the TextRange contains text fragments with different font sizes.
smallCaps

Specifies whether the text in the TextRange is set to use the Small Caps attribute 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.
strikethrough

Specifies whether the text in the TextRange is set to use the Strikethrough attribute. The possible values are as follows:

  • true: All the text has the Strikethrough attribute.

  • false: None of the text has the Strikethrough attribute.

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

Specifies whether the text in the TextRange is set to use the Subscript attribute. The possible values are as follows:

  • true: All the text has the Subscript attribute.

  • false: None of the text has the Subscript attribute.

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

Specifies the superscript status of the font. Returns null if the TextRange contains both superscript and non-superscript text fragments.
underline

Specifies the type of underline applied to the font. Returns null if the TextRange contains text fragments with different underline styles. See PowerPoint.ShapeFontUnderlineStyle for details.

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 text in the TextRange is set to use the All Caps attribute 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 Capsattribute.

  • null: Some, but not all, of the text has the All Caps attribute.

allCaps?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

bold

Specifies whether the text in the TextRange is set to bold. 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.

bold?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

color

Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns null if the TextRange contains text fragments with different colors.

color?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

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.

Specifies whether the text in the TextRange is set to use the Double strikethrough attribute. The possible values are as follows:

  • true: All the text has the Double strikethrough attribute.

  • false: None of the text has the Double strikethrough attribute.

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

doubleStrikethrough?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

italic

Specifies whether the text in the TextRange is set to italic. 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.

italic?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

name

Specifies 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 is the Latin font name. Returns null if the TextRange contains text fragments with different font names.

name?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

size

Specifies the font size in points (e.g., 11). Returns null if the TextRange contains text fragments with different font sizes.

size?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

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 text in the TextRange is set to use the Small Caps attribute 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: 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.

Specifies whether the text in the TextRange is set to use the Strikethrough attribute. The possible values are as follows:

  • true: All the text has the Strikethrough attribute.

  • false: None of the text has the Strikethrough attribute.

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

strikethrough?: boolean;

Property Value

boolean

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.

Specifies whether the text in the TextRange is set to use the Subscript attribute. The possible values are as follows:

  • true: All the text has the Subscript attribute.

  • false: None of the text has the Subscript attribute.

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

subscript?: boolean;

Property Value

boolean

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.

Specifies the superscript status of the font. Returns null if the TextRange contains both superscript and non-superscript text fragments.

superscript?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

underline

Specifies the type of underline applied to the font. Returns null if the TextRange contains text fragments with different underline styles. See PowerPoint.ShapeFontUnderlineStyle for details.

underline?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]