Class ObservableList<T>

Namespace

CarinaStudio.Collections

Assembly

CarinaStudio.AppBase.Core.dll

Implementation of IList<T> which also implements INotifyCollectionChanged and INotifyPropertyChanged.

public class ObservableList<T> : IList, ICollection, IList<T>, ICollection<T>, INotifyCollectionChanged, INotifyPropertyChanged, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable

Type Parameters

T

Type of element.

Inheritance

object

ObservableList<T>

Implements

IList

ICollection

IList<T>

ICollection<T>

INotifyCollectionChanged

INotifyPropertyChanged

IReadOnlyList<T>

IReadOnlyCollection<T>

IEnumerable<T>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, Action)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, EventHandler)

ObjectExtensions.AddWeakEventHandler<TObject, TArg>(TObject, string, Action<TArg>)

ObjectExtensions.AddWeakEventHandler<TObject, TArgs>(TObject, string, EventHandler<TArgs>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2>(TObject, string, Action<TArg1, TArg2>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2, TArg3>(TObject, string, Action<TArg1, TArg2, TArg3>)

ObjectExtensions.AlsoAsync<T>(T, Func<T, Task>)

ObjectExtensions.Also<T>(T, Action<T>)

ObjectExtensions.AsNonNull<T>(T?)

ObjectExtensions.LetAsync<T>(T, Func<T, Task>)

ObjectExtensions.LetAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.Let<T>(T, Action<T>)

ObjectExtensions.Let<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Let<T, R>(T, Func<T, R>)

ObjectExtensions.LockAsync<T>(T, Func<T, Task>)

ObjectExtensions.LockAsync<T>(T, Func<Task>)

ObjectExtensions.LockAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.LockAsync<T, R>(T, Func<Task<R>>)

ObjectExtensions.Lock<T>(T, Action)

ObjectExtensions.Lock<T>(T, Action<T>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<R>)

ObjectExtensions.Lock<T, R>(T, Func<T, R>)

ObjectExtensions.Lock<T, R>(T, Func<R>)

CollectionExtensions.AddAll<T>(ICollection<T>, IEnumerable<T>)

CollectionExtensions.IsEmpty<T>(ICollection<T>)

CollectionExtensions.IsNotEmpty<T>(ICollection<T>?)

CollectionExtensions.IsNullOrEmpty<T>(ICollection<T>?)

CollectionExtensions.RemoveAll<T>(ICollection<T>, Predicate<T>)

ListExtensions.AsReadOnly<T>(IList<T>)

ListExtensions.BinarySearch<T>(IList<T>, T, IComparer<T>)

ListExtensions.BinarySearch<T>(IList<T>, T, Comparison<T>)

ListExtensions.BinarySearch<T, TKey>(IList<T>, TKey, Func<T, TKey>)

ListExtensions.BinarySearch<T, TKey>(IList<T>, TKey, Func<T, TKey>, Comparison<TKey>)

ListExtensions.CopyTo<T>(IList<T>, int, T[], int, int)

ListExtensions.GetRangeView<T>(IList<T>, int, int)

ListExtensions.IsSorted<T>(IList<T>, IComparer<T>)

ListExtensions.IsSorted<T>(IList<T>, Comparison<T>)

ListExtensions.ReverseAsReadOnly<T>(IList<T>)

ListExtensions.Reverse<T>(IList<T>)

ListExtensions.SelectRandomElement<T>(IList<T>)

ListExtensions.Shuffle<T>(IList<T>)

ListExtensions.Shuffle<T>(IList<T>, int, int)

ListExtensions.ToArray<T>(IList<T>, int, int)

CollectionExtensions.IsEmpty<T>(IReadOnlyCollection<T>)

CollectionExtensions.IsNotEmpty<T>(IReadOnlyCollection<T>?)

CollectionExtensions.IsNullOrEmpty<T>(IReadOnlyCollection<T>?)

ListExtensions.BinarySearch<T>(IReadOnlyList<T>, T, IComparer<T>)

ListExtensions.BinarySearch<T>(IReadOnlyList<T>, T, Comparison<T>)

ListExtensions.BinarySearch<T, TKey>(IReadOnlyList<T>, TKey, Func<T, TKey>)

ListExtensions.BinarySearch<T, TKey>(IReadOnlyList<T>, TKey, Func<T, TKey>, Comparison<TKey>)

ListExtensions.CopyTo<T>(IReadOnlyList<T>, int, T[], int, int)

ListExtensions.GetRangeView<T>(IReadOnlyList<T>, int, int)

ListExtensions.IsSorted<T>(IReadOnlyList<T>, IComparer<T>)

ListExtensions.IsSorted<T>(IReadOnlyList<T>, Comparison<T>)

ListExtensions.Reverse<T>(IReadOnlyList<T>)

ListExtensions.SelectRandomElement<T>(IReadOnlyList<T>)

ListExtensions.ToArray<T>(IReadOnlyList<T>, int, int)

EnumerableExtensions.ContentToString(IEnumerable, int)

ListExtensions.Cast<TOut>(IList)

NotifyCollectionChangedExtensions.AddWeakCollectionChangedEventHandler(INotifyCollectionChanged, NotifyCollectionChangedEventHandler)

NotifyPropertyChangedExtensions.AddWeakPropertyChangedEventHandler(INotifyPropertyChanged, PropertyChangedEventHandler)

NotifyPropertyChangedExtensions.WaitForPropertyAsync(INotifyPropertyChanged, string, object?, int, CancellationToken?)

ObjectExtensions.TryCastAndRunAsync<T>(object?, Func<T, Task>)

ObjectExtensions.TryCastAndRunAsync<T, R>(object?, Func<T, Task<R>>)

ObjectExtensions.TryCastAndRun<T>(object?, Action<T>)

ObjectExtensions.TryCastAndRun<T, R>(object?, Func<T, R>)

Constructors

ObservableList(IEnumerable<T>?)

Initialize new ObservableList<T> instance.

public ObservableList(IEnumerable<T>? elements = null)

Parameters

elements IEnumerable<T>

Initial elements.

ObservableList(int)

Initialize new ObservableList<T> instance.

public ObservableList(int capacity)

Parameters

capacity int

Initial capacity.

Properties

Capacity

Get capacity of the list.

public int Capacity { get; }

Property Value

int

Count

Get number of elements.

public int Count { get; }

Property Value

int

this[int]

Get or set element.

public T this[int index] { get; set; }

Parameters

index int

Index of element.

Property Value

T

Element.

Methods

Add(T)

Add element to list.

public int Add(T element)

Parameters

element T

Element to add.

Returns

int

Index of added element in list.

AddRange(IEnumerable<T>)

Add elements to list.

public void AddRange(IEnumerable<T> elements)

Parameters

elements IEnumerable<T>

Elements to add.

AsReadOnly()

Make the list as read-only IList<T>.

public IList<T> AsReadOnly()

Returns

IList<T>

Read-only IList<T>, the instance also implements INotifyCollectionChanged and IReadOnlyList<T>.

BinarySearch(T)

Use binary-search to find given element.

public int BinarySearch(T element)

Parameters

element T

Element to be found.

Returns

int

Index of found element, or bitwise complement of index of proper position to put element.

Remarks

The type of element must implement either IComparable<T> or IComparable, otherwise a NotSupportedException exception will be thrown.

BinarySearch(T, IComparer<T>)

Use binary-search to find given element.

public int BinarySearch(T element, IComparer<T> comparer)

Parameters

element T

Element to be found.

comparer IComparer<T>

IComparer<T> to compare elements.

Returns

int

Index of found element, or bitwise complement of index of proper position to put element.

BinarySearch(T, Comparison<T>)

Use binary-search to find given element.

public int BinarySearch(T element, Comparison<T> comparison)

Parameters

element T

Element to be found.

comparison Comparison<T>

Comparison function.

Returns

int

Index of found element, or bitwise complement of index of proper position to put element.

BinarySearch<TKey>(TKey, Func<T, TKey>)

Use binary-search to find given element by key.

public int BinarySearch<TKey>(TKey key, Func<T, TKey> keyGetter) where TKey : IComparable<TKey>

Parameters

key TKey

Key of element to be found.

keyGetter Func<T, TKey>

Method to get key from element.

Returns

int

Index of found element, or bitwise complement of index of proper position to put element.

Type Parameters

TKey

Type of key of element.

BinarySearch<TKey>(TKey, Func<T, TKey>, Comparison<TKey>)

Use binary-search to find given element by key.

public int BinarySearch<TKey>(TKey key, Func<T, TKey> keyGetter, Comparison<TKey> comparison)

Parameters

key TKey

Key of element to be found.

keyGetter Func<T, TKey>

Method to get key from element.

comparison Comparison<TKey>

Comparison function.

Returns

int

Index of found element, or bitwise complement of index of proper position to put element.

Type Parameters

TKey

Type of key of element.

Clear()

Clear all elements.

public void Clear()

Contains(T)

Check whether given element is contained in list or not.

public bool Contains(T element)

Parameters

element T

Element.

Returns

bool

True if element is contained in list.

CopyTo(int, T[], int, int)

Copy elements to array.

public void CopyTo(int index, T[] array, int arrayIndex, int count)

Parameters

index int

Index of first element in list to copy.

array T[]

Array to place copied elements.

arrayIndex int

Index of first position in array to place copied elements.

count int

Number of elements to copy.

CopyTo(T[], int)

Copy elements to array.

public void CopyTo(T[] array, int arrayIndex)

Parameters

array T[]

Array to place copied elements.

arrayIndex int

Index of first position in array to place copied elements.

GetEnumerator()

Get IEnumerator<T> to enumerate elements.

public IEnumerator<T> GetEnumerator()

Returns

IEnumerator<T>

IEnumerator<T>.

IndexOf(T)

Get index of given element in list.

public int IndexOf(T element)

Parameters

element T

Element.

Returns

int

Index of element in list, or -1 if element is not contained in list.

Insert(int, T)

Insert element at given position.

public void Insert(int index, T element)

Parameters

index int

Index of position to insert element.

element T

Element to insert.

InsertRange(int, IEnumerable<T>)

Insert elements at given position.

public void InsertRange(int index, IEnumerable<T> elements)

Parameters

index int

Index of position to insert elements.

elements IEnumerable<T>

Elements to insert.

IsEmpty()

Check whether the list is empty or not.

public bool IsEmpty()

Returns

bool

True if the list is empty.

IsNotEmpty()

Check whether the list is not empty or not.

public bool IsNotEmpty()

Returns

bool

True if the list is not empty.

Move(int, int)

Move element in the list.

public void Move(int index, int newIndex)

Parameters

index int

Index of element to move.

newIndex int

New index of element.

MoveRange(int, int, int)

Move elements in the list.

public void MoveRange(int index, int newIndex, int count)

Parameters

index int

Index of first element to move.

newIndex int

New index of first moved element.

count int

Number of elements to move.

Remove(T)

Remove first found of given element.

public bool Remove(T element)

Parameters

element T

Element to remove.

Returns

bool

True if element has been removed.

RemoveAll(Predicate<T>)

Remove elements which match given condition from list.

public int RemoveAll(Predicate<T> predicate)

Parameters

predicate Predicate<T>

Function to check whether log matches given condition or not.

Returns

int

Number of removed elements.

RemoveAt(int)

Remove element at given position.

public void RemoveAt(int index)

Parameters

index int

Index of element to remove.

RemoveRange(int, int)

Remove elements.

public void RemoveRange(int index, int count)

Parameters

index int

Index of first element to remove.

count int

Number of elements to remove.

Reverse()

Make given list as reversed IList<T>.

public IList<T> Reverse()

Returns

IList<T>

Reversed IList<T> which also implements INotifyCollectionChanged and IReadOnlyList<T>.

ReverseAsReadOnly()

Make given list as reversed and read-only IList<T>.

public IList<T> ReverseAsReadOnly()

Returns

IList<T>

Reversed read-only IList<T> which also implements INotifyCollectionChanged and IReadOnlyList<T>.

ToArray()

Copy elements to array.

public T[] ToArray()

Returns

T[]

Array of copied elements

ToArray(int, int)

Copy elements to array.

public T[] ToArray(int index, int count)

Parameters

index int

Index of first element in list to copy.

count int

Number of elements to copy.

Returns

T[]

Array of copied elements

TrimExcess()

Set the capacity to the actual number of elements in list.

public void TrimExcess()

Events

CollectionChanged

Raised when list changed.

public event NotifyCollectionChangedEventHandler? CollectionChanged

Event Type

NotifyCollectionChangedEventHandler

PropertyChanged

Raised when property changed.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler