CellBorder module

class CellBorder.CellBorder

Bases: IBorder, IExcelApplication

Represents a border of a cell or range of cells in an Excel worksheet.

This class implements IBorder and IExcelApplication interfaces, providing properties and methods for manipulating cell borders, including colors, line styles, and diagonal lines. It allows for customizing the appearance of cell borders in Excel worksheets.

property Color: Color

Returns or sets the primary color of the object, as shown in the table in the remarks section. Use the RGB function to create a color value. Read/write Color.

CopyFrom(srcBorder: CellBorder)

Copies styles from source border.

Parameters:

srcBorder – source border.

property KnownColor: ExcelColors

Returns or sets a ExcelColors value that represents the color of the border

property LineStyle: LineStyleType

Returns or sets the line style for the border. Read/write LineStyleType.

property OColor: OColor

Returns or sets the primary color of the object. Read/write ExcelColors.

property Parent: SpireObject
SetThemeColor(type: ThemeColorType, tint: float)

Sets the theme color for the border.

This method applies a theme color to the border, with an optional tint value to lighten or darken the theme color.

Parameters:
  • type (ThemeColorType) – The theme color type to apply to the border.

  • tint (float) – A value between -1.0 and 1.0 that lightens or darkens the theme color. Positive values lighten, negative values darken.

property ShowDiagonalLine: bool

Indicates whether shows diagonal line.