XlsBorderArrayWrapper module

class XlsBorderArrayWrapper.XlsBorderArrayWrapper

Bases: XlsObject, IBorder

Represents a wrapper for border array in Excel.

This class provides properties and methods for manipulating borders in Excel, including accessing and modifying border colors, line styles, and diagonal lines. It extends XlsObject and implements the IBorder interface.

property Color: Color

Gets or sets the color of the border.

Returns:

A Color object representing the border color.

Return type:

Color

property KnownColor: ExcelColors

Gets or sets the known color of the border.

Returns:

An enumeration value representing the Excel color.

Return type:

ExcelColors

property LineStyle: LineStyleType

Gets or sets the line style of the border.

Returns:

An enumeration value representing the line style.

Return type:

LineStyleType

property OColor: OColor

Gets the Office color of the border.

Returns:

An object representing the Office color.

Return type:

OColor

SetThemeColor(type: ThemeColorType, tint: float)

Sets a theme color for the border.

Parameters:
  • type (ThemeColorType) – The theme color type to set.

  • tint (float) – The tint value to apply to the theme color.

property ShowDiagonalLine: bool

Gets or sets a value indicating whether to show diagonal lines.

Returns:

True if diagonal lines are shown; otherwise, False.

Return type:

bool