DependencyProperty.RegisterAttached DependencyProperty.RegisterAttached DependencyProperty.RegisterAttached DependencyProperty.RegisterAttached Method

定義

添付プロパティをプロパティ システムに登録します。Registers an attached property with the property system.

オーバーロード

RegisterAttached(String, Type, Type) RegisterAttached(String, Type, Type) RegisterAttached(String, Type, Type) RegisterAttached(String, Type, Type)

プロパティ名、プロパティ型、および所有者型を指定して、添付プロパティを登録します。Registers an attached property with the specified property name, property type, and owner type.

RegisterAttached(String, Type, Type, PropertyMetadata) RegisterAttached(String, Type, Type, PropertyMetadata) RegisterAttached(String, Type, Type, PropertyMetadata) RegisterAttached(String, Type, Type, PropertyMetadata)

プロパティ名、プロパティの型、所有者の型、およびプロパティ メタデータを指定して、アタッチされるプロパティを登録します。Registers an attached property with the specified property name, property type, owner type, and property metadata.

RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback)

プロパティ型、所有者型、プロパティ メタデータ、および値の検証コールバックを指定して、添付プロパティを登録します。Registers an attached property with the specified property type, owner type, property metadata, and value validation callback for the property.

RegisterAttached(String, Type, Type) RegisterAttached(String, Type, Type) RegisterAttached(String, Type, Type) RegisterAttached(String, Type, Type)

プロパティ名、プロパティ型、および所有者型を指定して、添付プロパティを登録します。Registers an attached property with the specified property name, property type, and owner type.

public:
 static System::Windows::DependencyProperty ^ RegisterAttached(System::String ^ name, Type ^ propertyType, Type ^ ownerType);
public static System.Windows.DependencyProperty RegisterAttached (string name, Type propertyType, Type ownerType);
static member RegisterAttached : string * Type * Type -> System.Windows.DependencyProperty
Public Shared Function RegisterAttached (name As String, propertyType As Type, ownerType As Type) As DependencyProperty

パラメーター

name
String String String String

登録する依存関係プロパティの名前。The name of the dependency property to register.

propertyType
Type Type Type Type

プロパティの型。The type of the property.

ownerType
Type Type Type Type

依存関係プロパティを登録する所有者型。The owner type that is registering the dependency property.

戻り値

クラス内の public static readonly フィールドの値を設定するために使用する依存関係プロパティ識別子。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.

次の例では、これを使用して抽象クラスで添付プロパティを登録します。RegisterAttached署名します。The following example registers an attached property on an abstract class using this RegisterAttached signature.

public static readonly DependencyProperty IsBubbleSourceProperty = DependencyProperty.RegisterAttached(
  "IsBubbleSource",
  typeof(Boolean),
  typeof(AquariumObject2)
);
public static void SetIsBubbleSource(UIElement element, Boolean value)
{
    element.SetValue(IsBubbleSourceProperty, value);
}
public static Boolean GetIsBubbleSource(UIElement element)
{
    return (Boolean)element.GetValue(IsBubbleSourceProperty);
}
Public Shared ReadOnly IsBubbleSourceProperty As DependencyProperty = DependencyProperty.RegisterAttached("IsBubbleSource", GetType(Boolean), GetType(AquariumObject2))
Public Shared Sub SetIsBubbleSource(ByVal element As UIElement, ByVal value As Boolean)
    element.SetValue(IsBubbleSourceProperty, value)
End Sub
Public Shared Function GetIsBubbleSource(ByVal element As UIElement) As Boolean
    Return CType(element.GetValue(IsBubbleSourceProperty), Boolean)
End Function

注釈

添付プロパティによって定義されたプロパティの概念は、Extensible Application Markup Language (XAML)Extensible Application Markup Language (XAML)します。An attached property is a property concept defined by Extensible Application Markup Language (XAML)Extensible Application Markup Language (XAML). WPFWPF 依存関係プロパティとして添付プロパティを実装します。implements attached properties as dependency properties. WPFWPF添付プロパティは依存関係プロパティ、レポートのレイアウト特性などの操作の [全般] プロパティ システムで使用できるメタデータが適用されることができます。Because the WPFWPF 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.

依存関係プロパティの登録の詳細については、次を参照してください。DependencyPropertyします。For more information on dependency property registration, see DependencyProperty.

こちらもご覧ください

RegisterAttached(String, Type, Type, PropertyMetadata) RegisterAttached(String, Type, Type, PropertyMetadata) RegisterAttached(String, Type, Type, PropertyMetadata) RegisterAttached(String, Type, Type, PropertyMetadata)

プロパティ名、プロパティの型、所有者の型、およびプロパティ メタデータを指定して、アタッチされるプロパティを登録します。Registers an attached property with the specified property name, property type, owner type, and property metadata.

public:
 static System::Windows::DependencyProperty ^ RegisterAttached(System::String ^ name, Type ^ propertyType, Type ^ ownerType, System::Windows::PropertyMetadata ^ defaultMetadata);
public static System.Windows.DependencyProperty RegisterAttached (string name, Type propertyType, Type ownerType, System.Windows.PropertyMetadata defaultMetadata);
static member RegisterAttached : string * Type * Type * System.Windows.PropertyMetadata -> System.Windows.DependencyProperty
Public Shared Function RegisterAttached (name As String, propertyType As Type, ownerType As Type, defaultMetadata As PropertyMetadata) As DependencyProperty

パラメーター

name
String String String String

登録する依存関係プロパティの名前。The name of the dependency property to register.

propertyType
Type Type Type Type

プロパティの型。The type of the property.

ownerType
Type Type Type Type

依存関係プロパティを登録している所有者の型。The owner type that is registering the dependency property.

defaultMetadata
PropertyMetadata PropertyMetadata PropertyMetadata PropertyMetadata

依存関係プロパティのプロパティ メタデータ。Property metadata for the dependency property. ここには、既定値などの特性を含めることができます。This can include the default value as well as other characteristics.

戻り値

クラス内の public static readonly フィールドの値を設定するために使用する依存関係プロパティ識別子。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.

注釈

添付プロパティによって定義されたプロパティの概念は、Extensible Application Markup Language (XAML)Extensible Application Markup Language (XAML)します。An attached property is a property concept defined by Extensible Application Markup Language (XAML)Extensible Application Markup Language (XAML). WPFWPF 依存関係プロパティとして添付プロパティを実装します。implements attached properties as dependency properties. WPFWPF添付プロパティは依存関係プロパティ、レポートのレイアウト特性などの操作の [全般] プロパティ システムで使用できるメタデータが適用されることができます。Because the WPFWPF 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.

依存関係プロパティの登録の詳細については、次を参照してください。DependencyPropertyします。For more information on dependency property registration, see DependencyProperty.

RegisterAttached を使用して、依存関係プロパティの値の継承Use RegisterAttached for Value-inheriting Dependency Properties

1 つのシナリオでの依存関係プロパティを登録するためRegisterAttachedの代わりにRegisterプロパティ値の継承をサポートすることです。One particular scenario for registering a dependency property with RegisterAttached instead of Register is to support property value inheritance. 依存関係プロパティの値の継承を登録する必要がありますRegisterAttachedしないを提供する静的メソッドを Get * とセット * を公開する true にアタッチされている場合でも、クラス、依存関係プロパティを公開するプロパティのラッパーのアクセサーを定義する場合でもプロパティのサポートのアクセサー。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. 常に使用するRegisterAttachedに指定したプロパティを登録するInheritsメタデータにします。Always use RegisterAttached to register properties where you specify Inherits in the metadata. 詳細については、「プロパティ値の継承」を参照してください。For more information, see Property Value Inheritance.

こちらもご覧ください

RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback)

プロパティ型、所有者型、プロパティ メタデータ、および値の検証コールバックを指定して、添付プロパティを登録します。Registers an attached property with the specified property type, owner type, property metadata, and value validation callback for the property.

public:
 static System::Windows::DependencyProperty ^ RegisterAttached(System::String ^ name, Type ^ propertyType, Type ^ ownerType, System::Windows::PropertyMetadata ^ defaultMetadata, System::Windows::ValidateValueCallback ^ validateValueCallback);
