Edit

Share via

Excel.ConditionalRangeBorder class

Package:
excel

Represents the border of an object.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.6 ]

Properties

color

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

The request context associated with the object. This connects the add-in's process to the Office host application's process.
sideIndex

Constant value that indicates the specific side of the border. See Excel.ConditionalRangeBorderIndex for details.
style

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

Methods

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.
set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.
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.ConditionalRangeBorder object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalRangeBorderData) that contains shallow copies of any loaded child properties from the original object.

Property Details

color

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

color: string;

Property Value

string

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.

context: RequestContext;

Property Value

Excel.RequestContext

sideIndex

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

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

Property Value

Excel.ConditionalRangeBorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"

Remarks

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

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

Property Value

Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"

Remarks

[ API set: ExcelApi 1.6 ]

Method Details

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeBorderLoadOptions): Excel.ConditionalRangeBorder;

Parameters

options
Excel.Interfaces.ConditionalRangeBorderLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ConditionalRangeBorder

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.ConditionalRangeBorder

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalRangeBorder;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ConditionalRangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Excel.Interfaces.ConditionalRangeBorderUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ConditionalRangeBorder): void;

Parameters

properties
Excel.ConditionalRangeBorder

Returns

void

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.ConditionalRangeBorder object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalRangeBorderData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ConditionalRangeBorderData;

Returns

Excel.Interfaces.ConditionalRangeBorderData