Class BaseCollection<TItem, TCollection>

Namespace

Ecng.Collections

Assembly

Ecng.Collections.dll

Represents a base class for a generic collection with event notifications and inner collection management.

public abstract class BaseCollection<TItem, TCollection> : INotifyList<TItem>, INotifyCollection<TItem>, IList<TItem>, ICollection<TItem>, IEnumerable<TItem>, IList, ICollection, IEnumerable where TCollection : ICollection<TItem>

Type Parameters

TItem

The type of elements in the collection.

TCollection

The type of the inner collection, which must implement ICollection<T>.

Inheritance

object

BaseCollection<TItem, TCollection>

Implements

INotifyList<TItem>

INotifyCollection<TItem>

IList<TItem>

ICollection<TItem>

IEnumerable<TItem>

IList

ICollection

IEnumerable

Derived

BaseList<TItem>

SynchronizedCollection<TItem, TCollection>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AsyncHelper.FromResult<TValue>(TValue)

AsyncHelper.ToCompleteSource<TValue>(TValue)

CompareHelper.IsDefault<T>(T)

CompareHelper.IsRuntimeDefault<T>(T)

Converter.TypedTo<TFrom, TTo>(TFrom)

DelegateHelper.AddDelegate<TDelegate>(TDelegate, TDelegate)

DelegateHelper.GetInvocationList<TDelegate>(TDelegate)

DelegateHelper.RemoveAllDelegates<TDelegate>(TDelegate)

DelegateHelper.RemoveDelegate<TDelegate>(TDelegate, TDelegate)

DisposableHelper.MakeDisposable<T>(T, Action<T>)

Enumerator.IsDefined<T>(T)

Enumerator.SplitMask<T>(T)

NullableHelper.Convert<T, TResult>(T, Func<T, TResult>, Func<TResult>)

NullableHelper.IsNull<T>(T)

NullableHelper.IsNull<T>(T, bool)

TupleHelper.ToValues<T>(T)

TypeHelper.CheckOnNull<T>(T, string)

TypeHelper.DoDispose<TSource>(TSource)

TypeHelper.ToScope<T>(T, bool)

NetworkHelper.Format<T>(T, bool)

PersistableHelper.TrySerialize<T>(T, out SettingsStorage)

XamlHelper.CopyToClipboard<T>(T)

Paths.SerializeToString<T>(T, bool)

Paths.Serialize<T>(T, bool)

Paths.Serialize<T>(T, string, bool)

CollectionHelper.Bind<T>(INotifyList<T>, IList<T>)

CollectionHelper.AddRange<T>(ICollection<T>, IEnumerable<T>)

CollectionHelper.CopyAndClear<T>(ICollection<T>)

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

CollectionHelper.RemoveRange<T>(ICollection<T>, IEnumerable<T>)

CollectionHelper.RemoveWhere<T>(ICollection<T>, Func<T, bool>)

CollectionHelper.TryAdd<T>(ICollection<T>, IEnumerable<T>)

CollectionHelper.TryAdd<T>(ICollection<T>, T)

CollectionHelper.Append2<T>(IEnumerable<T>, T)

CollectionHelper.Batch<T>(IEnumerable<T>, int)

CollectionHelper.Batch<TSource, TResult>(IEnumerable<TSource>, int, Func<IEnumerable<TSource>, TResult>, Func<bool>)

CollectionHelper.ElementAtFromEndOrDefault<T>(IEnumerable<T>, int)

CollectionHelper.ElementAtFromEnd<T>(IEnumerable<T>, int)

CollectionHelper.FirstOr<T>(IEnumerable<T>, T)

CollectionHelper.ForEach<T>(IEnumerable<T>, Action<T>)

CollectionHelper.GetHashCodeEx<T>(IEnumerable<T>)

CollectionHelper.IndexOf<T>(IEnumerable<T>, Func<T, bool>)

CollectionHelper.IsEmpty<T>(IEnumerable<T>)

CollectionHelper.IsEmpty<T>(IEnumerable<T>, Func<T, bool>)

CollectionHelper.OrderByDescending<T>(IEnumerable<T>)

CollectionHelper.OrderBy<T>(IEnumerable<T>)

CollectionHelper.OrderBy<T>(IEnumerable<T>, Comparison<T>)

CollectionHelper.Permutations<TKey, TValue>(IEnumerable<TKey>, Func<TKey, IEnumerable<TValue>>)

CollectionHelper.SelectManyAsync<T, T1>(IEnumerable<T>, Func<T, Task<IEnumerable<T1>>>)

CollectionHelper.SequenceEqual<T>(IEnumerable<T>, IEnumerable<T>, Func<T, T, bool>)

CollectionHelper.SingleWhenOnly<T>(IEnumerable<T>)

CollectionHelper.ToDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, int, TKey>, Func<TSource, int, TValue>)

CollectionHelper.ToEx<T>(IEnumerable<T>)

CollectionHelper.ToEx<T>(IEnumerable<T>, int)

CollectionHelper.ToPairSet<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, int, TKey>, Func<TSource, int, TValue>)

CollectionHelper.ToSet<T>(IEnumerable<T>)

CollectionHelper.WhereWithPrevious<TSource>(IEnumerable<TSource>, Func<TSource, TSource, bool>)

CollectionHelper.RemoveWhere2<T>(IList<T>, Func<T, bool>)

CollectionHelper.Sync<T>(IList<T>)

CollectionHelper.Count2(IEnumerable)

CompareHelper.Compare(object, object)

Converter.To(object, Type)

Converter.To<T>(object)

Enumerator.GetAttributeOfType<TAttribute>(object)

Enumerator.IsEnumBrowsable(object)

Enumerator.SplitMask2(object)

TypeHelper.HasProperty(object, string)

EntityPropertyHelper.GetPropValue(object, string, Func<object, string, object>, IDictionary<string, object>)

Extensions.GetBasicProperties(object, int)

Extensions.GetDisplayName(object)

Extensions.GetFieldDescription(object)

Extensions.GetFieldDisplayName(object)

Extensions.GetFieldIcon(object)

JsonHelper.ToJson(object, bool)

JsonHelper.ToJson(object, bool, JsonSerializerSettings)

PersistableHelper.ToStorage(object, bool)

EditorExtensions.ToItemsSource(object, Type, bool?, ListSortDirection?, Func<IItemsSourceItem, bool>, Func<object, string>, Func<object, string>)

XamlHelper.EnsureUIThread(object)

XamlHelper.ShowModel<TWindow>(object, DependencyObject)

XamlHelper.WpfCast<T>(object)

VirtualPropertyRegistry.TryGetVirtualValue(object, string, out object)

Constructors

BaseCollection(TCollection)

Initializes a new instance of the BaseCollection<TItem, TCollection> class with the specified inner collection.

protected BaseCollection(TCollection innerCollection)

Parameters

innerCollection TCollection

The inner collection to manage.

Exceptions

ArgumentNullException

Thrown when innerCollection is null.

Properties

CheckNullableItems

Gets or sets a value indicating whether to check for null items in the collection.

public bool CheckNullableItems { get; set; }

Property Value

bool

Count

Gets the number of items in the collection.

public virtual int Count { get; }

Property Value

int

InnerCollection

Gets the inner collection that stores the items.

protected TCollection InnerCollection { get; }

Property Value

TCollection

IsReadOnly

Gets a value indicating whether the collection is read-only.

public virtual bool IsReadOnly { get; }

Property Value

bool

this[int]

Gets or sets the item at the specified index.

public virtual TItem this[int index] { get; set; }

Parameters

index int

The zero-based index of the item.

Property Value

TItem

The item at the specified index.

Exceptions

ArgumentOutOfRangeException

Thrown when the index is invalid.

Methods

Add(TItem)

Adds an item to the collection.

public virtual void Add(TItem item)

Parameters

item TItem

The item to add.

Exceptions

ArgumentNullException

Thrown when item is null and CheckNullableItems is true.

Clear()

Removes all items from the collection.

public virtual void Clear()

Contains(TItem)

Determines whether the collection contains a specific item.

public virtual bool Contains(TItem item)

Parameters

item TItem

The item to locate.

Returns

bool

True if the item is found; otherwise, false.

CopyTo(TItem[], int)

Copies the elements of the collection to an array.

public void CopyTo(TItem[] array, int index)

Parameters

array TItem[]

The destination array.

index int

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

GetEnumerator()

Returns an enumerator that iterates through the collection.

public virtual IEnumerator<TItem> GetEnumerator()

Returns

IEnumerator<TItem>

An enumerator for the collection.

IndexOf(TItem)

Returns the index of the specified item in the collection.

public abstract int IndexOf(TItem item)

Parameters

item TItem

The item to locate.

Returns

int

The zero-based index of the item, or -1 if not found.

Insert(int, TItem)

Inserts an item into the collection at the specified index.

public virtual void Insert(int index, TItem item)

Parameters

index int

The zero-based index at which to insert the item.

item TItem

The item to insert.

Exceptions

ArgumentOutOfRangeException

Thrown when the index is invalid.

OnAdd(TItem)

Adds an item to the inner collection.

protected virtual void OnAdd(TItem item)

Parameters

item TItem

