Border

Border class

Encapsulates the object that represents the cell border.

class Border;

Example

const { Workbook, BorderType, CellBorderType, Color } = require("aspose.cells.node");

var workbook = new Workbook();
var worksheet = workbook.worksheets.get(0);
var cell = worksheet.cells.get(0, 0);
var style = workbook.createStyle();
//Set top border style and color
var border = style.borders.get(BorderType.TopBorder);
border.lineStyle = CellBorderType.Medium;
border.color = Color.Red;
cell.setStyle(style);

Properties

PropertyTypeDescription
themeColorThemeColorGets and sets the theme color of the border.
colorColorGets or sets the Color of the border.
argbColornumberGets and sets the color with a 32-bit ARGB value.
lineStyleCellBorderTypeGets or sets the cell border type.

Methods

MethodDescription
getThemeColor()@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color of the border.
setThemeColor(ThemeColor)@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color of the border.
getColor()@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the border.
setColor(Color)@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the border.
getArgbColor()@deprecated. Please use the ‘argbColor’ property instead. Gets and sets the color with a 32-bit ARGB value.
setArgbColor(number)@deprecated. Please use the ‘argbColor’ property instead. Gets and sets the color with a 32-bit ARGB value.
getLineStyle()@deprecated. Please use the ’lineStyle’ property instead. Gets or sets the cell border type.
setLineStyle(CellBorderType)@deprecated. Please use the ’lineStyle’ property instead. Gets or sets the cell border type.
isNull()Checks whether the implementation object is null.

themeColor

Gets and sets the theme color of the border.

themeColor : ThemeColor;

color

Gets or sets the Color of the border.

color : Color;

argbColor

Gets and sets the color with a 32-bit ARGB value.

argbColor : number;

lineStyle

Gets or sets the cell border type.

lineStyle : CellBorderType;

getThemeColor()

@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color of the border.

getThemeColor() : ThemeColor;

Returns

ThemeColor

setThemeColor(ThemeColor)

@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color of the border.

setThemeColor(value: ThemeColor) : void;

Parameters:

ParameterTypeDescription
valueThemeColorThe value to set.

getColor()

@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the border.

getColor() : Color;

Returns

Color

setColor(Color)

@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the border.

setColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getArgbColor()

@deprecated. Please use the ‘argbColor’ property instead. Gets and sets the color with a 32-bit ARGB value.

getArgbColor() : number;

setArgbColor(number)

@deprecated. Please use the ‘argbColor’ property instead. Gets and sets the color with a 32-bit ARGB value.

setArgbColor(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getLineStyle()

@deprecated. Please use the ’lineStyle’ property instead. Gets or sets the cell border type.

getLineStyle() : CellBorderType;

Returns

CellBorderType

setLineStyle(CellBorderType)

@deprecated. Please use the ’lineStyle’ property instead. Gets or sets the cell border type.

setLineStyle(value: CellBorderType) : void;

Parameters:

ParameterTypeDescription
valueCellBorderTypeThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;