Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

PropertyMetadata Class

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

Namespace:  System.Windows
Assembly:  WindowsBase (in WindowsBase.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

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

The PropertyMetadata type exposes the following members.

  NameDescription
Public methodPropertyMetadata() Initializes a new instance of the PropertyMetadata class.
Public methodPropertyMetadata(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.
Public methodPropertyMetadata(PropertyChangedCallback) Initializes a new instance of the PropertyMetadata class with the specified PropertyChangedCallback implementation reference.
Public methodPropertyMetadata(Object, PropertyChangedCallback) Initializes a new instance of the PropertyMetadata class with the specified default value and PropertyChangedCallback implementation reference.
Public methodPropertyMetadata(Object, PropertyChangedCallback, CoerceValueCallback)Initializes a new instance of the PropertyMetadata class with the specified default value and callbacks.
Top

  NameDescription
Public propertyCoerceValueCallbackGets or sets a reference to a CoerceValueCallback implementation specified in this metadata.
Public propertyDefaultValue Gets or sets the default value of the dependency property.
Protected propertyIsSealedGets 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.
Public propertyPropertyChangedCallbackGets or sets a reference to a PropertyChangedCallback implementation specified in this metadata.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMergeMerges this metadata with the base metadata.
Protected methodOnApplyCalled when this metadata has been applied to a property, which indicates that the metadata is being sealed.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft