Click or drag to resize

GradientStops Class

Represents a collection of gradient stops for a gradient effect.
Inheritance Hierarchy
System Object
System.Collections.Generic List XlsGradientStop
Spire.Xls.Core.Spreadsheet.Shapes GradientStops

Namespace: Spire.Xls.Core.Spreadsheet.Shapes
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class GradientStops : List<XlsGradientStop>

The GradientStops type exposes the following members.

Constructors
Name Description
Public method GradientStops
Initializes a new instance of the GradientStops class.
Top
Properties
Name Description
Public property Angle
Gets / sets gradient angle.
Public property Capacity
Gets or sets the total number of elements the internal data structure can hold without resizing.
(Inherited from List XlsGradientStop .)
Public property Count
Gets the number of elements contained in the List T .
(Inherited from List XlsGradientStop .)
Public property FillToRect
This element defines the "focus" rectangle for the center shade, specified relative to the XlsFill tile rectangle.
Public property GradientType
Gets / sets type of the gradient.
Public property IsDoubled
Returns true if gradient stops are symmetric. Read-only.
Public property Item
Gets or sets the element at the specified index.
(Inherited from List XlsGradientStop .)
Top
Methods
Name Description
Public method Add(XlsGradientStop)
Adds a gradient stop to the chart. If the stop does not have a conversion object, it creates a new one, sets its properties, and adds it to the conversion collection. If the stop already has a conversion object, it checks if the stop is already in the collection. If not, it adds the conversion object to the collection and the stop to the base collection.
Public method Add(Color, Int32, Int32, Int32, Int32)
Adds a gradient stop to the gradient fill.
Public method AddRange
Adds the elements of the specified collection to the end of the List T .
(Inherited from List XlsGradientStop .)
Public method AsReadOnly
Returns a read-only ReadOnlyCollection T wrapper for the current collection.
(Inherited from List XlsGradientStop .)
Public method BinarySearch(T)
Searches the entire sorted List T for an element using the default comparer and returns the zero-based index of the element.
(Inherited from List XlsGradientStop .)
Public method BinarySearch(T, IComparer T )
Searches the entire sorted List T for an element using the specified comparer and returns the zero-based index of the element.
(Inherited from List XlsGradientStop .)
Public method BinarySearch(Int32, Int32, T, IComparer T )
Searches a range of elements in the sorted List T for an element using the specified comparer and returns the zero-based index of the element.
(Inherited from List XlsGradientStop .)
Public method Clear
Removes all elements from the List T .
(Inherited from List XlsGradientStop .)
Public method Clone
Creates copy of the current instance.
Public method Contains
Determines whether an element is in the List T .
(Inherited from List XlsGradientStop .)
Public method ConvertAll TOutput
Converts the elements in the current List T to another type, and returns a list containing the converted elements.
(Inherited from List XlsGradientStop .)
Public method CopyTo( T )
Copies the entire List T to a compatible one-dimensional array, starting at the beginning of the target array.
(Inherited from List XlsGradientStop .)
Public method CopyTo( T , Int32)
Copies the entire List T to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from List XlsGradientStop .)
Public method CopyTo(Int32, T , Int32, Int32)
Copies a range of elements from the List T to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from List XlsGradientStop .)
Public method DoubleGradientStops
Doubles gradient stops in the collection and updates their positions.
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Public method Exists
Determines whether the List T contains elements that match the conditions defined by the specified predicate.
(Inherited from List XlsGradientStop .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method Find
Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List T .
(Inherited from List XlsGradientStop .)
Public method FindAll
Retrieves all the elements that match the conditions defined by the specified predicate.
(Inherited from List XlsGradientStop .)
Public method FindIndex(Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List T .
(Inherited from List XlsGradientStop .)
Public method FindIndex(Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List T that extends from the specified index to the last element.
(Inherited from List XlsGradientStop .)
Public method FindIndex(Int32, Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List T that starts at the specified index and contains the specified number of elements.
(Inherited from List XlsGradientStop .)
Public method FindLast
Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List T .
(Inherited from List XlsGradientStop .)
Public method FindLastIndex(Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List T .
(Inherited from List XlsGradientStop .)
Public method FindLastIndex(Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the List T that extends from the first element to the specified index.
(Inherited from List XlsGradientStop .)
Public method FindLastIndex(Int32, Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the List T that contains the specified number of elements and ends at the specified index.
(Inherited from List XlsGradientStop .)
Public method ForEach
Performs the specified action on each element of the List T .
(Inherited from List XlsGradientStop .)
Public method GetEnumerator
Returns an enumerator that iterates through the List T .
(Inherited from List XlsGradientStop .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetRange
Creates a shallow copy of a range of elements in the source List T .
(Inherited from List XlsGradientStop .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method IndexOf(T)
Searches for the specified object and returns the zero-based index of the first occurrence within the entire List T .
(Inherited from List XlsGradientStop .)
Public method IndexOf(T, Int32)
Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List T that extends from the specified index to the last element.
(Inherited from List XlsGradientStop .)
Public method IndexOf(T, Int32, Int32)
Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List T that starts at the specified index and contains the specified number of elements.
(Inherited from List XlsGradientStop .)
Public method Insert
Inserts an element into the List T at the specified index.
(Inherited from List XlsGradientStop .)
Public method InsertRange
Inserts the elements of a collection into the List T at the specified index.
(Inherited from List XlsGradientStop .)
Public method InvertGradientStops
Inverts gradient stops order and updates their positions correctly.
Public method LastIndexOf(T)
Searches for the specified object and returns the zero-based index of the last occurrence within the entire List T .
(Inherited from List XlsGradientStop .)
Public method LastIndexOf(T, Int32)
Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List T that extends from the first element to the specified index.
(Inherited from List XlsGradientStop .)
Public method LastIndexOf(T, Int32, Int32)
Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List T that contains the specified number of elements and ends at the specified index.
(Inherited from List XlsGradientStop .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Public method Remove
Removes the first occurrence of a specific object from the List T .
(Inherited from List XlsGradientStop .)
Public method RemoveAll
Removes all the elements that match the conditions defined by the specified predicate.
(Inherited from List XlsGradientStop .)
Public method RemoveAt
Removes the element at the specified index of the List T .
(Inherited from List XlsGradientStop .)
Public method RemoveRange
Removes a range of elements from the List T .
(Inherited from List XlsGradientStop .)
Public method Reverse
Reverses the order of the elements in the entire List T .
(Inherited from List XlsGradientStop .)
Public method Reverse(Int32, Int32)
Reverses the order of the elements in the specified range.
(Inherited from List XlsGradientStop .)
Public method Serialize
Saves gradient stops into stream in binary format.
Public method ShrinkGradientStops
Creates a new GradientStops object with half the number of stops by reducing the position of each stop to half its original value.
Public method Sort
Sorts the elements in the entire List T using the default comparer.
(Inherited from List XlsGradientStop .)
Public method Sort(IComparer T )
Sorts the elements in the entire List T using the specified comparer.
(Inherited from List XlsGradientStop .)
Public method Sort(Comparison T )
Sorts the elements in the entire List T using the specified Comparison T .
(Inherited from List XlsGradientStop .)
Public method Sort(Int32, Int32, IComparer T )
Sorts the elements in a range of elements in List T using the specified comparer.
(Inherited from List XlsGradientStop .)
Public method ToArray
Copies the elements of the List T to a new array.
(Inherited from List XlsGradientStop .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method TrimExcess
Sets the capacity to the actual number of elements in the List T , if that number is less than a threshold value.
(Inherited from List XlsGradientStop .)
Public method TrueForAll
Determines whether every element in the List T matches the conditions defined by the specified predicate.
(Inherited from List XlsGradientStop .)
Top
See Also