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.

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

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 ]

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 ]

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 ]