Excel.ShapeFont class
Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
- Extends
Remarks
Properties
| bold | Represents the bold status of font. Returns |
| color | HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns |
| 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 |
| name | Represents 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. |
| size | Represents font size in points (e.g., 11). Returns |
| strikethrough | Specifies the strikethrough status of font. A |
| subscript | Specifies the subscript status of font. Returns |
| superscript | Specifies the superscript status of font. Returns |
| tint |
Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A |
| underline | Type of underline applied to the font. Returns |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| 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 |
Property Details
bold
Represents the bold status of font. Returns null if the TextRange includes both bold and non-bold text fragments.
bold: boolean;Property Value
boolean
Remarks
color
HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns null if the TextRange includes text fragments with different colors.
color: string;Property Value
string
Remarks
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.
italic: boolean;Property Value
boolean
Remarks
name
Represents 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.
name: string;Property Value
string
Remarks
size
Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
size: number;Property Value
number
Remarks
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 the strikethrough status of font. A null value indicates that the entire range doesn't have a uniform strikethrough setting.
strikethrough: boolean;Property Value
boolean
Remarks
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 the subscript status of font. Returns true if all the fonts of the range are subscript. Returns false if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns null otherwise.
subscript: boolean;Property Value
boolean
Remarks
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 font. Returns true if all the fonts of the range are superscript. Returns false if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns null otherwise.
superscript: boolean;Property Value
boolean
Remarks
tintAndShade
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 a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the entire range doesn't have a uniform font tintAndShade setting.
tintAndShade: number;Property Value
number
Remarks
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.
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"
Remarks
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
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
- Excel.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
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's 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;