CellBorders Class

Represents a single set of cell border formats (left, right, top, bottom and diagonal).

Inheritance Hierarchy

SystemObject
GemBox.SpreadsheetCellBorders

Namespace: GemBox.Spreadsheet
Assembly: GemBox.Spreadsheet (in GemBox.Spreadsheet.dll) Version: 43.0.35.1084

Syntax

Copy

public sealed class CellBorders

Public NotInheritable Class CellBorders

The CellBorders type exposes the following members.

Properties

	Name	Description
	Item	Gets the CellBorder which contains the color and line style for the specified individual border of a cell.

Top

Methods

	Name	Description
	GetUnresolvedBorder	Gets the unresolved (direct) CellBorder which contains the color and line style for the specified individual border of a cell.
	SetBorders	Sets the color and line style for the specified multiple borders of a cell.
	ToString	Returns a String that represents this CellBorders instance. (Overrides ObjectToString.)

Top

Remarks

Diagonal-up (DiagonalUp / DiagonalUp) and diagonal-down (DiagonalDown / DiagonalDown) always share the same color and line style.

Conceptually, cell formatting is divided into following groups:

Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
Font - defines the properties for the used font. Associated property is Font.
Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.

Additional CellStyle properties not associated with any formatting group are:

Name - name of the referenced workbook style.
QuotePrefix - to store numeric value of a cell as text; otherwise, .
IsDefault - if referenced workbook style is default (Normal) and there are no additional modifications of cell formatting; otherwise, .

Workbook contains a set of master styles which can be referenced by multiple cells.

Workbook must always contain at least one master style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.

Workbook style can either be built-in or user-defined. Built-in style is accessible from workbook styles via BuiltInCellStyleName enumeration.

Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from referenced workbook (master) style, unless cell formatting group or its associated property is modified.

Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.

Note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side. Setting cell formatting property on CellRange is propagated to each cell in a range.

Note

For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.

Setting cell formatting property on CellRange is propagated to each cell in a range.

To set workbook (master) style to one or more cells, simply assign it to Style property.

Tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification. If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.

Tip

Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.

If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.

GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting all worksheet cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.

Examples

Following code demonstrates border formatting:

Copy

// 'Border' formatting group

cells["B22"].Value = "Borders.SetBorders(...)";
cells["C22"].Style.Borders.SetBorders(MultipleBorders.All, SpreadsheetColor.FromName(ColorName.Accent2), LineStyle.Thin);

' 'Border' formatting group

cells("B22").Value = "Borders.SetBorders(...)"
cells("C22").Style.Borders.SetBorders(MultipleBorders.All, SpreadsheetColor.FromName(ColorName.Accent2), LineStyle.Thin)

Reference

GemBox.Spreadsheet Namespace

CellStyleBorders

GemBox.SpreadsheetCellBorder