This documentation is archived and is not being maintained.

OrderedDictionary.Clear Method

Removes all elements from the OrderedDictionary collection.

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

public void Clear()

Implements

IDictionary.Clear()

ExceptionCondition
NotSupportedException

The OrderedDictionary collection is read-only.

After calling the Clear method, the Count property is set to zero and references to other objects from elements of the collection are also released. The capacity is not changed as a result of calling this method.

The following code example demonstrates the modification of an OrderedDictionary collection. In this example, the Clear method is used to empty the OrderedDictionary, and then the OrderedDictionary is repopulated. This code is part of a larger code example that can be viewed at OrderedDictionary.


// Clear the OrderedDictionary and add new values
myOrderedDictionary.Clear();
myOrderedDictionary.Add("newKey1", "newValue1");
myOrderedDictionary.Add("newKey2", "newValue2");
myOrderedDictionary.Add("newKey3", "newValue3");

// Display the contents of the "new" Dictionary using an enumerator
IDictionaryEnumerator myEnumerator =
    myOrderedDictionary.GetEnumerator();

Console.WriteLine(
    "{0}Displaying the entries of a \"new\" OrderedDictionary.",
    Environment.NewLine);

DisplayEnumerator(myEnumerator);


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: