DependencyObject.ClearValue Method (DependencyProperty) (System.Windows)

Switch View :

ScriptFree

.NET Framework Class Library

DependencyObject.ClearValue Method (DependencyProperty)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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)

Syntax

Visual Basic

Public Sub ClearValue ( _
	dp As DependencyProperty _
)

public void ClearValue(
	DependencyProperty dp
)

Visual C++

public:
void ClearValue(
	DependencyProperty^ dp
)

member ClearValue : 
        dp:DependencyProperty -> unit

Parameters

dp: Type: System.Windows.DependencyProperty
The dependency property to be cleared, identified by a DependencyProperty object reference.

Exceptions

Exception	Condition
InvalidOperationException	Attempted to call ClearValue on a sealed DependencyObject.

Remarks

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.

Examples

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.

Visual Basic


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


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); }
        }
    }
}

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

DependencyObject Class

ClearValue Overload

System.Windows Namespace

SetValue

IsSealed

DependencyProperty

Other Resources

Dependency Property Value Precedence

Dependency Properties Overview