ResourceSet.GetEnumerator Method

Syntax

'Declaration
<ComVisibleAttribute(False)> _
Public Overridable Function GetEnumerator As IDictionaryEnumerator

[ComVisibleAttribute(false)]
public virtual IDictionaryEnumerator GetEnumerator()

Exceptions

Remarks

Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.

Initially, the enumerator is positioned before the first element in the collection. Reset also brings the enumerator back to this position. At this position, calling Current throws an exception. Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current returns the same object until either MoveNext or Reset is called. MoveNext sets Current to the next element.

After the end of the collection is passed, the enumerator is positioned after the last element in the collection, and calling MoveNext returns false. If the last call to MoveNext returned false, calling Current throws an exception. To set Current to the first element of the collection again, you can call Reset followed by MoveNext.

An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting elements, the enumerator is irrecoverably invalidated and the next call to MoveNext or Reset throws an InvalidOperationException. If the collection is modified between MoveNext and Current, Current will return the element that it is set to, even if the enumerator is already invalidated.

You can use the IDictionaryEnumerator.Entry property to access the value stored in the current element. Use the IDictionaryEnumerator.Key property to access the key of the current element. Use the IDictionaryEnumerator.Value property to access the value of the current element.

The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

Examples

The following example demonstrates how to create a ResourceSetrs for the file items.resources. Next, the GetEnumerator method is used to create an IDictionaryEnumerator for rs. The IDictionaryEnumerator iterates through rs and displays the contents to the console.

Imports System.Resources
Imports System.Collections

Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Create a ResourceSet for the file items.resources.
      Dim rs As New ResourceSet("items.resources")

      ' Create an IDictionaryEnumerator to read the data in the ResourceSet.
      Dim id As IDictionaryEnumerator = rs.GetEnumerator()

      ' Iterate through the ResourceSet and display the contents. 
      While id.MoveNext()
         outputBlock.Text += String.Format(ControlChars.NewLine + "[{0}] " + ControlChars.Tab + "{1}", id.Key, id.Value) & vbCrLf
      End While

      rs.Close()

   End Sub

End Class

using System;
using System.Resources;
using System.Collections;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // Create a ResourceSet for the file items.resources.
      ResourceSet rs = new ResourceSet("items.resources");


      // Create an IDictionaryEnumerator to read the data in the ResourceSet.
      IDictionaryEnumerator id = rs.GetEnumerator();

      // Iterate through the ResourceSet and display the contents. 
      while (id.MoveNext())
         outputBlock.Text += String.Format("\n[{0}] \t{1}", id.Key, id.Value) + "\n";

      rs.Close();

   }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference