OrderedDictionary.IsReadOnly Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value indicating whether the OrderedDictionary collection is read-only.

Namespace:   System.Collections.Specialized
Assembly:  System (in System.dll)

public bool IsReadOnly { get; }

Property Value

Type: System.Boolean

true if the OrderedDictionary collection is read-only; otherwise, false. The default is false.

A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created.

A collection that is read-only is simply a collection with a wrapper that prevents modification of the collection; therefore, if changes are made to the underlying collection, the read-only collection reflects those changes.

The following code example demonstrates the modification of an OrderedDictionary collection. In this example, the IsReadOnly property is used to determine whether the OrderedDictionary can be modified. This code is part of a larger code example that can be viewed at OrderedDictionary.

// Modifying the OrderedDictionary
if (!myOrderedDictionary.IsReadOnly)
{
    // Insert a new key to the beginning of the OrderedDictionary
    myOrderedDictionary.Insert(0, "insertedKey1", "insertedValue1");

    // Modify the value of the entry with the key "testKey2"
    myOrderedDictionary["testKey2"] = "modifiedValue";

    // Remove the last entry from the OrderedDictionary: "testKey3"
    myOrderedDictionary.RemoveAt(myOrderedDictionary.Count - 1);

    // Remove the "keyToDelete" entry, if it exists
    if (myOrderedDictionary.Contains("keyToDelete"))
    {
        myOrderedDictionary.Remove("keyToDelete");
    }
}

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Return to top
Show: