Export (0) Print
Expand All

FrameworkPropertyMetadata Constructor (Object, FrameworkPropertyMetadataOptions, PropertyChangedCallback, CoerceValueCallback, Boolean)

Initializes a new instance of the FrameworkPropertyMetadata class with the provided default value and framework metadata options, specified callbacks, and a Boolean that can be used to prevent animation of the property.

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

public FrameworkPropertyMetadata(
	Object defaultValue,
	FrameworkPropertyMetadataOptions flags,
	PropertyChangedCallback propertyChangedCallback,
	CoerceValueCallback coerceValueCallback,
	bool isAnimationProhibited
)

Parameters

defaultValue
Type: System.Object

The default value of the dependency property, usually provided as a specific type.

flags
Type: System.Windows.FrameworkPropertyMetadataOptions

The metadata option flags (a combination of FrameworkPropertyMetadataOptions values). These options specify characteristics of the dependency property that interact with systems such as layout or data binding.

propertyChangedCallback
Type: System.Windows.PropertyChangedCallback

A reference to a handler implementation that the property system will call whenever the effective value of the property changes.

coerceValueCallback
Type: System.Windows.CoerceValueCallback

A reference to a handler implementation that will be called whenever the property system calls CoerceValue on this dependency property.

isAnimationProhibited
Type: System.Boolean

true to prevent the property system from animating the property that this metadata is applied to. Such properties will raise a run-time exception originating from the property system if animations of them are attempted. false to permit animating the property. The default is false.

ExceptionCondition
ArgumentException

defaultValue is set to UnsetValue; see Remarks.

The type of the value provided for defaultValue must match or be related to the type specified in the original registration of the dependency property that this metadata will be applied to. Mismatches between metadata default value type and the type of the dependency property it is being applied to can be difficult to debug, because the mismatch is not detectable during compilation. The property system does not evaluate the effective value of a property until run time, so the result of a default value type/property type mismatch is a run-time error.

The value UnsetValue has special meaning in the property system, and cannot be used as a dependency property default value.

The isAnimationProhibited parameter sets the initial value of the IsAnimationProhibited property declared by the immediate base UIPropertyMetadata class.

Values marked as set flags in the flags parameter will set the Boolean value of FrameworkPropertyMetadata properties that match that FrameworkPropertyMetadataOptions flag's name to true. You can still change the values of the properties in the metadata, as long as the metadata has not yet been applied to a specific property system operation.

The following example calls this constructor signature:

static FrameworkPropertyMetadata fpm;


...


fpm = new FrameworkPropertyMetadata(
    Double.NaN,
    (FrameworkPropertyMetadataOptions.AffectsRender |
      FrameworkPropertyMetadataOptions.BindsTwoWayByDefault),
    new PropertyChangedCallback(OnCurrentReadingChanged),
    new CoerceValueCallback(CoerceCurrentReading),
    true //Animation prohibited
);

.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