Edit

Share via

PowerPoint.ShapeFont class

  • Reference
Package:
powerpoint

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

Extends
OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.4 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

Properties

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 Caps attribute.

  • null: Returned if 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.
context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
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's 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 whether the text in the TextRange is set to use the Superscript attribute. The possible values are as follows:

  • true: All the text has the Superscript attribute.

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

  • null: Returned if some, but not all, of the text has the Superscript attribute.
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.

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.ShapeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.ShapeFontData) that contains shallow copies of any loaded child properties from the original object.

Property Details

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 Caps attribute.

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

allCaps: boolean | null;

Property Value

boolean | null

Remarks

[ API set: PowerPointApi 1.8 ]

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 | null;

Property Value

boolean | null

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

Property Value

string | null

Remarks

[ API set: PowerPointApi 1.4 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

PowerPoint.RequestContext

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.

doubleStrikethrough: boolean | null;

Property Value

boolean | null

Remarks

[ API set: PowerPointApi 1.8 ]

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 | null;

Property Value

boolean | null

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

name: string | null;

Property Value

string | null

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: number | null;

Property Value

number | null

Remarks

[ API set: PowerPointApi 1.4 ]

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.

smallCaps: boolean | null;

Property Value

boolean | null

Remarks

[ API set: PowerPointApi 1.8 ]

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.

strikethrough: boolean | null;

Property Value

boolean | null

Remarks

[ API set: PowerPointApi 1.8 ]

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.

subscript: boolean | null;

Property Value

boolean | null

Remarks

[ API set: PowerPointApi 1.8 ]

superscript

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

  • true: All the text has the Superscript attribute.

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

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

superscript: boolean | null;

Property Value

boolean | null

Remarks

[ API set: PowerPointApi 1.8 ]

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: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;

Property Value

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

Remarks

[ API set: PowerPointApi 1.4 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;

Parameters

options
PowerPoint.Interfaces.ShapeFontLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.ShapeFont

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): PowerPoint.ShapeFont;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

PowerPoint.ShapeFont

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeFont;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

PowerPoint.ShapeFont

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.ShapeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.ShapeFontData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.ShapeFontData;

Returns

PowerPoint.Interfaces.ShapeFontData