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

Switch View :
ScriptFree
.NET Framework Class Library
DependencyObject.ClearValue Method (DependencyPropertyKey)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.

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

Visual Basic (Declaration)
Public Sub ClearValue ( _
	key As DependencyPropertyKey _
)
Visual Basic (Usage)
Dim instance As DependencyObject
Dim key As DependencyPropertyKey

instance.ClearValue(key)
C#
public void ClearValue(
	DependencyPropertyKey key
)
Visual C++
public:
void ClearValue(
	DependencyPropertyKey^ key
)
JScript
public function ClearValue(
	key : DependencyPropertyKey
)
XAML
You cannot use methods in XAML.

Parameters

key
Type: System.Windows.DependencyPropertyKey
The key for the dependency property to be cleared.
Exceptions

Exception Condition
InvalidOperationException

Attempted to call ClearValue on a sealed DependencyObject.

Remarks

A DependencyPropertyKey identifies a read-only dependency property for property system operations. Classes that define read-only dependency properties should not expose this key with public access. A publicly exposed key would provide a public code pathway that negated the read-only character of the property, if methods such as ClearValue or SetValue could be called outside the class or assembly, referencing the key.

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 value only specifically clears whatever local value may have been applied. For more information, see Dependency Property Value Precedence.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0
See Also

Reference

Other Resources