Expand Minimize

ValidateValueCallback Delegate

Represents a method used as a callback that validates the effective value of a dependency property.

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

type ValidateValueCallback = 
    delegate of  
        value:Object -> bool

Parameters

value
Type: System.Object

The value to be validated.

Return Value

Type: System.Boolean
true if the value was validated; false if the submitted value was invalid.

Callbacks based on this delegate are used by certain signatures of DependencyProperty.Register and related methods, such as RegisterAttached and read-only equivalents. You should use signatures that take the validateValueCallback parameter if you want specific validation of the property value each time that its effective is set. You should then implement this callback such that it performs the actual validation of the proposed value. The callback should return true if the value submitted to the callback is valid, and false otherwise. A false value will produce an exception in the specific portion of the property system where the invalid property set was attempted, so your application should be prepared to handle these exceptions.

Validation callbacks are stored on dependency property identifiers, rather than dependency property metadata. Your validation callback does not have access to a specific instance of a DependencyObject on which the property is set, and can only influence what values are accepted for the property in general. If you need a callback that can change property values based on a specific instance, you should use a combination of a CoerceValueCallback and PropertyChangedCallback callbacks as applied to the property metadata of your property. You might also apply these callbacks to related properties that should influence your property's value. For details, see Dependency Property Callbacks and Validation.

The following example includes an implementation of this callback to validate a range of values for a custom dependency property. In this case the property value expects an enumeration, and the validation assures that the provided value evaluates to a member of that enumeration.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft