PropertyMetadata.Merge(PropertyMetadata, DependencyProperty) Method

Reference

Definition

Namespace:: System.Windows

Assembly:: WindowsBase.dll

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.

Merges this metadata with the base metadata.

protected:
 virtual void Merge(System::Windows::PropertyMetadata ^ baseMetadata, System::Windows::DependencyProperty ^ dp);

protected virtual void Merge (System.Windows.PropertyMetadata baseMetadata, System.Windows.DependencyProperty dp);

abstract member Merge : System.Windows.PropertyMetadata * System.Windows.DependencyProperty -> unit
override this.Merge : System.Windows.PropertyMetadata * System.Windows.DependencyProperty -> unit

Protected Overridable Sub Merge (baseMetadata As PropertyMetadata, dp As DependencyProperty)

Parameters

baseMetadata: PropertyMetadata

The base metadata to merge with this instance's values.

dp: DependencyProperty

The dependency property to which this metadata is being applied.

Examples

The following example implements a merge for a custom metadata type that adds an additional property to the property metadata.

public Boolean SupportsMyFeature
{
    get { return _supportsMyFeature; }
    set { if (!this.IsSealed) _supportsMyFeature = value; } //else may want to raise exception 
}
protected override void Merge(PropertyMetadata baseMetadata, DependencyProperty dp)
{
    base.Merge(baseMetadata, dp);
    MyCustomPropertyMetadata mcpm = baseMetadata as MyCustomPropertyMetadata;
    if (mcpm != null)
    {
        if (!this.SupportsMyFeature)
        {//if not set, revert to base
            this.SupportsMyFeature = mcpm.SupportsMyFeature;
        }
    }
}

Remarks

This method is used internally when metadata is being overridden (OverrideMetadata method).

Notes to Inheritors

Class implementations that derive from PropertyMetadata should override this method to account for any metadata properties they have added in their implementations. For instance, your implementation might have added a new flagwise enumeration value, and the Merge(PropertyMetadata, DependencyProperty) implementation should then be able to combine those flags correctly.

Always call the base implementation prior to your implementation code, because the base implementation takes care of merging all the properties already defined on the PropertyMetadata type.

The exact behavior of the merge is up to you. You could choose to have values combined, revert to base value if the derived metadata were left at the default, or many other behaviors based on the types of properties you have added to your particular metadata class, and their meanings.

Applies to

Jaa