Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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 void ClearValue (
	DependencyProperty dp
)
public void ClearValue (
	DependencyProperty dp
)
public function ClearValue (
	dp : DependencyProperty
)
You cannot use methods in XAML.

Parameters

dp

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

Exception typeCondition

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; it 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.

void RestoreDefaultProperties(object sender, RoutedEventArgs e)
{
    UIElementCollection uic = Sandbox.Children;
    foreach (Shape uie in uic)
    {
        LocalValueEnumerator locallySetProperties = uie.GetLocalValueEnumerator();
        while (locallySetProperties.MoveNext())
        {
            DependencyProperty propertyToClear = (DependencyProperty)locallySetProperties.Current.Property;
            if (!propertyToClear.ReadOnly) { uie.ClearValue(propertyToClear); }
        }
    }
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

Show:
© 2014 Microsoft