public static System.Windows.DependencyProperty RegisterAttached (string name, Type propertyType, Type ownerType, System.Windows.PropertyMetadata defaultMetadata, System.Windows.ValidateValueCallback validateValueCallback);
static member RegisterAttached : string * Type * Type * System.Windows.PropertyMetadata * System.Windows.ValidateValueCallback -> System.Windows.DependencyProperty

パラメーター

name
String String String String

登録する依存関係プロパティの名前。The name of the dependency property to register.

propertyType
Type Type Type Type

プロパティの型。The type of the property.

ownerType
Type Type Type Type

依存関係プロパティを登録している所有者の型。The owner type that is registering the dependency property.

defaultMetadata
PropertyMetadata PropertyMetadata PropertyMetadata PropertyMetadata

依存関係プロパティのプロパティ メタデータ。Property metadata for the dependency property. ここには、既定値などの特性を含めることができます。This can include the default value as well as other characteristics.

validateValueCallback
ValidateValueCallback ValidateValueCallback ValidateValueCallback ValidateValueCallback

通常の型検証に加えて、依存関係プロパティ値のカスタム検証を実行する必要があるコールバックへの参照。A reference to a callback that should perform any custom validation of the dependency property value beyond typical type validation.

戻り値

クラス内の public static readonly フィールドの値を設定するために使用する依存関係プロパティ識別子。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.

次の例では、これを使用して抽象クラスで添付プロパティを登録します。RegisterAttached署名します。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.

public static readonly DependencyProperty IsBubbleSourceProperty = DependencyProperty.RegisterAttached(
  "IsBubbleSource",
  typeof(Boolean),
  typeof(AquariumObject2)
);
public static void SetIsBubbleSource(UIElement element, Boolean value)
{
    element.SetValue(IsBubbleSourceProperty, value);
}
public static Boolean GetIsBubbleSource(UIElement element)
{
    return (Boolean)element.GetValue(IsBubbleSourceProperty);
}
Public Shared ReadOnly IsBubbleSourceProperty As DependencyProperty = DependencyProperty.RegisterAttached("IsBubbleSource", GetType(Boolean), GetType(AquariumObject2))
Public Shared Sub SetIsBubbleSource(ByVal element As UIElement, ByVal value As Boolean)
    element.SetValue(IsBubbleSourceProperty, value)
End Sub
Public Shared Function GetIsBubbleSource(ByVal element As UIElement) As Boolean
    Return CType(element.GetValue(IsBubbleSourceProperty), Boolean)
End Function

注釈

添付プロパティによって定義されたプロパティの概念は、Extensible Application Markup Language (XAML)Extensible Application Markup Language (XAML)します。An attached property is a property concept defined by Extensible Application Markup Language (XAML)Extensible Application Markup Language (XAML). WPFWPF 依存関係プロパティとして添付プロパティを実装します。implements attached properties as dependency properties. WPFWPF添付プロパティは依存関係プロパティ、レポートのレイアウト特性などの操作の [全般] プロパティ システムで使用できるメタデータが適用されることができます。Because the WPFWPF 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.

依存関係プロパティの登録の詳細については、次を参照してください。DependencyPropertyします。For more information on dependency property registration, see DependencyProperty.

RegisterAttached を使用して、依存関係プロパティの値の継承Use RegisterAttached for Value-inheriting Dependency Properties

1 つのシナリオでの依存関係プロパティを登録するためRegisterAttachedの代わりにRegisterプロパティ値の継承をサポートすることです。One particular scenario for registering a dependency property with RegisterAttached instead of Register is to support property value inheritance. 依存関係プロパティの値の継承を登録する必要がありますRegisterAttachedしないを提供する静的メソッドを Get * とセット * を公開する true にアタッチされている場合でも、クラス、依存関係プロパティを公開するプロパティのラッパーのアクセサーを定義する場合でもプロパティのサポートのアクセサー。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. 常に使用するRegisterAttachedに指定したプロパティを登録するInheritsメタデータにします。Always use RegisterAttached to register properties where you specify Inherits in the metadata. 詳細については、「プロパティ値の継承」を参照してください。For more information, see Property Value Inheritance.

こちらもご覧ください

適用対象