Class KeyedCollection<TKey, TValue>

Namespace

Ecng.Collections

Assembly

Ecng.Collections.dll

Represents an abstract dictionary-backed collection that manages key-value pairs with customizable behavior.

public abstract class KeyedCollection<TKey, TValue> : IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

Type Parameters

TKey

The type of keys in the collection.

TValue

The type of values in the collection.

Inheritance

object

KeyedCollection<TKey, TValue>

Implements

IDictionary<TKey, TValue>

ICollection<KeyValuePair<TKey, TValue>>

IEnumerable<KeyValuePair<TKey, TValue>>

IEnumerable

Derived

PairSet<TKey, TValue>

SynchronizedKeyedCollection<TKey, TValue>

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.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.Add<TKey, TValue>(IDictionary<TKey, TValue>, (TKey key, TValue value))

CollectionHelper.GetAndRemove<TKey, TValue>(IDictionary<TKey, TValue>, TKey)

CollectionHelper.GetKeys<TKey, TValue>(IDictionary<TKey, TValue>, TValue)

CollectionHelper.SafeAddAsync<TKey, TValue>(IDictionary<TKey, TValue>, AsyncReaderWriterLock, TKey, Func<TKey, CancellationToken, Task<TValue>>, CancellationToken)

CollectionHelper.SafeAdd<TKey, TValue>(IDictionary<TKey, TValue>, TKey)

CollectionHelper.SafeAdd<TKey, TValue>(IDictionary<TKey, TValue>, TKey, out bool)

CollectionHelper.SafeAdd<TKey, TValue>(IDictionary<TKey, TValue>, TKey, Func<TKey, TValue>)

CollectionHelper.SafeAdd<TKey, TValue>(IDictionary<TKey, TValue>, TKey, Func<TKey, TValue>, out bool)

CollectionHelper.Sync<TKey, TValue>(IDictionary<TKey, TValue>)

CollectionHelper.TryAdd2<TKey, TValue>(IDictionary<TKey, TValue>, TKey, TValue)

CollectionHelper.TryGetAndRemove<TKey, TValue>(IDictionary<TKey, TValue>, TKey)

CollectionHelper.TryGetAndRemove<TKey, TValue>(IDictionary<TKey, TValue>, TKey, out TValue)

CollectionHelper.TryGetValue<TKey, TValue>(IDictionary<TKey, TValue>, TKey)

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.CopyTo<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>, IDictionary<TKey, TValue>)

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

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

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

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

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.LastOr<T>(IEnumerable<T>)

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<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>)

CollectionHelper.ToDictionary<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>, IEqualityComparer<TKey>)

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<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>)

CollectionHelper.ToPairSet<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>, IEqualityComparer<TKey>)

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.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

KeyedCollection()

Initializes a new instance of the KeyedCollection<TKey, TValue> class with a default dictionary.

protected KeyedCollection()

KeyedCollection(IDictionary<TKey, TValue>)

Represents an abstract dictionary-backed collection that manages key-value pairs with customizable behavior.

protected KeyedCollection(IDictionary<TKey, TValue> innerDictionary)

Parameters

innerDictionary IDictionary<TKey, TValue>

KeyedCollection(IEqualityComparer<TKey>)

Initializes a new instance of the KeyedCollection<TKey, TValue> class with a specified key comparer.

protected KeyedCollection(IEqualityComparer<TKey> comparer)

Parameters

comparer IEqualityComparer<TKey>

The equality comparer for keys, or null to use the default comparer.

Properties

Count

Gets the number of key-value pairs in the collection.

public virtual int Count { get; }

Property Value

int

InnerDictionary

Gets the underlying dictionary that stores the key-value pairs.

protected IDictionary<TKey, TValue> InnerDictionary { get; }

Property Value

IDictionary<TKey, TValue>

this[TKey]

Gets or sets the value associated with the specified key.

public virtual TValue this[TKey key] { get; set; }

Parameters

key TKey

The key whose value is to be retrieved or set.

Property Value

TValue

The value associated with the specified key.

Exceptions

KeyNotFoundException

Thrown when getting a value and the key is not found in the collection.

ArgumentNullException

Thrown when setting a value and key is null, if the underlying dictionary does not permit null keys.

Keys

Gets a collection containing the keys in the dictionary.

public ICollection<TKey> Keys { get; }

Property Value

ICollection<TKey>

Values

Gets a collection containing the values in the dictionary.

public ICollection<TValue> Values { get; }

Property Value

ICollection<TValue>

Methods

Add(KeyValuePair<TKey, TValue>)

Adds a key-value pair to the collection.

public void Add(KeyValuePair<TKey, TValue> item)

Parameters

item KeyValuePair<TKey, TValue>

The key-value pair to add.

Exceptions

ArgumentException

Thrown when the pair cannot be added, as determined by CanAdd(TKey, TValue).

Add(TKey, TValue)

Adds the specified key-value pair to the collection.

