DependencyObject.GetLocalValueEnumerator Method

Definition

Crée un énumérateur spécialisé pour déterminer quelles propriétés de dépendance ont des valeurs définies localement sur ce DependencyObject.Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

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

Returns

LocalValueEnumerator

Un énumérateur de valeur de proximité spécialisé.A specialized local value enumerator.

Examples

L’exemple suivant itère toutes les propriétés dont les valeurs locales sont définies sur un objet, puis appelle ClearValue pour effacer les valeurs de chaque propriété de ce type.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
                uie.ClearValue(propertyToClear)
            End If
        End While
    Next
End Sub

Remarks

Une valeur locale est toute valeur de propriété de dépendance qui a été définie par SetValue, par opposition à d’autres aspects du système de propriétés.A local value is any dependency property value that was set by SetValue, as opposed to other aspects of the property system.

Les LocalValueEnumerator obtenus en appelant GetLocalValueEnumerator peuvent être utilisées pour énumérer les propriétés qui ont une valeur localement définie sur une instance de DependencyObject.The LocalValueEnumerator obtained by calling GetLocalValueEnumerator can be used to enumerate properties that have a locally set value on a DependencyObject instance. Chaque propriété de ce type est représentée dans l’énumérateur par un objet LocalValueEntry, qui a des propriétés qui référencent le DependencyProperty spécifique et ses valeurs.Each such property is represented in the enumerator by a LocalValueEntry object, which has properties that reference the specific DependencyProperty and its values. Cette technique d’énumération sur les valeurs définies localement peut être utilisée pour l’optimisation ou pour d’autres manipulations de valeurs locales, telles que pour déterminer les valeurs de propriété d’un DependencyObject changent si elles ont été effacées.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.

Important

La LocalValueEnumerator retournée peut contenir des enregistrements LocalValueEntry pour les propriétés de dépendance qui sont en lecture seule, ou des propriétés de dépendance où les valeurs sont calculées par le système de propriétés.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. Par exemple, un élément Visual Framework qui a une largeur établie à travers la disposition signale une valeur locale pour ActualWidth.For example, a visual framework element that has an established width through layout will report a local value for ActualWidth. Si vous obtenez des valeurs locales pour les réinitialiser, vérifiez la valeur ReadOnly sur l’identificateur de propriété de chaque LocalValueEntry pour vérifier que le DependencyProperty en question n’est pas en lecture seule.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.

Applies to

See also