Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

ColorRampCollection Class

Namespace:
ActiproSoftware.UI.Avalonia.Themes.Generation
Assembly:
ActiproSoftware.Avalonia.Shared.dll

A collection of ColorRamp objects within a ColorPalette.

public class ColorRampCollection
Inheritance:
object object

Constructors

ColorRampCollection()

Initializes an instance of the class.

public ColorRampCollection()

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int:

The number of elements contained in the ICollection<T>.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool:

true if the ICollection<T> is read-only; otherwise, false.

this[Hue]

An indexer to the item with the specified Hue name, if present in the collection.

public ColorRamp? this[Hue hue] { get; }
Parameter Type Description
hue Hue

The Hue name for which to search, using a case-insensitive comparison.

Property Value

ColorRamp

this[string]

An indexer to the item with the specified name, if present in the collection.

public ColorRamp? this[string name] { get; }
Parameter Type Description
name string

The ramp name for which to search, using a case-insensitive comparison.

Property Value

ColorRamp

Methods

Add(ColorRamp)

Adds an item to the ICollection<T>.

public void Add(ColorRamp item)
Parameter Type Description
item ColorRamp

The object to add to the ICollection<T>.

Exceptions

Type Condition
NotSupportedException

The ICollection<T> is read-only.

AddRange(IEnumerable<ColorRamp>)

Adds multiple items to the collection.

public void AddRange(IEnumerable<ColorRamp> items)
Parameter Type Description
items IEnumerable<ColorRamp>

The items to add.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

Type Condition
NotSupportedException

The ICollection<T> is read-only.

Contains(ColorRamp)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(ColorRamp item)
Parameter Type Description
item ColorRamp

The object to locate in the ICollection<T>.

Returns

bool:

true if item is found in the ICollection<T>; otherwise, false.

Contains(Hue)

Returns whether the collection contains an item with the specified Hue name.

public bool Contains(Hue hue)
Parameter Type Description
hue Hue

The Hue name for which to search, using a case-insensitive comparison.

Returns

bool

Contains(string)

Returns whether the collection contains an item with the specified name.

public bool Contains(string name)
Parameter Type Description
name string

The ramp name for which to search, using a case-insensitive comparison.

Returns

bool

CopyTo(ColorRamp[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(ColorRamp[] array, int arrayIndex)
Parameter Type Description
array ColorRamp[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.
arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

Type Condition
ArgumentNullException

array is null.
ArgumentOutOfRangeException

arrayIndex is less than 0.
ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<ColorRamp> GetEnumerator()

Returns

IEnumerator<ColorRamp>:

An enumerator that can be used to iterate through the collection.

Remove(ColorRamp)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(ColorRamp item)
Parameter Type Description
item ColorRamp

The object to remove from the ICollection<T>.

Returns

bool:

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

Type Condition
NotSupportedException

The ICollection<T> is read-only.

Remove(Hue)

Removes the item with the specified Hue name.

public bool Remove(Hue hue)
Parameter Type Description
hue Hue

The Hue name for which to search, using a case-insensitive comparison.

Returns

bool:

true if an item was removed; otherwise, false.

Remove(string)

Removes the item with the specified name.

public bool Remove(string name)
Parameter Type Description
name string

The ramp name for which to search, using a case-insensitive comparison.

Returns

bool:

true if an item was removed; otherwise, false.

Inherited Members

Extension Methods