Show / Hide Table of Contents

    Interface IReadOnlyConfigurationDictionary<TElement>

    Represents a read-only dictionary of values stored in a property, keyed against a string value. Use the interface for properties representing an arbitrary number of the same kind of object identified by unique string keys. Items cannot be added or removed.

    Inherited Members
    IConfigurationDictionary<TElement>.AddCopy(String, TElement)
    IConfigurationDictionary<TElement>.AddNew(String)
    IConfigurationDictionary<TElement>.Contains(TElement)
    System.Collections.Generic.IDictionary<System.String, TElement>.Add(System.String, TElement)
    System.Collections.Generic.IDictionary<System.String, TElement>.ContainsKey(System.String)
    System.Collections.Generic.IDictionary<System.String, TElement>.Remove(System.String)
    System.Collections.Generic.IDictionary<System.String, TElement>.TryGetValue(System.String, TElement)
    System.Collections.Generic.IDictionary<System.String, TElement>.Item[System.String]
    System.Collections.Generic.IDictionary<System.String, TElement>.Keys
    System.Collections.Generic.IDictionary<System.String, TElement>.Values
    System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TElement>>.Add(System.Collections.Generic.KeyValuePair<System.String, TElement>)
    System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TElement>>.Clear()
    System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TElement>>.Contains(System.Collections.Generic.KeyValuePair<System.String, TElement>)
    System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TElement>>.CopyTo(System.Collections.Generic.KeyValuePair<System.String, TElement>[], System.Int32)
    System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TElement>>.Remove(System.Collections.Generic.KeyValuePair<System.String, TElement>)
    System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TElement>>.Count
    System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TElement>>.IsReadOnly
    System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged
    IConfigurationObject.IsDirty
    IConfigurationObject.Delete()
    IConfigurationObject.Load()
    IConfigurationObject.Save()
    System.IDisposable.Dispose()
    System.ComponentModel.INotifyPropertyChanged.PropertyChanged
    System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, TElement>>.GetEnumerator()
    System.Collections.IEnumerable.GetEnumerator()
    Namespace: OpenCollar.Extensions.Configuration
    Assembly: OpenCollar.Extensions.Configuration.dll
    Syntax
    public interface IReadOnlyConfigurationDictionary<TElement> : IConfigurationDictionary<TElement>, IDictionary<string, TElement>, ICollection<KeyValuePair<string, TElement>>, INotifyCollectionChanged, IConfigurationObject, IDisposable, INotifyPropertyChanged, IReadOnlyDictionary<string, TElement>, IReadOnlyCollection<KeyValuePair<string, TElement>>, IEnumerable<KeyValuePair<string, TElement>>, IEnumerable
    Type Parameters
    Name Description
    TElement

    The type of the dictionary element. This must be nullable if the type is a reference type and can be null.

    Remarks

    The following UML has been generated directly from the source code using Jebbs PlantUML .

    Examples

    In the example below a property on an interface is defined as containing an arbitray number of strings.

    IConfigurationDictionary<string> Names
    {
    get; set;
    }

    If the configuration is specified in a JSON configuration file it would look something like this:

    {
    "Names": {
        "First": "Value 1",
        "Second": "Value 2",
        "Third": "Value 3"
    }
    }

    See Also

    System.Collections.Generic.IReadOnlyDictionary`2
    IConfigurationDictionary<TElement>
    • Improve this Doc
    • View Source
    Back to top
    Copyright © 2019-2020 Jonathan Evans
    Version: 0.2.232