DependencyProperty.RegisterAttached(String, TypeName, TypeName, PropertyMetadata) DependencyProperty.RegisterAttached(String, TypeName, TypeName, PropertyMetadata) DependencyProperty.RegisterAttached(String, TypeName, TypeName, PropertyMetadata) DependencyProperty.RegisterAttached(String, TypeName, TypeName, PropertyMetadata) Method

Definition

Registers an attached dependency property with the specified property name, property type, owner type, and property metadata for the property.

public : static DependencyProperty RegisterAttached(Platform::String name, TypeName propertyType, TypeName ownerType, PropertyMetadata defaultMetadata)
static DependencyProperty RegisterAttached(winrt::hstring name, TypeName propertyType, TypeName ownerType, PropertyMetadata defaultMetadata) const;
public static DependencyProperty RegisterAttached(String name, Type propertyType, Type ownerType, PropertyMetadata defaultMetadata)
Public Shared Function RegisterAttached(name As String, propertyType As Type, ownerType As Type, defaultMetadata As PropertyMetadata) As DependencyProperty

Parameters

name
String String

The name of the dependency property to register.

propertyType
Type Type

The type of the property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

ownerType
Type Type

The owner type that is registering the dependency property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

defaultMetadata
PropertyMetadata PropertyMetadata

A property metadata instance. This can contain a PropertyChangedCallback implementation reference.

Returns

A dependency property identifier that should be used to set the value of a public static read-only field in your class. That identifier is then used to reference the attached property later, for operations such as setting its value programmatically or attaching a Binding.

Examples

This example defines a class that derives from DependencyObject, and defines an attached property along with the identifier field. The scenario for this class is that it is a service class that declares an attached property that other UI elements can set in XAML, and the service potentially acts on the attached property values on those UI elements at run time. For more examples, see Custom attached properties.

public abstract class AquariumServices : DependencyObject
{
    public enum Buoyancy {Floats,Sinks,Drifts}

    public static readonly DependencyProperty BuoyancyProperty = DependencyProperty.RegisterAttached(
      "Buoyancy",
      typeof(Buoyancy),
      typeof(AquariumServices),
      new PropertyMetadata(Buoyancy.Floats)
    );
    public static void SetBuoyancy(DependencyObject element, Buoyancy value)
    {
        element.SetValue(BuoyancyProperty, value);
    }
    public static Buoyancy GetBuoyancy(DependencyObject element)
    {
        return (Buoyancy)element.GetValue(BuoyancyProperty);
    }
}
Public Class AquariumServices
    Inherits DependencyObject
    Public Enum Buoyancy
        Floats
        Sinks
        Drifts
    End Enum

    Public Shared ReadOnly BuoyancyProperty As DependencyProperty = _
          DependencyProperty.RegisterAttached(
          "Buoyancy", _
          GetType(Buoyancy), _
          GetType(AquariumServices), _
          New PropertyMetadata(Buoyancy.Floats))


    Public Sub SetBuoyancy(element As DependencyObject, value As Buoyancy)
        element.SetValue(BuoyancyProperty, value)
    End Sub
    Public Function GetBuoyancy(element As DependencyObject) As Buoyancy
        GetBuoyancy = CType(element.GetValue(BuoyancyProperty), Buoyancy)
    End Function
End Class

See Also