This documentation is archived and is not being maintained.

LocalValueEnumerator Structure

Provides enumeration support for the local values of any dependency properties that exist on a DependencyObject.

Namespace:  System.Windows
Assembly:  WindowsBase (in WindowsBase.dll)

public struct LocalValueEnumerator : IEnumerator

The LocalValueEnumerator type exposes the following members.

Public propertyCountGets the number of items that are represented in the collection.
Public propertyCurrentGets the current element in the collection.

Public methodEqualsDetermines whether the provided LocalValueEnumerator is equivalent to this LocalValueEnumerator. (Overrides ValueType.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns a hash code for the current LocalValueEnumerator. (Overrides ValueType.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMoveNextAdvances the enumerator to the next element of the collection.
Public methodResetSets the enumerator to its initial position, which is before the first element in the collection.
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

Public operatorStatic memberEqualityCompares whether two specified LocalValueEnumerator objects are the same.
Public operatorStatic memberInequalityCompares two specified LocalValueEnumerator objects to determine whether they are not the same.

Explicit interface implemetationPrivate propertyIEnumerator.CurrentFor a description of this members, see Current.

A local value is a value for a dependency property that was set directly on a dependency property, by calling SetValue, or more typically by using the set accessor of a CLR property wrapper that calls SetValue internally. Examples of other property system determinants that are not local values are values set through styles, or dependency property default values. For details, see Dependency Property Value Precedence.

A LocalValueEnumerator is returned by the GetLocalValueEnumerator method and implements the IEnumerator interface. A public LocalValueEnumerator constructor does not exist; therefore, you must call GetLocalValueEnumerator to obtain an instance of this class.

Do not modify local values (by calling SetValue or ClearValue) while enumerating local values. If you change or clear the property values based on properties that are returned by the enumerator, the change or clear operations do not invalidate the enumerator collection, as is the case for many IEnumerator implementations. Also, the enumerator view is a snapshot. A change to the collection is not guaranteed to be thread safe, and no lock is enforced. Other threads still have free access to the local values from a context other than the enumerator.

Use this type if you have operations in your class where it is important to know whether a property's value came from a local value. For example, use this type in an OnPropertyChanged implementation, or where you want to query the metadata on all locally set properties.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.