Table of Contents

Class EnumReadOnlyDictionary<TEnum>

Namespace
Cuemon.Collections.Generic
Assembly
Cuemon.Core.dll

Represents a read-only collection of key/value pairs that provides information about the specified TEnum. Implements the ReadOnlyDictionary<TKey, TValue>

public class EnumReadOnlyDictionary<TEnum> : ReadOnlyDictionary<IConvertible, string>, IDictionary<IConvertible, string>, ICollection<KeyValuePair<IConvertible, string>>, IReadOnlyDictionary<IConvertible, string>, IReadOnlyCollection<KeyValuePair<IConvertible, string>>, IEnumerable<KeyValuePair<IConvertible, string>>, IDictionary, ICollection, IEnumerable where TEnum : struct, IConvertible

Type Parameters

TEnum

The type of the enumeration.

Inheritance
EnumReadOnlyDictionary<TEnum>
Implements
Inherited Members

Examples

The following example demonstrates how to use to create a read-only dictionary that maps each enum value (as its underlying integral type wrapped in ) to its string name.

using System.Collections.Generic;
using System;
using System.Linq;
using Cuemon.Collections.Generic;

namespace MyApp.Examples;

public class EnumReadOnlyDictionaryExample
{
    public void Demonstrate()
    {
        // Create a dictionary that maps DayOfWeek values to their string names
        var days = new EnumReadOnlyDictionary<DayOfWeek>();

        Console.WriteLine(days.Count); // 7

        // Iterate through all entries (keys are the underlying integral values)
        foreach (var kvp in days.OrderBy(kvp => kvp.Key.ToInt32(null)))
        {
            Console.WriteLine($"{kvp.Key.ToInt32(null)} -> {kvp.Value}");
        // Output:
        //   0 -> Sunday
        //   1 -> Monday
        //   2 -> Tuesday
        //   3 -> Wednesday
        //   4 -> Thursday
        //   5 -> Friday
        //   6 -> Saturday

        // Access the values collection directly
        foreach (var name in days.Values)
        {
            Console.WriteLine(name); // Sunday, Monday, ..., Saturday

        // Access the keys collection
        foreach (var key in days.Keys)
        {
            Console.WriteLine(key.ToInt32(null)); // 0, 1, 2, ..., 6

}}}}
}

Constructors

EnumReadOnlyDictionary()

Initializes a new instance of the EnumReadOnlyDictionary<TEnum> class.

public EnumReadOnlyDictionary()

Exceptions

TypeArgumentException

TEnum does not represents an enumeration.

InvalidOperationException

TEnum is a type from an assembly loaded in a reflection-only context.

See Also

ReadOnlyDictionary<TKey, TValue>
Edit this page