Excel.ConditionalRangeBorderCollection class

Represents the border objects that make up range border.

[ API set: ExcelApi 1.6 ]

Extends

Properties

bottom

Gets the bottom border. Read-only.

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

count

Number of border objects in the collection. Read-only.

[ API set: ExcelApi 1.6 ]

items

Gets the loaded child items in this collection.

left

Gets the left border. Read-only.

[ API set: ExcelApi 1.6 ]

right

Gets the right border. Read-only.

[ API set: ExcelApi 1.6 ]

top

Gets the top border. Read-only.

[ API set: ExcelApi 1.6 ]

Methods

getItem(index)

Gets a border object using its name.

[ API set: ExcelApi 1.6 ]

getItem(indexString)

Gets a border object using its name.

[ API set: ExcelApi 1.6 ]

getItemAt(index)

Gets a border object using its index.

[ API set: ExcelApi 1.6 ]

load(option)

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(option)
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.ConditionalRangeBorderCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalRangeBorderCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

bottom

Gets the bottom border. Read-only.

[ API set: ExcelApi 1.6 ]

readonly bottom: Excel.ConditionalRangeBorder;

Property Value

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

RequestContext

count

Number of border objects in the collection. Read-only.

[ API set: ExcelApi 1.6 ]

readonly count: number;

Property Value

number

items

Gets the loaded child items in this collection.

readonly items: Excel.ConditionalRangeBorder[];

Property Value

Excel.ConditionalRangeBorder[]

left

Gets the left border. Read-only.

[ API set: ExcelApi 1.6 ]

readonly left: Excel.ConditionalRangeBorder;

Property Value

Gets the right border. Read-only.

[ API set: ExcelApi 1.6 ]

readonly right: Excel.ConditionalRangeBorder;

Property Value

top

Gets the top border. Read-only.

[ API set: ExcelApi 1.6 ]

readonly top: Excel.ConditionalRangeBorder;

Property Value

Method Details

getItem(index)

Gets a border object using its name.

[ API set: ExcelApi 1.6 ]

getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;

Parameters

index
Excel.ConditionalRangeBorderIndex

Index value of the border object to be retrieved. See Excel.ConditionalRangeBorderIndex for details.

Returns

getItem(indexString)

Gets a border object using its name.

[ API set: ExcelApi 1.6 ]

getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder;

Parameters

indexString
"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"

Index value of the border object to be retrieved. See Excel.ConditionalRangeBorderIndex for details.

Returns

getItemAt(index)

Gets a border object using its index.

[ API set: ExcelApi 1.6 ]

getItemAt(index: number): Excel.ConditionalRangeBorder;

Parameters

index
number

Index value of the object to be retrieved. Zero-indexed.

Returns

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?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection;

Parameters

option
Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Returns

Remarks

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

load(option?: string | string[]): Excel.ConditionalRangeBorderCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ConditionalRangeBorderCollection - 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.ConditionalRangeBorderCollection - 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.

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

Parameters

propertyNames
string | string[]

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

Returns

load(option)

load(option?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection;

Parameters

Returns

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.ConditionalRangeBorderCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalRangeBorderCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;

Returns