DependencyObject.GetLocalValueEnumerator メソッド


どの依存関係プロパティがこの DependencyObject 上にローカルに設定された値を持つかを確認するための、専用の列挙子を作成します。Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

 System::Windows::LocalValueEnumerator GetLocalValueEnumerator();
public System.Windows.LocalValueEnumerator GetLocalValueEnumerator ();
member this.GetLocalValueEnumerator : unit -> System.Windows.LocalValueEnumerator
Public Function GetLocalValueEnumerator () As LocalValueEnumerator


専用のローカル値列挙子。A specialized local value enumerator.

次の例では、オブジェクトに対してローカル値が設定されているすべてのプロパティを反復処理し、ClearValue を呼び出して、各プロパティの値をクリアします。The following example iterates all properties that have local values set on an object, then calls ClearValue to clear the values of each such property.

void RestoreDefaultProperties(object sender, RoutedEventArgs e)
    UIElementCollection uic = Sandbox.Children;
    foreach (Shape uie in uic)
        LocalValueEnumerator locallySetProperties = uie.GetLocalValueEnumerator();
        while (locallySetProperties.MoveNext())
            DependencyProperty propertyToClear = locallySetProperties.Current.Property;
            if (!propertyToClear.ReadOnly) { uie.ClearValue(propertyToClear); }
Private Sub RestoreDefaultProperties(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim uic As UIElementCollection = Sandbox.Children
    For Each uie As Shape In uic
        Dim locallySetProperties As LocalValueEnumerator = uie.GetLocalValueEnumerator()
        While locallySetProperties.MoveNext()
            Dim propertyToClear As DependencyProperty = locallySetProperties.Current.Property
            If Not propertyToClear.ReadOnly Then
            End If
        End While
End Sub


ローカル値は、プロパティシステムの他の側面とは対照的に、SetValueによって設定された依存関係プロパティの値です。A local value is any dependency property value that was set by SetValue, as opposed to other aspects of the property system.

GetLocalValueEnumerator を呼び出すことによって取得された LocalValueEnumerator は、DependencyObject インスタンスにローカルに設定された値を持つプロパティを列挙するために使用できます。The LocalValueEnumerator obtained by calling GetLocalValueEnumerator can be used to enumerate properties that have a locally set value on a DependencyObject instance. このようなプロパティは、列挙子で LocalValueEntry オブジェクトによって表されます。このオブジェクトには、特定の DependencyProperty とその値を参照するプロパティがあります。Each such property is represented in the enumerator by a LocalValueEntry object, which has properties that reference the specific DependencyProperty and its values. ローカルに設定された値を列挙するこの手法は、最適化やローカル値のその他の処理に使用できます。たとえば、クリアされた場合に、DependencyObject のプロパティ値が変更されるかどうかを判断するために使用できます。This technique of enumerating over the locally set values can be used for optimization or for other handling of local values, such as to determine which property values of a DependencyObject would change if they were cleared.


返される LocalValueEnumerator には、読み取り専用の依存関係プロパティ、またはプロパティシステムによって値が計算される依存関係プロパティの LocalValueEntry レコードが含まれている場合があります。The returned LocalValueEnumerator might contain LocalValueEntry records for dependency properties that are read-only, or dependency properties where values are calculated by the property system. たとえば、レイアウトによって幅が確立された visual framework 要素は、ActualWidthのローカル値を報告します。For example, a visual framework element that has an established width through layout will report a local value for ActualWidth. リセットのためにローカル値を取得している場合は、各 LocalValueEntry のプロパティ識別子の ReadOnly 値を確認し、該当する DependencyProperty が読み取り専用ではないことを確認します。If you are getting local values in order to reset them, check the ReadOnly value on the property identifier of each LocalValueEntry to verify that the DependencyProperty in question is not read-only.