Class XmlDictionary

Namespace

NanoByte.Common.Collections

Assembly

NanoByte.Common.dll

A string dictionary that supports data-binding and can be XML serialized.

[Serializable]
public class XmlDictionary : BindingList<XmlDictionaryEntry>, ICloneable<XmlDictionary>

Inheritance

object

Collection<XmlDictionaryEntry>

BindingList<XmlDictionaryEntry>

XmlDictionary

Implements

ICloneable<XmlDictionary>

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

CollectionExtensions.AddIfNew<T>(ICollection<T>, T)

CollectionExtensions.Add<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

CollectionExtensions.RemoveAll<T>(ICollection<T>, Func<T, bool>)

CollectionExtensions.Remove<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

DictionaryExtensions.ToMultiDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TValue>)

EnumerableExtensions.CloneElements<T>(IEnumerable<T>)

EnumerableExtensions.ContainsAny<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.ContainsOrEmpty<T>(IEnumerable<T>, T)

EnumerableExtensions.DistinctBy<T, TKey>(IEnumerable<T>, Func<T, TKey>)

EnumerableExtensions.Except<T>(IEnumerable<T>, T)

EnumerableExtensions.Except<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.GetSequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.GetUnsequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.MaxBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

EnumerableExtensions.MinBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

EnumerableExtensions.Permutate<T>(IEnumerable<T>)

EnumerableExtensions.SequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.TopologicalSort<T>(IEnumerable<T>, Func<T, IEnumerable<T>>)

EnumerableExtensions.TrySelect<TSource, TResult, TException>(IEnumerable<TSource>, Func<TSource, TResult>, Action<TException>)

EnumerableExtensions.UnsequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.WhereNotNull<T>(IEnumerable<T?>)

Bucketizer.Bucketize<T>(IEnumerable<T>)

Bucketizer.Bucketize<TElement, TValue>(IEnumerable<TElement>, Func<TElement, TValue>)

ExceptionUtils.TryAnyAsync<T>(IEnumerable<T>, Func<T, Task>)

ExceptionUtils.TryAny<T>(IEnumerable<T>, Action<T>)

ListExtensions.AddRange<TList, TElements>(IList<TList>, IEnumerable<TElements>)

ListExtensions.GetAddedElements<T>(IList<T>?, IList<T>?, IComparer<T>)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

Methods

Add(string, string)

Adds a new value and links it to a key

public void Add(string key, string value)

Parameters

key string

The key object

value string

The value

Exceptions

ArgumentException

The key already exists in the dictionary.

Clone()

Creates a deep copy of this XmlDictionary (elements are cloned).

public virtual XmlDictionary Clone()

Returns

XmlDictionary

The cloned XmlDictionary.

ContainsKey(string)

Checks whether this collection contains a certain key.

public bool ContainsKey(string key)

Parameters

key string

The key to look for.

Returns

bool

true if the key was found.

ContainsValue(string)

Checks whether this collection contains a certain value.

public bool ContainsValue(string value)

Parameters

value string

The value to look for.

Returns

bool

true if the value was found.

GetValue(string)

Returns the value associated to a specific key.

public string GetValue(string key)

Parameters

key string

The key to look for.

Returns

string

The value associated to key.

Exceptions

KeyNotFoundException

key was not found in the collection.

InsertItem(int, XmlDictionaryEntry)

Inserts the specified item in the list at the specified index.

protected override void InsertItem(int index, XmlDictionaryEntry item)

Parameters

index int

The zero-based index where the item is to be inserted.

item XmlDictionaryEntry

The item to insert in the list.

Remove(string)

Removes all values assigned to this key.

public bool Remove(string key)

Parameters

key string

The key to look for.

Returns

bool

true if one or more elements were removed; otherwise, false.

Sort()

Sorts all entries alphabetically by their key.

public void Sort()

ToDictionary()

Convert this XmlDictionary to a System.Collections.Generic.Dictionary<TKey, TValue> for better lookup-performance.

public IDictionary<string, string> ToDictionary()

Returns

IDictionary<string, string>

A dictionary containing the same data as this collection.