public virtual void Add(TKey key, TValue value)

Parameters

key TKey

The key to add.

value TValue

The value to add.

Exceptions

ArgumentException

Thrown when the key-value pair cannot be added, as determined by CanAdd(TKey, TValue).

ArgumentNullException

Thrown when key is null and the underlying dictionary does not permit null keys.

CanAdd(TKey, TValue)

Determines whether a key-value pair can be added to the collection.

protected virtual bool CanAdd(TKey key, TValue value)

Parameters

key TKey

The key to check.

value TValue

The value to check.

Returns

bool

True if the pair can be added; otherwise, false.

Remarks

This method is intended for derived classes to enforce custom addition constraints. The default implementation always returns true.

Clear()

Removes all items from the collection.

public virtual void Clear()

Contains(KeyValuePair<TKey, TValue>)

Determines whether the collection contains a specific key-value pair.

public bool Contains(KeyValuePair<TKey, TValue> item)

Parameters

item KeyValuePair<TKey, TValue>

The key-value pair to locate.

Returns

bool

True if the pair is found; otherwise, false.

Remarks

This implementation only checks the presence of the key, not the value equality.

ContainsKey(TKey)

Determines whether the collection contains an element with the specified key.

public bool ContainsKey(TKey key)

Parameters

key TKey

The key to locate.

Returns

bool

True if the key is found; otherwise, false.

CopyTo(KeyValuePair<TKey, TValue>[], int)

Copies the elements of the collection to an array, starting at the specified index.

public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)

Parameters

array KeyValuePair<TKey, TValue>[]

The destination array to copy to.

arrayIndex int

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

Exceptions

ArgumentNullException

Thrown when array is null.

ArgumentOutOfRangeException

Thrown when arrayIndex is negative.

ArgumentException

Thrown when the destination array is too small to accommodate the elements.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public virtual IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<TKey, TValue>>

An IEnumerator<T> that can be used to iterate through the collection.

OnAdded(TKey, TValue)

Called after a key-value pair has been added to the collection.

protected virtual void OnAdded(TKey key, TValue value)

Parameters

key TKey

The key that was added.

value TValue

The value that was added.

Remarks

This method is intended for derived classes to implement custom logic after an addition occurs.

OnAdding(TKey, TValue)

Called before adding a key-value pair to the collection.

protected virtual void OnAdding(TKey key, TValue value)

Parameters

key TKey

The key being added.

value TValue

The value being added.

Remarks

This method is intended for derived classes to implement custom logic before an addition occurs.

OnCleared()

Called after all items have been cleared from the collection.

protected virtual void OnCleared()

Remarks

This method is intended for derived classes to implement custom logic after clearing occurs.

OnClearing()

Called before clearing all items from the collection.

protected virtual void OnClearing()

Remarks

This method is intended for derived classes to implement custom logic before clearing occurs.

OnRemoved(TKey, TValue)

Called after a key-value pair has been removed from the collection.

protected virtual void OnRemoved(TKey key, TValue value)

Parameters

key TKey

The key that was removed.

value TValue

The value that was removed.

Remarks

This method is intended for derived classes to implement custom logic after a removal occurs.

OnRemoving(TKey, TValue)

Called before removing a key-value pair from the collection.

protected virtual void OnRemoving(TKey key, TValue value)

Parameters

key TKey

The key being removed.

value TValue

The value being removed.

Remarks

This method is intended for derived classes to implement custom logic before a removal occurs.

OnSetted(TKey, TValue)

Called after a new value has been set for an existing key.

protected virtual void OnSetted(TKey key, TValue value)

Parameters

key TKey

The key that was updated.

value TValue

The new value that was set.

Remarks

This method is intended for derived classes to implement custom logic after a value is updated.

OnSetting(TKey, TValue)

Called before setting a new value for an existing key.

protected virtual void OnSetting(TKey key, TValue value)

Parameters

key TKey

The key being updated.

value TValue

The new value to set.

Remarks

This method is intended for derived classes to implement custom logic before a value is updated.

Remove(KeyValuePair<TKey, TValue>)

Removes a specific key-value pair from the collection.

public bool Remove(KeyValuePair<TKey, TValue> item)

Parameters

item KeyValuePair<TKey, TValue>

The key-value pair to remove.

Returns

bool

True if the pair was found and removed; otherwise, false.

Remarks

This implementation only considers the key for removal, ignoring the value in item.

Remove(TKey)

Removes the value with the specified key from the collection.

public virtual bool Remove(TKey key)

Parameters

key TKey

The key of the element to remove.

Returns

bool

True if the element was found and removed; otherwise, false.

TryGetValue(TKey, out TValue)

Attempts to retrieve the value associated with the specified key.

public virtual bool TryGetValue(TKey key, out TValue value)

Parameters

key TKey

The key to locate.

value TValue

When this method returns, contains the value associated with the key if found; otherwise, the default value of TValue.

Returns

bool

True if the key was found; otherwise, false.