Excel.Interfaces.ConditionalRangeFormatLoadOptions interface

Package:

excel

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

Remarks

[ API set: ExcelApi 1.6 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
borders	Collection of border objects that apply to the overall conditional format range.
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.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

TypeScript

$all?: boolean;

Property Value

boolean

borders

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

TypeScript

borders?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions;

Property Value

Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

fill

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

TypeScript

fill?: Excel.Interfaces.ConditionalRangeFillLoadOptions;

Property Value

Excel.Interfaces.ConditionalRangeFillLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

font

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

TypeScript

font?: Excel.Interfaces.ConditionalRangeFontLoadOptions;

Property Value

Excel.Interfaces.ConditionalRangeFontLoadOptions

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.

TypeScript

numberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]