Excel.ConditionalRangeBorder class

Represents the border of an object.

[ API set: ExcelApi 1.6 ]

Extends
OfficeExtension.ClientObject

Properties

color

HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").

[ API set: ExcelApi 1.6 ]

sideIndex

Constant value that indicates the specific side of the border. See Excel.ConditionalRangeBorderIndex for details. Read-only.

[ API set: ExcelApi 1.6 ]

style

One of the constants of line style specifying the line style for the border. See Excel.BorderLineStyle for details.

[ API set: ExcelApi 1.6 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Property Details

color

HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").

[ API set: ExcelApi 1.6 ]

color: string;
Property Value
string

sideIndex

Constant value that indicates the specific side of the border. See Excel.ConditionalRangeBorderIndex for details. Read-only.

[ API set: ExcelApi 1.6 ]

readonly sideIndex: Excel.ConditionalRangeBorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight";
Property Value
Excel.ConditionalRangeBorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"

style

One of the constants of line style specifying the line style for the border. See Excel.BorderLineStyle for details.

[ API set: ExcelApi 1.6 ]

style: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot";
Property Value
Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.ConditionalRangeBorder;
Parameters
option
string | string[]

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

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorder - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalRangeBorder - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

toJSON(): Excel.Interfaces.ConditionalRangeBorderData;
Returns