Class SwiftObservableDictionary<TKey, TValue>

Namespace

SwiftCollections.Observable

Assembly

SwiftCollections.dll

Represents a dictionary that notifies listeners of changes to its items and structure.

[JsonConverter(typeof(StateJsonConverterFactory))]
[MemoryPackable(GenerateType.Object)]
public class SwiftObservableDictionary<TKey, TValue> : SwiftDictionary<TKey, TValue>, IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IDictionary, ICollection, IEnumerable, IMemoryPackable<SwiftDictionary<TKey, TValue>>, IStateBacked<SwiftDictionaryState<TKey, TValue>>, INotifyPropertyChanged, INotifyCollectionChanged, IMemoryPackable<SwiftObservableDictionary<TKey, TValue>>, IMemoryPackFormatterRegister where TKey : notnull

Type Parameters

TKey

The type of keys in the dictionary.

TValue

The type of values in the dictionary.

Inheritance

object

SwiftDictionary<TKey, TValue>

SwiftObservableDictionary<TKey, TValue>

Implements

IDictionary<TKey, TValue>

ICollection<KeyValuePair<TKey, TValue>>

IEnumerable<KeyValuePair<TKey, TValue>>

IDictionary

ICollection

IEnumerable

IMemoryPackable<SwiftDictionary<TKey, TValue>>

IStateBacked<SwiftDictionaryState<TKey, TValue>>

INotifyPropertyChanged

INotifyCollectionChanged

IMemoryPackable<SwiftObservableDictionary<TKey, TValue>>

IMemoryPackFormatterRegister

Inherited Members

SwiftDictionary<TKey, TValue>.DefaultCapacity

SwiftDictionary<TKey, TValue>._entries

SwiftDictionary<TKey, TValue>._comparer

SwiftDictionary<TKey, TValue>._version

SwiftDictionary<TKey, TValue>.Add(TKey, TValue)

SwiftDictionary<TKey, TValue>.Add(KeyValuePair<TKey, TValue>)

SwiftDictionary<TKey, TValue>.Add(object, object)

SwiftDictionary<TKey, TValue>.Remove(TKey)

SwiftDictionary<TKey, TValue>.Remove(KeyValuePair<TKey, TValue>)

SwiftDictionary<TKey, TValue>.Clear()

SwiftDictionary<TKey, TValue>.CheckLoadThreshold()

SwiftDictionary<TKey, TValue>.EnsureCapacity(int)

SwiftDictionary<TKey, TValue>.TrimExcess()

SwiftDictionary<TKey, TValue>.ContainsKey(TKey)

SwiftDictionary<TKey, TValue>.Contains(KeyValuePair<TKey, TValue>)

SwiftDictionary<TKey, TValue>.TryGetValue(TKey, out TValue)

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

SwiftDictionary<TKey, TValue>.CopyTo(Array, int)

SwiftDictionary<TKey, TValue>.SetComparer(IEqualityComparer<TKey>)

SwiftDictionary<TKey, TValue>.FindEntry(TKey)

SwiftDictionary<TKey, TValue>.GetEnumerator()

SwiftDictionary<TKey, TValue>.Count

SwiftDictionary<TKey, TValue>.Capacity

SwiftDictionary<TKey, TValue>.Comparer

SwiftDictionary<TKey, TValue>.this[TKey]

SwiftDictionary<TKey, TValue>.Keys

SwiftDictionary<TKey, TValue>.Values

SwiftDictionary<TKey, TValue>.SyncRoot

SwiftDictionary<TKey, TValue>.State

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

SwiftExtensions.FromEnd<T>(IEnumerable<T>, int)

SwiftExtensions.IsPopulatedSafe<T>(IEnumerable<T>)

SwiftExtensions.IsPopulated<T>(IEnumerable<T>)

SwiftExtensions.PopLast<T>(IEnumerable<T>)

SwiftExtensions.SecondToLast<T>(IEnumerable<T>)

SwiftExtensions.Shuffle<T>(IEnumerable<T>, Random)

SwiftExtensions.SkipFromEnd<T>(IEnumerable<T>, int)

Remarks

MemoryPack GenerateType: Object

SwiftCollections.SwiftDictionaryState<TKey, TValue> State

Constructors

SwiftObservableDictionary()

Initializes a new instance of the SwiftObservableDictionary class.

public SwiftObservableDictionary()

SwiftObservableDictionary(SwiftDictionaryState<TKey, TValue>)

Initializes a new instance of the SwiftObservableDictionary<TKey, TValue> class with the specified SwiftDictionaryState<TKey, TValue>.

[MemoryPackConstructor]
public SwiftObservableDictionary(SwiftDictionaryState<TKey, TValue> state)

Parameters

state SwiftDictionaryState<TKey, TValue>

The state containing the internal array, count, offset, and version for initialization.

Properties

this[TKey]

Gets or sets the value associated with the specified key. Raises property and collection change notifications.

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

Parameters

key TKey

Property Value

TValue

Methods

Add(TKey, TValue)

Adds an element with the provided key and value to the dictionary. Raises a collection change notification.

public override bool Add(TKey key, TValue value)

Parameters

key TKey

value TValue

Returns

bool

Clear()

Clears all elements from the dictionary. Raises a reset collection change notification.

public override void Clear()

OnCollectionChanged(NotifyCollectionChangedEventArgs)

Raises the CollectionChanged event for the specified action and items.

protected virtual void OnCollectionChanged(NotifyCollectionChangedEventArgs args)

Parameters

args NotifyCollectionChangedEventArgs

OnPropertyChanged(string)

Raises the PropertyChanged event.

protected virtual void OnPropertyChanged(string propertyName)

Parameters

propertyName string

The name of the property that changed.

Remove(TKey)

Removes the element with the specified key from the dictionary. Raises a collection change notification if the key existed.

public override bool Remove(TKey key)

Parameters

key TKey

Returns

bool

Events

CollectionChanged

Raised when the dictionary's collection is modified.

public event NotifyCollectionChangedEventHandler? CollectionChanged

Event Type

NotifyCollectionChangedEventHandler

PropertyChanged

Raised when a property on the dictionary changes.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler