Export (0) Print
Expand All

PropertyMetadata.CoerceValueCallback Property

Gets or sets a reference to a CoerceValueCallback implementation specified in this metadata.

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

public CoerceValueCallback CoerceValueCallback { get; set; }

Property Value

Type: System.Windows.CoerceValueCallback
A CoerceValueCallback implementation reference.

ExceptionCondition
InvalidOperationException

Cannot set a metadata property once it is applied to a dependency property operation.

The callbacks in property metadata are not typically public members on the containing type, so the value of this property is not important for most scenarios that just consume an existing dependency property's metadata. One reason this property is exposed is so that metadata subclasses can perform their desired merge logic if both base metadata and overriding/adding metadata specify a CoerceValueCallback. However, the default merge logic for a CoerceValueCallback is to replace the previous one.

CoerceValueCallback is defined in the object model as read-write. This is so CoerceValueCallback can be adjusted after initialization of the PropertyMetadata object itself. However, once the metadata is consumed as part of a call to Register, AddOwner, or OverrideMetadata, the property system will seal that metadata instance and the properties are now considered immutable. Attempting to set CoerceValueCallback once IsSealed is true on this metadata instance will raise an exception.

.NET Framework

Supported in: 4.5.2, 4.5.1, 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