Click or drag to resize

XlsGradient Class

Represents a gradient used in Excel for filling cells with a smooth transition between two or more colors.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet XlsGradient

Namespace: Spire.Xls.Core.Spreadsheet
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsGradient : XlsObject, 
	IGradient

The XlsGradient type exposes the following members.

Properties
Name Description
Public property BackColor
Gets or sets the background color of the book.
Public property BackColorObject
Gets the background color as an OColor object.
Public property BackKnownColor
Gets or sets the known color of the background.
Public property ForeColor
Gets or sets the foreground color of the book.
Public property ForeColorObject
Gets the foreground color as an OColor object based on the internal background color.
Public property ForeKnownColor
Gets or sets the known color of the foreground.
Public property GradientStyle
Gets or sets the gradient style type for the fill.
Public property GradientVariant
Gets or sets the gradient variant type for the shape fill.
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method CompareTo
Compares the current instance with another IGradient object and returns an integer that indicates whether the current instance equals the another IGradient.
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method TwoColorGradient
Applies a horizontal two-color gradient to the selected range using the default gradient style.
Public method TwoColorGradient(GradientStyleType)
Sets the specified XlsFill to a two-color gradient.
Public method TwoColorGradient(GradientStyleType, GradientVariantsType)
Sets the specified XlsFill to a two-color gradient.
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also