Edit

Share via

Excel.Interfaces.RangeBorderLoadOptions interface

  • Reference
Package:
excel

Represents the border of an object.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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").
sideIndex

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

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

Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the border doesn't have a uniform tintAndShade setting.
weight

Specifies the weight of the border around a range. See Excel.BorderWeight for details.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

sideIndex

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

sideIndex?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

style

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

style?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

tintAndShade

Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the border doesn't have a uniform tintAndShade setting.

tintAndShade?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

weight

Specifies the weight of the border around a range. See Excel.BorderWeight for details.

weight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]