ClearValue Method (DependencyProperty)
Collapse the table of content
Expand the table of content

DependencyObject.ClearValue Method (DependencyProperty)

 

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.

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

Public Sub ClearValue (
	dp As DependencyProperty
)

Parameters

dp
Type: System.Windows.DependencyProperty

The dependency property to be cleared, identified by a DependencyProperty object reference.

Exception Condition
InvalidOperationException

Attempted to call ClearValue on a sealed DependencyObject.

Clearing the property value by calling ClearValue does not necessarily give a dependency property the default value that is specified in the dependency property metadata. Clearing the property only specifically clears whatever local value may have been applied. For more information, see Dependency Property Value Precedence.

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.

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

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show:
© 2016 Microsoft