PropertyMetadata.Create Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Create(Object) |
Creates a PropertyMetadata value, specifying a fixed default value for a dependency property. |
| Create(CreateDefaultValueCallback) |
Creates a PropertyMetadata value, specifying a callback that establishes a default value for a dependency property. |
| Create(Object, PropertyChangedCallback) |
Creates a PropertyMetadata value, specifying a fixed default value for a dependency property, and a property-changed callback. |
| Create(CreateDefaultValueCallback, PropertyChangedCallback) |
Creates a PropertyMetadata value, specifying a callback that establishes a default value for a dependency property, and a property-changed callback. |
Create(Object)
Creates a PropertyMetadata value, specifying a fixed default value for a dependency property.
/// [Windows.Foundation.Metadata.DefaultOverload]
/// [Windows.Foundation.Metadata.Overload("CreateWithDefaultValue")]
static PropertyMetadata Create(IInspectable const& defaultValue);[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("CreateWithDefaultValue")]
public static PropertyMetadata Create(object defaultValue);function create(defaultValue)Public Shared Function Create (defaultValue As Object) As PropertyMetadataParameters
- defaultValue
-
Object
IInspectable
The dependency property default value to apply.
Returns
The newly created dependency property metadata.
- Attributes
See also
- Create(Object, PropertyChangedCallback)
- Create(CreateDefaultValueCallback)
- Create(CreateDefaultValueCallback, PropertyChangedCallback)
Applies to
Create(CreateDefaultValueCallback)
Creates a PropertyMetadata value, specifying a callback that establishes a default value for a dependency property.
/// [Windows.Foundation.Metadata.Overload("CreateWithFactory")]
static PropertyMetadata Create(CreateDefaultValueCallback const& createDefaultValueCallback);[Windows.Foundation.Metadata.Overload("CreateWithFactory")]
public static PropertyMetadata Create(CreateDefaultValueCallback createDefaultValueCallback);function create(createDefaultValueCallback)Public Shared Function Create (createDefaultValueCallback As CreateDefaultValueCallback) As PropertyMetadataParameters
- createDefaultValueCallback
- CreateDefaultValueCallback
A reference to the callback method that provides a default property value.
Returns
The newly created dependency property metadata.
- Attributes
Examples
This example shows pseudocode for using CreateDefaultValueCallback in a custom dependency property scenario. Specifically, this creates PropertyMetadata to be used in a DependencyProperty.Register call (not shown).
PropertyMetadata metadata = PropertyMetadata.Create(
new CreateDefaultValueCallback(() =>
{
return new CustomClass() //a DependencyObject
{
CustomProperty1 = "default", //DependencyProperty of type String
CustomProperty2 = -1; //DependencyProperty of type Int32
}
})
Remarks
Use a CreateDefaultValueCallback instead of a fixed constant default value in any case where the default value of a dependency property might be thread-bound. The CreateDefaultValueCallback becomes a factory for default values whenever there is a need to get default values of properties on threads other than the main UI thread.
In order to establish a CreateDefaultValueCallback pattern for a dependency property, use one of the static Create methods instead of using the PropertyMetadata constructor when you define the metadata for the property. That metadata is submitted to the Register call. For more info, see Custom dependency properties. As with a property-changed callback, the CreateDefaultValueCallback method should be a static method of the type that registers the dependency property. The method does not have to be public.
See also
- Create(Object)
- Create(Object, PropertyChangedCallback)
- Create(CreateDefaultValueCallback, PropertyChangedCallback)
- Custom dependency properties
- Dependency properties overview
Applies to
Create(Object, PropertyChangedCallback)
Creates a PropertyMetadata value, specifying a fixed default value for a dependency property, and a property-changed callback.
/// [Windows.Foundation.Metadata.DefaultOverload]
/// [Windows.Foundation.Metadata.Overload("CreateWithDefaultValueAndCallback")]
static PropertyMetadata Create(IInspectable const& defaultValue, PropertyChangedCallback const& propertyChangedCallback);[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("CreateWithDefaultValueAndCallback")]
public static PropertyMetadata Create(object defaultValue, PropertyChangedCallback propertyChangedCallback);function create(defaultValue, propertyChangedCallback)Public Shared Function Create (defaultValue As Object, propertyChangedCallback As PropertyChangedCallback) As PropertyMetadataParameters
- defaultValue
-
Object
IInspectable
The dependency property default value to apply.
- propertyChangedCallback
- PropertyChangedCallback
A reference to the callback method that is invoked by the property system when a dependency property value changes.
Returns
The newly created dependency property metadata.
- Attributes
See also
- Create(Object)
- Create(CreateDefaultValueCallback)
- Create(CreateDefaultValueCallback, PropertyChangedCallback)
Applies to
Create(CreateDefaultValueCallback, PropertyChangedCallback)
Creates a PropertyMetadata value, specifying a callback that establishes a default value for a dependency property, and a property-changed callback.
/// [Windows.Foundation.Metadata.Overload("CreateWithFactoryAndCallback")]
static PropertyMetadata Create(CreateDefaultValueCallback const& createDefaultValueCallback, PropertyChangedCallback const& propertyChangedCallback);[Windows.Foundation.Metadata.Overload("CreateWithFactoryAndCallback")]
public static PropertyMetadata Create(CreateDefaultValueCallback createDefaultValueCallback, PropertyChangedCallback propertyChangedCallback);function create(createDefaultValueCallback, propertyChangedCallback)Public Shared Function Create (createDefaultValueCallback As CreateDefaultValueCallback, propertyChangedCallback As PropertyChangedCallback) As PropertyMetadataParameters
- createDefaultValueCallback
- CreateDefaultValueCallback
A reference to the callback method that provides a default property value.
- propertyChangedCallback
- PropertyChangedCallback
A reference to the callback method that is invoked by the property system when a dependency property value changes.
Returns
The newly created dependency property metadata.
- Attributes
See also
- Create(Object)
- Create(Object, PropertyChangedCallback)
- Create(CreateDefaultValueCallback)
- Custom dependency properties
- Dependency properties overview