Excel.ConditionalRangeFormat class

Package:

excel

A format object encapsulating the conditional formats range's font, fill, borders, and other properties.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.6 ]

Properties

borders	Collection of border objects that apply to the overall conditional format range.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
fill	Returns the fill object defined on the overall conditional format range.
font	Returns the font object defined on the overall conditional format range.
numberFormat	Represents Excel's number format code for the given range. For more information about Excel number formatting, see Number format codes. Cleared if null is passed in.

Methods

clearFormat()	Remove the format properties from a conditional format rule. This creates a rule with no format settings.
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.ConditionalRangeFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalRangeFormatData) that contains shallow copies of any loaded child properties from the original object.

Property Details

borders

Collection of border objects that apply to the overall conditional format range.

readonly borders: Excel.ConditionalRangeBorderCollection;

Property Value

Excel.ConditionalRangeBorderCollection

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

fill

Returns the fill object defined on the overall conditional format range.

readonly fill: Excel.ConditionalRangeFill;

Property Value

Excel.ConditionalRangeFill

Remarks

[ API set: ExcelApi 1.6 ]

font

Returns the font object defined on the overall conditional format range.

readonly font: Excel.ConditionalRangeFont;

Property Value

Excel.ConditionalRangeFont

Remarks

[ API set: ExcelApi 1.6 ]

numberFormat

Represents Excel's number format code for the given range. For more information about Excel number formatting, see Number format codes. Cleared if null is passed in.

numberFormat: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.6 ]

Method Details

clearFormat()

Remove the format properties from a conditional format rule. This creates a rule with no format settings.

clearFormat(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.17 ]

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

Parameters

options

Excel.Interfaces.ConditionalRangeFormatLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ConditionalRangeFormat

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.ConditionalRangeFormat

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

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

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

Parameters

properties

Excel.Interfaces.ConditionalRangeFormatUpdateData

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

Parameters

properties

Excel.ConditionalRangeFormat

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

toJSON(): Excel.Interfaces.ConditionalRangeFormatData;

Returns

Excel.Interfaces.ConditionalRangeFormatData