Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

OrderedDictionary.Clear Method

Removes all elements from the OrderedDictionary collection.

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

public void Clear ()
public final void Clear ()
public final function Clear ()
Not applicable.

Exception typeCondition

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);

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft