Excel.ShapeFont class

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

[ API set: ExcelApi 1.9 ]

Extends
OfficeExtension.ClientObject

Properties

bold

Represents the bold status of font. Returns null the TextRange includes both bold and non-bold text fragments.

[ API set: ExcelApi 1.9 ]

color

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

[ API set: ExcelApi 1.9 ]

context

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

italic

Represents the italic status of font. Returns null if the TextRange includes both italic and non-italic text fragments.

[ API set: ExcelApi 1.9 ]

name

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

[ API set: ExcelApi 1.9 ]

size

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

[ API set: ExcelApi 1.9 ]

underline

Type of underline applied to the font. Returns null if the TextRange includes text fragments with different underline styles. See Excel.ShapeFontUnderlineStyle for details.

[ API set: ExcelApi 1.9 ]

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.

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

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 is passed to it.) Whereas the original Excel.ShapeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeFontData) that contains shallow copies of any loaded child properties from the original object.

Property Details

bold

Represents the bold status of font. Returns null the TextRange includes both bold and non-bold text fragments.

[ API set: ExcelApi 1.9 ]

bold: boolean;

Property Value

boolean

color

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

[ API set: ExcelApi 1.9 ]

color: string;

Property Value

string

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

italic

Represents the italic status of font. Returns null if the TextRange includes both italic and non-italic text fragments.

[ API set: ExcelApi 1.9 ]

italic: boolean;

Property Value

boolean

name

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

[ API set: ExcelApi 1.9 ]

name: string;

Property Value

string

size

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

[ API set: ExcelApi 1.9 ]

size: number;

Property Value

number

underline

Type of underline applied to the font. Returns null if the TextRange includes text fragments with different underline styles. See Excel.ShapeFontUnderlineStyle for details.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

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?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;

Parameters

options
Excel.Interfaces.ShapeFontLoadOptions

Provides options for which properties of the object to load.

Returns

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[]): Excel.ShapeFont;

Parameters

propertyNames
string | string[]

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

Returns

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;
        }): Excel.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

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.ShapeFontUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.ShapeFont): void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ShapeFont): void;

Parameters

properties
Excel.ShapeFont

Returns

void

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 is passed to it.) Whereas the original Excel.ShapeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeFontData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ShapeFontData;

Returns