XlsFill module

class XlsFill.XlsFill

Bases: SpireObject

Represents a fill formatting in an Excel worksheet.

This class provides properties and methods for manipulating fill formatting in Excel, including patterns, colors, and gradient effects. It extends SpireObject and can be used to create and modify cell and shape fills.

Clone() XlsFill

Creates a clone of this fill.

Returns:

A new instance of the fill with the same formatting.

Return type:

XlsFill

Equals(obj: SpireObject) bool

Determines whether the specified object is equal to the current fill.

Parameters:

obj (SpireObject) – The object to compare with the current fill.

Returns:

True if the specified object is equal to the current fill; otherwise, False.

Return type:

bool

property FillType: ShapeFillType

Gets or sets the type of the fill.

Returns:

An enumeration value representing the fill type.

Return type:

ShapeFillType

GetHashCode() int

Gets the hash code for the current fill.

Returns:

A hash code for the current fill.

Return type:

int

property GradientStyle: GradientStyleType

Gets or sets the gradient style of the fill.

Returns:

An enumeration value representing the gradient style.

Return type:

GradientStyleType

property GradientVariant: GradientVariantsType

Gets or sets the gradient variant of the fill.

Returns:

An enumeration value representing the gradient variant.

Return type:

GradientVariantsType

property OColor: OColor

Gets the Office color of the fill.

Returns:

An object representing the Office color of the fill.

Return type:

OColor

property Pattern: ExcelPatternType

Gets or sets the pattern type of the fill.

Returns:

An enumeration value representing the pattern type.

Return type:

ExcelPatternType

property PatternColorObject: OColor

Gets the pattern color object of the fill.

Returns:

An object representing the pattern color of the fill.

Return type:

OColor