Excel.Interfaces.RangeBorderData interface

Package:

excel

An interface describing the data returned by calling rangeBorder.toJSON().

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

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

sideIndex

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

sideIndex?: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp";

Property Value

Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

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?: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot";

Property Value

Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"

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

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

weight

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

weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";

Property Value

Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"

Remarks

[ API set: ExcelApi 1.1 ]