Class BindableCollection<T>

Namespace

Acuit.Pinpoint.Configuration

Assembly

Acuit.Pinpoint.Configuration.dll

A generic collection that works better with configuration binding (i.e., via ConfigurationBinder or MonitoredOptions<TOptions>), by allowing default values to be specified but that can be overridden via configuration settings.

public class BindableCollection<T> : Collection<T>, IList<T>, ICollection<T>, IList, ICollection, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable

Type Parameters

T

The type of elements in the collection.

Inheritance

object

Collection<T>

BindableCollection<T>

Implements

IList<T>

ICollection<T>

IList

ICollection

IReadOnlyList<T>

IReadOnlyCollection<T>

IEnumerable<T>

IEnumerable

Inherited Members

Collection<T>.Add(T)

Collection<T>.Clear()

Collection<T>.CopyTo(T[], int)

Collection<T>.Contains(T)

Collection<T>.GetEnumerator()

Collection<T>.IndexOf(T)

Collection<T>.Insert(int, T)

Collection<T>.Remove(T)

Collection<T>.RemoveAt(int)

Collection<T>.ClearItems()

Collection<T>.RemoveItem(int)

Collection<T>.SetItem(int, T)

Collection<T>.Count

Collection<T>.Items

Collection<T>.this[int]

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

The configuration settings binder works with regular collections (i.e., objects that derive from ICollection<T>) by always adding values to it, so if the collection in the strongly-typed object contains default items, the items specified via configuration will be appended to the list of default items instead of replacing them. This class will cause items specified via configuration to replace any default items.

Note that the default items must be specified via one of the constructor overrides that accept default items, and not via collection initializers, since collection initializers simply cause the collection's Add(T) method to be called.

Note that there is currently no way to have a collection with default items and then override via configuration with an empty collection.

Constructors

BindableCollection()

Initializes a new instance of the BindableCollection<T> class.

public BindableCollection()

BindableCollection(IEnumerable<T>)

Initializes a new instance of the BindableCollection<T> class.

public BindableCollection(IEnumerable<T> defaults)

Parameters

defaults IEnumerable<T>

The default items for the collection.

Exceptions

ArgumentNullException

defaults is null.

BindableCollection(params T[])

Initializes a new instance of the BindableCollection<T> class.

public BindableCollection(params T[] defaults)

Parameters

defaults T[]

The default items for the collection.

Exceptions

ArgumentNullException

defaults is null.

Methods

InsertItem(int, T)

Inserts an element into the collection at the specified index.

protected override void InsertItem(int index, T item)

Parameters

index int

The zero-based index at which item should be inserted.

item T

The object to insert. The value can be null for reference types.