DependencyProperty.RegisterAttached Method (String, Type, Type, PropertyMetadata, ValidateValueCallback)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Registers an attached property with the specified property type, owner type, property metadata, and value validation callback for the property.

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

static member RegisterAttached : 
        name:string *
        propertyType:Type *
        ownerType:Type *
        defaultMetadata:PropertyMetadata *
        validateValueCallback:ValidateValueCallback -> DependencyProperty


Type: System.String

The name of the dependency property to register.

Type: System.Type

The type of the property.

Type: System.Type

The owner type that is registering the dependency property.

Type: System.Windows.PropertyMetadata

Property metadata for the dependency property. This can include the default value as well as other characteristics.

Type: System.Windows.ValidateValueCallback

A reference to a callback that should perform any custom validation of the dependency property value beyond typical type validation.

Return Value

Type: System.Windows.DependencyProperty

A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

An attached property is a property concept defined by Extensible Application Markup Language (XAML). WPF implements attached properties as dependency properties. Because the WPF attached properties are dependency properties, they can have metadata applied that can be used by the general property system for operations such as reporting layout characteristics. For more information, see Attached Properties Overview.

For more information on dependency property registration, see DependencyProperty.

One particular scenario for registering a dependency property with RegisterAttached instead of Register is to support property value inheritance. You should register value-inheriting dependency properties with RegisterAttached even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use RegisterAttached to register properties where you specify Inherits in the metadata. For more information, see Property Value Inheritance.

The following example registers an attached property on an abstract class using this RegisterAttached signature. This attached property is an enumeration type property, and the registration adds a validation callback to verify that the provided value is a value of the enumeration.

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

.NET Framework
Available since 3.0
Return to top