Edit

Share via

Excel.ConditionalRangeFont class

Package:
excel

This object represents the font attributes (font style, color, etc.) for an object.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.6 ]

Properties

bold

Specifies if the font is bold.
color

HTML color code representation of the text color (e.g., #FF0000 represents Red).
context

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

Specifies if the font is italic.
strikethrough

Specifies the strikethrough status of the font.
underline

The type of underline applied to the font. See Excel.ConditionalRangeFontUnderlineStyle for details.

Methods

clear()

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

Property Details

bold

Specifies if the font is bold.

bold: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

color

HTML color code representation of the text color (e.g., #FF0000 represents Red).

color: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.6 ]

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

Excel.RequestContext

italic

Specifies if the font is italic.

italic: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

strikethrough

Specifies the strikethrough status of the font.

strikethrough: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

underline

The type of underline applied to the font. See Excel.ConditionalRangeFontUnderlineStyle for details.

underline: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double";

Property Value

Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"

Remarks

[ API set: ExcelApi 1.6 ]

Method Details

clear()

Resets the font formats.

clear(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.6 ]

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

Parameters

options
Excel.Interfaces.ConditionalRangeFontLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ConditionalRangeFont

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.ConditionalRangeFont;

Parameters

propertyNames

string | string[]

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

Returns

Excel.ConditionalRangeFont

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.ConditionalRangeFont;

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

Excel.ConditionalRangeFont

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.ConditionalRangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Excel.Interfaces.ConditionalRangeFontUpdateData

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.ConditionalRangeFont): void;

Parameters

properties
Excel.ConditionalRangeFont

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

toJSON(): Excel.Interfaces.ConditionalRangeFontData;

Returns

Excel.Interfaces.ConditionalRangeFontData