FrameworkPropertyMetadata Class

 

Reports or applies metadata for a dependency property, specifically adding framework-specific property system characteristics.

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

System::Object
  System.Windows::PropertyMetadata
    System.Windows::UIPropertyMetadata
      System.Windows::FrameworkPropertyMetadata

public ref class FrameworkPropertyMetadata : UIPropertyMetadata

NameDescription
System_CAPS_pubmethodFrameworkPropertyMetadata()

Initializes a new instance of the FrameworkPropertyMetadata class.

System_CAPS_pubmethodFrameworkPropertyMetadata(Object^)

Initializes a new instance of the FrameworkPropertyMetadata class with the specified default value.

System_CAPS_pubmethodFrameworkPropertyMetadata(Object^, FrameworkPropertyMetadataOptions)

Initializes a new instance of the FrameworkPropertyMetadata class with the provided default value and framework-level metadata options.

System_CAPS_pubmethodFrameworkPropertyMetadata(Object^, FrameworkPropertyMetadataOptions, PropertyChangedCallback^)

Initializes a new instance of the FrameworkPropertyMetadata class with the provided default value and framework metadata options, and specified PropertyChangedCallback callback.

System_CAPS_pubmethodFrameworkPropertyMetadata(Object^, FrameworkPropertyMetadataOptions, PropertyChangedCallback^, CoerceValueCallback^)

Initializes a new instance of the FrameworkPropertyMetadata class with the provided default value and framework metadata options, and specified callbacks.

System_CAPS_pubmethodFrameworkPropertyMetadata(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.

System_CAPS_pubmethodFrameworkPropertyMetadata(Object^, FrameworkPropertyMetadataOptions, PropertyChangedCallback^, CoerceValueCallback^, Boolean, UpdateSourceTrigger)

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

System_CAPS_pubmethodFrameworkPropertyMetadata(Object^, PropertyChangedCallback^)

Initializes a new instance of the FrameworkPropertyMetadata class with the provided default value and specified PropertyChangedCallback callback.

System_CAPS_pubmethodFrameworkPropertyMetadata(Object^, PropertyChangedCallback^, CoerceValueCallback^)

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

System_CAPS_pubmethodFrameworkPropertyMetadata(PropertyChangedCallback^)

Initializes a new instance of the FrameworkPropertyMetadata class with the specified PropertyChangedCallback callback.

System_CAPS_pubmethodFrameworkPropertyMetadata(PropertyChangedCallback^, CoerceValueCallback^)

Initializes a new instance of the FrameworkPropertyMetadata class with the specified callbacks.

NameDescription
System_CAPS_pubpropertyAffectsArrange

Gets or sets a value that indicates whether a dependency property potentially affects the arrange pass during layout engine operations.

System_CAPS_pubpropertyAffectsMeasure

Gets or sets a value that indicates whether a dependency property potentially affects the measure pass during layout engine operations.

System_CAPS_pubpropertyAffectsParentArrange

Gets or sets a value that indicates whether a dependency property potentially affects the arrange pass of its parent element's layout during layout engine operations.

System_CAPS_pubpropertyAffectsParentMeasure

Gets or sets a value that indicates whether a dependency property potentially affects the measure pass of its parent element's layout during layout engine operations.

System_CAPS_pubpropertyAffectsRender

Gets or sets a value that indicates whether a dependency property potentially affects the general layout in some way that does not specifically influence arrangement or measurement, but would require a redraw.

System_CAPS_pubpropertyBindsTwoWayByDefault

Gets or sets a value that indicates whether the property binds two-way by default.

System_CAPS_pubpropertyCoerceValueCallback

Gets or sets a reference to a CoerceValueCallback implementation specified in this metadata.(Inherited from PropertyMetadata.)

System_CAPS_pubpropertyDefaultUpdateSourceTrigger

Gets or sets the default for UpdateSourceTrigger to use when bindings for the property with this metadata are applied, which have their UpdateSourceTrigger set to Default.

System_CAPS_pubpropertyDefaultValue

Gets or sets the default value of the dependency property. (Inherited from PropertyMetadata.)

System_CAPS_pubpropertyInherits

Gets or sets a value that indicates whether the value of the dependency property is inheritable.

System_CAPS_pubpropertyIsAnimationProhibited

Gets or sets a value declaring whether animations should be disabled on the dependency property where the containing metadata instance is applied. (Inherited from UIPropertyMetadata.)

System_CAPS_pubpropertyIsDataBindingAllowed

Gets a value that indicates whether data binding is supported for the dependency property.

System_CAPS_pubpropertyIsNotDataBindable

Gets or sets a value that indicates whether the dependency property supports data binding.

System_CAPS_protpropertyIsSealed

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. (Inherited from PropertyMetadata.)

System_CAPS_pubpropertyJournal

Gets or sets a value that indicates whether this property contains journaling information that applications can or should store as part of a journaling implementation.

System_CAPS_pubpropertyOverridesInheritanceBehavior

Gets or sets a value that indicates whether the property value inheritance evaluation should span across certain content boundaries in the logical tree of elements.

System_CAPS_pubpropertyPropertyChangedCallback

Gets or sets a reference to a PropertyChangedCallback implementation specified in this metadata.(Inherited from PropertyMetadata.)

System_CAPS_pubpropertySubPropertiesDoNotAffectRender

Gets or sets a value that indicates whether sub-properties of the dependency property do not affect the rendering of the containing object.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMerge(PropertyMetadata^, DependencyProperty^)

Enables a merge of the source metadata with base metadata. (Overrides PropertyMetadata::Merge(PropertyMetadata^, DependencyProperty^).)

System_CAPS_protmethodOnApply(DependencyProperty^, Type^)

Called when this metadata has been applied to a property, which indicates that the metadata is being sealed. (Overrides PropertyMetadata::OnApply(DependencyProperty^, Type^).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

This class derives from PropertyMetadata (through UIPropertyMetadata) . For most WPF framework-level application development purposes, FrameworkPropertyMetadata is the type used for dependency property metadata, rather than the base metadata types PropertyMetadata or UIPropertyMetadata. This is true both for existing dependency properties and for most custom dependency property scenarios.

The members declared by this class that supplement the PropertyMetadata base class include various Boolean properties that specify or report WPF framework-level property system behavior such as property inheritance, data binding, and layout.

Several constructor signatures for creating a FrameworkPropertyMetadata instance take a FrameworkPropertyMetadataOptions parameter. The FrameworkPropertyMetadataOptions enumeration is used only to specify initial behavior in the constructor, and is not otherwise exposed after FrameworkPropertyMetadata is constructed. From a constructed instance, you can get or set the corresponding information through various properties that share the name of the enumeration values used in the constructor call.

This class is not typically used in XAML.

The following example gets metadata for a dependency property on a particular owner as the initial base PropertyMetadata type. That metadata is cast to FrameworkPropertyMetadata. If the cast returned a valid FrameworkPropertyMetadata, then various FrameworkPropertyMetadata property values are reported through a simple UI (not shown).

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

.NET Framework
Available since 3.0

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

Return to top
Show: