LocalValueEnumerator Struct

Definition

Namespace:

System.Windows

Assembly:

WindowsBase.dll

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

public value class LocalValueEnumerator : System::Collections::IEnumerator

public struct LocalValueEnumerator : System.Collections.IEnumerator

type LocalValueEnumerator = struct
    interface IEnumerator

Public Structure LocalValueEnumerator
Implements IEnumerator

Inheritance

Object

ValueType

LocalValueEnumerator

Implements

IEnumerator

Remarks

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.

Properties

Count	Gets the number of items that are represented in the collection.
Current	Gets the current element in the collection.

Methods

Equals(Object)	Determines whether the provided LocalValueEnumerator is equivalent to this LocalValueEnumerator.
GetHashCode()	Returns a hash code for the current LocalValueEnumerator.
MoveNext()	Advances the enumerator to the next element of the collection.
Reset()	Sets the enumerator to its initial position, which is before the first element in the collection.

Operators

Equality(LocalValueEnumerator, LocalValueEnumerator)	Compares whether two specified LocalValueEnumerator objects are the same.
Inequality(LocalValueEnumerator, LocalValueEnumerator)	Compares two specified LocalValueEnumerator objects to determine whether they are not the same.

Explicit Interface Implementations

IEnumerator.Current

For a description of this members, see Current.

See also

• DependencyObject