DependencyProperty.RegisterAttachedReadOnly DependencyProperty.RegisterAttachedReadOnly DependencyProperty.RegisterAttachedReadOnly DependencyProperty.RegisterAttachedReadOnly Method

定義

読み取り専用添付プロパティを登録します。Registers a read-only attached property.

オーバーロード

RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata)

プロパティ型、所有者型、およびプロパティ メタデータを指定して、読み取り専用の添付プロパティを登録します。Registers a read-only attached property, with the specified property type, owner type, and property metadata.

RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback)

プロパティ型、所有者型、プロパティ メタデータ、および検証コールバックを指定して、読み取り専用の添付プロパティを登録します。Registers a read-only attached property, with the specified property type, owner type, property metadata, and a validation callback.

RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata)

プロパティ型、所有者型、およびプロパティ メタデータを指定して、読み取り専用の添付プロパティを登録します。Registers a read-only attached property, with the specified property type, owner type, and property metadata.

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

パラメーター

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.

戻り値

クラスの静的な読み取り専用フィールドの値を設定するために使用する必要がある依存関係プロパティのキー。これは後で依存関係プロパティの参照に使用されます。A dependency property key that should be used to set the value of a static read-only field in your class, which is then used to reference the dependency property later.

注釈

このメソッドは型DependencyPropertyKey RegisterAttachedを返しますが、はDependencyProperty型を返します。This method returns the type DependencyPropertyKey, whereas RegisterAttached returns the type DependencyProperty. 通常、読み取り専用プロパティを表すキーは公開されません。これは、を呼び出すSetValue(DependencyPropertyKey, Object)ことで、キーを使用して依存関係プロパティの値を設定できるためです。Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling SetValue(DependencyPropertyKey, Object). クラスのDependencyPropertyKey設計は要件に影響を与えますが、通常は、クラスまたはアプリケーションロジックの一部としてその依存関係プロパティを設定するために必要なコード部分のみにアクセスと可視性を制限することをお勧めします。Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any DependencyPropertyKey to only those parts of your code that are necessary to set that dependency property as part of class or application logic. また、のDependencyPropertyKey.DependencyProperty値をクラスのpublic static readonlyフィールドとして公開することによって、読み取り専用の依存関係プロパティの依存関係プロパティ識別子を公開することもお勧めします。It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of DependencyPropertyKey.DependencyProperty as a public static readonly field on your class.

添付プロパティの主要なシナリオはでXAMLXAML使用されるため、読み取り専用の添付プロパティはまれなシナリオです。Read-only attached properties are a rare scenario, because the primary scenario for an attached property is its use in XAMLXAML. パブリック setter を使用しない場合、添付プロパティを構文XAMLXAMLで設定することはできません。Without a public setter, an attached property cannot be set in XAMLXAML syntax.

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

値を継承する依存関係プロパティに RegisterAttached を使用するUse RegisterAttached for Value-inheriting Dependency Properties

依存関係プロパティを添付として登録するための特定のシナリオの1つは、プロパティ値の継承をサポートすることです。One particular scenario for registering a dependency property as attached is to support property value inheritance. 依存関係プロパティを公開するプロパティラッパーアクセサー RegisterAttachedをクラスで定義する場合でも、Get * および Set * 静的メソッドを公開して 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.

RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback) RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback)

プロパティ型、所有者型、プロパティ メタデータ、および検証コールバックを指定して、読み取り専用の添付プロパティを登録します。Registers a read-only attached property, with the specified property type, owner type, property metadata, and a validation callback.

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

パラメーター

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.

validateValueCallback
ValidateValueCallback ValidateValueCallback ValidateValueCallback ValidateValueCallback

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

戻り値

クラスの静的な読み取り専用フィールドの値を設定するために使用され、次いで依存関係プロパティの参照に使用される、依存関係プロパティのキー。A dependency property key that should be used to set the value of a static read-only field in your class, which is then used to reference the dependency property.

注釈

このメソッドは型DependencyPropertyKey RegisterAttachedを返しますが、はDependencyProperty型を返します。This method returns the type DependencyPropertyKey, whereas RegisterAttached returns the type DependencyProperty. 通常、型DependencyPropertyを表すキー。Typically, the keys that represent the type DependencyProperty. 通常、読み取り専用プロパティを表すキーは公開されません。これは、を呼び出すSetValue(DependencyPropertyKey, Object)ことで、キーを使用して依存関係プロパティの値を設定できるためです。Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling SetValue(DependencyPropertyKey, Object). クラスのDependencyPropertyKey設計は要件に影響を与えますが、通常は、クラスまたはアプリケーションロジックの一部としてその依存関係プロパティを設定するために必要なコード部分のみにアクセスと可視性を制限することをお勧めします。Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any DependencyPropertyKey to only those parts of your code that are necessary to set that dependency property as part of class or application logic. また、のDependencyPropertyKey.DependencyProperty値をクラスのpublic static readonlyフィールドとして公開することによって、読み取り専用の依存関係プロパティの依存関係プロパティ識別子を公開することもお勧めします。It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of DependencyPropertyKey.DependencyProperty as a public static readonly field on your class.

添付プロパティの主要なシナリオはでXAMLXAML使用されるため、読み取り専用の添付プロパティはまれなシナリオです。Read-only attached properties are a rare scenario, because the primary scenario for an attached property is its use in XAMLXAML. パブリック setter を使用しない場合、添付プロパティを構文XAMLXAMLで設定することはできません。Without a public setter, an attached property cannot be set in XAMLXAML syntax.

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

値を継承する依存関係プロパティに RegisterAttached を使用するUse RegisterAttached for Value-inheriting Dependency Properties

の代わりに依存関係プロパティを添付として登録Registerする特定のシナリオの1つは、プロパティ値の継承をサポートすることです。One particular scenario for registering a dependency property as attached instead of Register is to support property value inheritance. 依存関係プロパティを公開するプロパティラッパーアクセサー RegisterAttachedをクラスで定義する場合でも、Get * および Set * 静的メソッドを公開して 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.

適用対象