Export (0) Print
Expand All

DependencyProperty.AddOwner Method (Type, PropertyMetadata)

Adds another type as an owner of a dependency property that has already been registered, providing dependency property metadata for the dependency property as it will exist on the provided owner type.

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

public DependencyProperty AddOwner(
	Type ownerType,
	PropertyMetadata typeMetadata
)

Parameters

ownerType
Type: System.Type

The type to add as owner of this dependency property.

typeMetadata
Type: System.Windows.PropertyMetadata

The metadata that qualifies the dependency property as it exists on the provided type.

Return Value

Type: System.Windows.DependencyProperty
A reference to the original DependencyProperty identifier that identifies the dependency property. This identifier should be exposed by the adding class as a public static readonly field.

This method enables the property system to recognize a dependency property on a type that did not register that particular dependency property initially.

The return value of this method is used to declare and expose the dependency property, particularly as it exists on the adding owner class. Generally, the same property name for both original owner and added owner should be used to indicate the similar functionality. It is good practice to expose the identifiers, as well as new CLR property wrappers, for dependency properties that are added to types using AddOwner.

The AddOwner methodology recommended above is used when creating APIs declared within WPF. For instance, both Border and Control define a BorderBrush dependency property, which have similar functionality. Control defines its BorderBrush property to the property system by calling AddOwner on original owner Border and its registered BorderBrushProperty dependency property identifer. The AddOwner return value is then used to establish a static DependencyProperty field (BorderBrushProperty)for that property on the added owner, and a BorderBrush property wrapper is also declared.

The added owner's dependency property identifier should be used for operations such as GetValue. However, type-specific operations involving either types or instances of the class that was added as owner with different metadata will still return the expected results even if the original (not the added owner's) dependency property identifier is specified in calls to methods such as GetValue or GetMetadata. The metadata for the added owner is perpetuated by the AddOwner call itself, not necessarily referenced exclusively by the adding owner class identifier field. Nevertheless, it is good practice to expose the identifier, as well as new CLR property wrappers, for dependency properties that are added to types using AddOwner, because failing to do so creates disparity between the CLR and XAML representations of your properties.

The supplied metadata is merged with the property metadata for the dependency property as it exists on the base owner. Any characteristics that were specified in the original base metadata will persist. Only those characteristics that were specifically changed in the new metadata will override the characteristics of the base metadata. Some characteristics, such as DefaultValue, are replaced if they are specified in the new metadata. Others, such as PropertyChangedCallback, are combined. Ultimately, the merge behavior depends on the property metadata type being used for the override, so the behavior described here is for the existing property metadata classes used by WPF dependency properties. For details, see Dependency Property Metadata and Framework Property Metadata.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft