Export (0) Print
Expand All

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
)

Parameters

dp
Type: System.Windows.DependencyProperty

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

ExceptionCondition
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.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.

Show:
© 2014 Microsoft