The item to add.

OnAdded(TItem)

Invokes the Added event and notifies of a change after adding an item.

protected virtual void OnAdded(TItem item)

Parameters

item TItem

The added item.

OnAdding(TItem)

Invokes the Adding event before adding an item.

protected virtual bool OnAdding(TItem item)

Parameters

item TItem

The item to add.

Returns

bool

True if the addition should proceed; otherwise, false.

OnChanged()

Invokes the Changed event to notify of a modification in the collection.

protected virtual void OnChanged()

OnClear()

Removes all items from the inner collection.

protected virtual void OnClear()

OnCleared()

Invokes the Cleared event and notifies of a change after clearing the collection.

protected virtual void OnCleared()

OnClearing()

Invokes the Clearing event before clearing the collection.

protected virtual bool OnClearing()

Returns

bool

True if the clearing should proceed; otherwise, false.

OnGetItem(int)

Retrieves an item at the specified index from the inner collection.

protected abstract TItem OnGetItem(int index)

Parameters

index int

The zero-based index of the item to retrieve.

Returns

TItem

The item at the specified index.

OnInsert(int, TItem)

Inserts an item into the inner collection at the specified index.

protected abstract void OnInsert(int index, TItem item)

Parameters

index int

The zero-based index at which to insert the item.

item TItem

The item to insert.

OnInserted(int, TItem)

Invokes the Inserted event and notifies of a change after inserting an item.

protected virtual void OnInserted(int index, TItem item)

Parameters

index int

The zero-based index at which the item was inserted.

item TItem

The inserted item.

OnInserting(int, TItem)

Invokes the Inserting event before inserting an item.

protected virtual bool OnInserting(int index, TItem item)

Parameters

index int

The zero-based index at which to insert the item.

item TItem

The item to insert.

Returns

bool

True if the insertion should proceed; otherwise, false.

OnRemove(TItem)

Removes an item from the inner collection.

protected virtual bool OnRemove(TItem item)

Parameters

item TItem

The item to remove.

Returns

bool

True if the item was removed; otherwise, false.

OnRemoveAt(int)

Removes an item from the inner collection at the specified index.

protected abstract void OnRemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

OnRemoved(TItem)

Invokes the Removed event and notifies of a change after removing an item.

protected virtual void OnRemoved(TItem item)

Parameters

item TItem

The removed item.

OnRemovedAt(int)

Invokes the RemovedAt event and notifies of a change after removing an item at the specified index.

protected virtual void OnRemovedAt(int index)

Parameters

index int

The zero-based index of the removed item.

OnRemoving(TItem)

Invokes the Removing event before removing an item.

protected virtual bool OnRemoving(TItem item)

Parameters

item TItem

The item to remove.

Returns

bool

True if the removal should proceed; otherwise, false.

OnRemovingAt(int)

Invokes the RemovingAt event before removing an item at the specified index.

protected virtual bool OnRemovingAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Returns

bool

True if the removal should proceed; otherwise, false.

Remove(TItem)

Removes the specified item from the collection.

public virtual bool Remove(TItem item)

Parameters

item TItem

The item to remove.

Returns

bool

True if the item was removed; otherwise, false.

Exceptions

ArgumentNullException

Thrown when item is null and CheckNullableItems is true.

RemoveAt(int)

Removes the item at the specified index.

public virtual void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Events

Added

Occurs after an item has been added to the collection.

public event Action<TItem> Added

Event Type

Action<TItem>

Adding

Occurs before an item is added to the collection.

public event Func<TItem, bool> Adding

Event Type

Func<TItem, bool>

Changed

Occurs when the collection has been modified.

public event Action Changed

Event Type

Action

Cleared

Occurs after the collection has been cleared.

public event Action Cleared

Event Type

Action

Clearing

Occurs before the collection is cleared.

public event Func<bool> Clearing

Event Type

Func<bool>

Inserted

Occurs after an item has been inserted at the specified index.

public event Action<int, TItem> Inserted

Event Type

Action<int, TItem>

Inserting

Occurs before an item is inserted at the specified index.

public event Func<int, TItem, bool> Inserting

Event Type

Func<int, TItem, bool>

Removed

Occurs after an item has been removed from the collection.

public event Action<TItem> Removed

Event Type

Action<TItem>

RemovedAt

Occurs after an item has been removed at the specified index.

public event Action<int> RemovedAt

Event Type

Action<int>

Removing

Occurs before an item is removed from the collection.

public event Func<TItem, bool> Removing

Event Type

Func<TItem, bool>

RemovingAt

Occurs before an item is removed at the specified index.

public event Func<int, bool> RemovingAt

Event Type

Func<int, bool>