Excel.ConditionalRangeBorderCollection class

Package:

excel

Represents the border objects that make up range border.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.6 ]

Properties

bottom	Gets the bottom border.
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.
items	Gets the loaded child items in this collection.
left	Gets the left border.
right	Gets the right border.
top	Gets the top border.

Methods

getItem(index)	Gets a border object using its name.
getItem(indexString)	Gets a border object using its name.
getItemAt(index)	Gets a border object using its index.
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.
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.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.

TypeScript

readonly bottom: Excel.ConditionalRangeBorder;

Property Value

Excel.ConditionalRangeBorder

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.

TypeScript

context: RequestContext;

Property Value

Excel.RequestContext

count

Number of border objects in the collection.

TypeScript

readonly count: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.6 ]

items

Gets the loaded child items in this collection.

TypeScript

readonly items: Excel.ConditionalRangeBorder[];

Property Value

Excel.ConditionalRangeBorder[]

left

Gets the left border.

TypeScript

readonly left: Excel.ConditionalRangeBorder;

Property Value

Excel.ConditionalRangeBorder

Remarks

[ API set: ExcelApi 1.6 ]

right

Gets the right border.

TypeScript

readonly right: Excel.ConditionalRangeBorder;

Property Value

Excel.ConditionalRangeBorder

Remarks

[ API set: ExcelApi 1.6 ]

top

Gets the top border.

TypeScript

readonly top: Excel.ConditionalRangeBorder;

Property Value

Excel.ConditionalRangeBorder

Remarks

[ API set: ExcelApi 1.6 ]

Method Details

getItem(index)

Gets a border object using its name.

TypeScript

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

Excel.ConditionalRangeBorder

Remarks

[ API set: ExcelApi 1.6 ]

getItem(indexString)

Gets a border object using its name.

TypeScript

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

Excel.ConditionalRangeBorder

Remarks

[ API set: ExcelApi 1.6 ]

getItemAt(index)

Gets a border object using its index.

TypeScript

getItemAt(index: number): Excel.ConditionalRangeBorder;

Parameters

index

number

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

Returns

Excel.ConditionalRangeBorder

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.

TypeScript

load(options?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection;

Parameters

options

Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ConditionalRangeBorderCollection

load(propertyNames)

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

TypeScript

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

Excel.ConditionalRangeBorderCollection

load(propertyNamesAndPaths)

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

TypeScript

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

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

TypeScript

toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;

Returns

Excel.Interfaces.ConditionalRangeBorderCollectionData