ConditionalRangeBorderCollection Object (JavaScript API for Excel)

Represents the border objects that make up range border.

Properties

Property Type Description Req. Set
count int Number of border objects in the collection. Read-only. 1.6
items ConditionalRangeBorder[] A collection of conditionalRangeBorder objects. Read-only. 1.6

See property access examples.

Relationships

Relationship Type Description Req. Set
bottom ConditionalRangeBorder Gets the top border Read-only. 1.6
left ConditionalRangeBorder Gets the top border Read-only. 1.6
right ConditionalRangeBorder Gets the top border Read-only. 1.6
top ConditionalRangeBorder Gets the top border Read-only. 1.6

Methods

Method Return Type Description Req. Set
getItem(index: string) ConditionalRangeBorder Gets a border object using its name 1.6
getItemAt(index: number) ConditionalRangeBorder Gets a border object using its index 1.6

Method Details

getItem(index: string)

Gets a border object using its name

Syntax

conditionalRangeBorderCollectionObject.getItem(index);

Parameters

Parameter Type Description
index string Index value of the border object to be retrieved. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight

Returns

ConditionalRangeBorder

getItemAt(index: number)

Gets a border object using its index

Syntax

conditionalRangeBorderCollectionObject.getItemAt(index);

Parameters

Parameter Type Description
index number Index value of the object to be retrieved. Zero-indexed.

Returns

ConditionalRangeBorder