DependencyProperty.RegisterAttached メソッド

定義

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

オーバーロード

RegisterAttached(String, Type, Type)

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

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)

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

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

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

propertyType
Type

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

ownerType
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)

プロパティ名、プロパティの型、所有者の型、およびプロパティ メタデータを指定して、アタッチされるプロパティを登録します。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

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

propertyType
Type

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

ownerType
Type

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

defaultMetadata
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

Register ではなく RegisterAttached に依存関係プロパティを登録する具体的なシナリオの1つは、プロパティ値の継承をサポートすることです。One particular scenario for registering a dependency property with RegisterAttached instead of Register is to support property value inheritance. 依存関係プロパティを公開するプロパティラッパーアクセサーがクラスで定義されていても、Get * および Set * 静的メソッドを公開して true をアタッチする予定がない場合でも、RegisterAttached を使用して、値を継承する依存関係プロパティを登録する必要があります。プロパティサポートアクセサー。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. メタデータで Inherits を指定するプロパティを登録するには、常に RegisterAttached を使用します。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)

プロパティ型、所有者型、プロパティ メタデータ、および値の検証コールバックを指定して、添付プロパティを登録します。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

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

propertyType
Type

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

ownerType
Type

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

defaultMetadata
PropertyMetadata

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

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

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

こちらもご覧ください

適用対象