PropertyMetadata Class

Definition

Defines certain behavior aspects of a dependency property as it is applied to a specific type, including conditions it was registered with.

public ref class PropertyMetadata
public class PropertyMetadata
type PropertyMetadata = class
Public Class PropertyMetadata
Inheritance
PropertyMetadata
Derived

Remarks

Property metadata can be defined and used during dependency property registration when calling the Register method (or variations for attached properties or read-only dependency properties), or after original owner registration when calling the OverrideMetadata method. AddOwner also takes property metadata.

This class is a concrete base class that can be used in each of these calls. However, it is very common to specify metadata using one of the derived classes such as FrameworkPropertyMetadata. These derived classes support more detailed metadata carried as Boolean property values, which are useful for either detecting or enabling some property system and layout behaviors that are only implemented at the WPF framework level.

Several properties of this class are read-write to the object model, but can only be written prior to the instance being used in a property system operation such as Register or OverrideMetadata. Each of these properties could also have been set by the constructor but are exposed so that Merge method implementations can set them.

XAML Text Usage

This type, and members of this type, are not typically used in XAML.

Constructors

PropertyMetadata()

Initializes a new instance of the PropertyMetadata class.

PropertyMetadata(Object)

Initializes a new instance of the PropertyMetadata class with a specified default value for the dependency property that this metadata will be applied to.

PropertyMetadata(Object, PropertyChangedCallback)

Initializes a new instance of the PropertyMetadata class with the specified default value and PropertyChangedCallback implementation reference.

PropertyMetadata(Object, PropertyChangedCallback, CoerceValueCallback)

Initializes a new instance of the PropertyMetadata class with the specified default value and callbacks.

PropertyMetadata(PropertyChangedCallback)

Initializes a new instance of the PropertyMetadata class with the specified PropertyChangedCallback implementation reference.

Properties

CoerceValueCallback

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

DefaultValue

Gets or sets the default value of the dependency property.

IsSealed

Gets a value that determines whether the metadata has been applied to a property in some way, resulting in the immutable state of that metadata instance.

PropertyChangedCallback

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

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Merge(PropertyMetadata, DependencyProperty)

Merges this metadata with the base metadata.

OnApply(DependencyProperty, Type)

Called when this metadata has been applied to a property, which indicates that the metadata is being sealed.

ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to