setBorder Method

Determines which part of the cell range to set.

For example, {all:true}, {left:true, right:true}. The following settings are available:

option.all	boolean type	Specifies all directions for the border.
option.left	boolean type	Specifies the left border.
option.top	boolean type	Specifies the top border.
option.right	boolean type	Specifies the right border.
option.bottom	boolean type	Specifies the bottom border.
option.outline	boolean type	Specifies the left, top, right, and bottom borders.
option.inside	boolean type	Specifies the inner horizontal and vertical borders.
option.innerHorizontal	boolean type	Specifies the horizontal border.
option.innerVertical	boolean type	Specifies the vertical border.

Sets the border for the specified area.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Sheet(name);
var value; // Type: any
value = instance.setBorder(cellRange, border, option, sheetArea);

function setBorder( 
   cellRange : Range,
   border : LineBorder,
   option : Object,
   sheetArea : SheetArea
) : any;

Parameters

cellRange

The cell range.

border

The border line.

option

Determines which part of the cell range to set.

For example, {all:true}, {left:true, right:true}. The following settings are available:

option.all	boolean type	Specifies all directions for the border.
option.left	boolean type	Specifies the left border.
option.top	boolean type	Specifies the top border.
option.right	boolean type	Specifies the right border.
option.bottom	boolean type	Specifies the bottom border.
option.outline	boolean type	Specifies the left, top, right, and bottom borders.
option.inside	boolean type	Specifies the inner horizontal and vertical borders.
option.innerHorizontal	boolean type	Specifies the horizontal border.
option.innerVertical	boolean type	Specifies the vertical border.

sheetArea

The sheet area.

Example

This example creates borders.

Javascript

sheet.getCell(1, 1).borderTop(new GcSpread.Sheets.LineBorder("#F0F8FF",GcSpread.Sheets.LineStyle.double));
sheet.getCell(1, 1).borderLeft(new GcSpread.Sheets.LineBorder("#F0F8FF",GcSpread.Sheets.LineStyle.hair));
sheet.getCell(1, 1).borderRight(new GcSpread.Sheets.LineBorder("#FAEBD7",GcSpread.Sheets.LineStyle.dashDot));
sheet.getCell(1, 1).borderBottom(new GcSpread.Sheets.LineBorder("#00FFFF",GcSpread.Sheets.LineStyle.medium));
var r = new GcSpread.Sheets.Range(2, 2, 2, 2);
sheet.setBorder(r, new GcSpread.Sheets.LineBorder("#7FFFD4",GcSpread.Sheets.LineStyle.medium), {all:true},3);
sheet.getColumn(5).borderTop(new GcSpread.Sheets.LineBorder("#F0FFFF",GcSpread.Sheets.LineStyle.medium));
sheet.getColumn(5).borderLeft(new GcSpread.Sheets.LineBorder("#F5F5DC",GcSpread.Sheets.LineStyle.medium));
sheet.getColumn(5).borderRight(new GcSpread.Sheets.LineBorder("#FF02FF", GcSpread.Sheets.LineStyle.dashDot));
sheet.getColumn(5).borderBottom (new GcSpread.Sheets.LineBorder("#FFE4C4",GcSpread.Sheets.LineStyle.thin));
sheet.setBorder(r, new GcSpread.Sheets.LineBorder("#8A2BE2",GcSpread.Sheets.LineStyle.thick), { all:true },3);
sheet.getRow(5).borderTop( new GcSpread.Sheets.LineBorder("#A52A2A",GcSpread.Sheets.LineStyle.mediumDashed));
sheet.getRow(5).borderLeft( new GcSpread.Sheets.LineBorder("#FF02FF",GcSpread.Sheets.LineStyle.medium));
sheet.getRow(5).borderRight(new GcSpread.Sheets.LineBorder("#5F9EA0", GcSpread.Sheets.LineStyle.dashDot));
sheet.getRow(5).borderBottom (new GcSpread.Sheets.LineBorder("#6495ED",GcSpread.Sheets.LineStyle.dotted));

Reference

Sheet type