DependencyProperty.RegisterAttachedReadOnly メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
読み取り専用添付プロパティを登録します。
オーバーロード
RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata) |
プロパティ型、所有者型、およびプロパティ メタデータを指定して、読み取り専用の添付プロパティを登録します。 |
RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback) |
プロパティ型、所有者型、プロパティ メタデータ、および検証コールバックを指定して、読み取り専用の添付プロパティを登録します。 |
RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata)
プロパティ型、所有者型、およびプロパティ メタデータを指定して、読み取り専用の添付プロパティを登録します。
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
登録する依存関係プロパティの名前。
- propertyType
- Type
プロパティの型。
- ownerType
- Type
依存関係プロパティを登録する所有者型。
- defaultMetadata
- PropertyMetadata
依存関係プロパティのプロパティ メタデータ。
戻り値
クラスの静的な読み取り専用フィールドの値を設定するために使用する必要がある依存関係プロパティのキー。これは後で依存関係プロパティの参照に使用されます。
注釈
このメソッドは型 DependencyPropertyKeyを返します。一方 RegisterAttached 、型 DependencyPropertyを返します。 通常、読み取り専用プロパティを表すキーは公開されません。これは、キーを使用して呼び出 SetValue(DependencyPropertyKey, Object)すことによって依存関係プロパティの値を設定できるためです。 クラスの設計は要件に影響しますが、通常は、クラスまたはアプリケーション ロジックの一部として依存関係プロパティを設定するために必要なコードの部分のみに、アクセス DependencyPropertyKey と可視性を制限することをお勧めします。 また、クラスのフィールドとしてpublic static readonly
値を公開することで、読み取り専用の依存関係プロパティのDependencyPropertyKey.DependencyProperty依存関係プロパティ識別子を公開することもお勧めします。
添付プロパティの主なシナリオは XAML での使用であるため、読み取り専用の添付プロパティはまれなシナリオです。 パブリック セッターがない場合、添付プロパティを XAML 構文で設定することはできません。
依存関係プロパティの登録の詳細については、次を参照してください DependencyProperty。
値を継承する依存関係プロパティに RegisterAttached を使用する
依存関係プロパティを添付として登録するための特定のシナリオの 1 つは、プロパティ値の継承をサポートするシナリオです。 値を継承する依存関係プロパティは、依存関係プロパティ RegisterAttached を公開するプロパティ ラッパー アクセサーをクラスが定義している場合でも、また、Get* および Set* 静的メソッドを公開して、実際の添付プロパティ サポート アクセサーを提供しない場合でも登録する必要があります。 プロパティ値の継承は、接続されていない依存関係プロパティでは機能するように見えますが、ランタイム ツリー内の特定の要素境界を介した接続されていないプロパティの継承動作は未定義です。 プロパティを添付として効果的に登録すると、添付プロパティがプロパティ システムのグローバル プロパティになり、プロパティ値の継承が要素ツリー内のすべての境界を越えて機能することが保証されます。 メタデータで Inherits を指定する場合は、必ず RegisterAttached を使用してプロパティを登録します。 詳細については、「プロパティ値の継承」を参照してください。
適用対象
RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback)
プロパティ型、所有者型、プロパティ メタデータ、および検証コールバックを指定して、読み取り専用の添付プロパティを登録します。
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
Public Shared Function RegisterAttachedReadOnly (name As String, propertyType As Type, ownerType As Type, defaultMetadata As PropertyMetadata, validateValueCallback As ValidateValueCallback) As DependencyPropertyKey
パラメーター
- name
- String
登録する依存関係プロパティの名前。
- propertyType
- Type
プロパティの型。
- ownerType
- Type
依存関係プロパティを登録する所有者型。
- defaultMetadata
- PropertyMetadata
依存関係プロパティのプロパティ メタデータ。
- validateValueCallback
- ValidateValueCallback
通常の型検証に加えて、依存関係プロパティ値のカスタム検証を実行する必要があるユーザー作成のコールバックへの参照。
戻り値
クラスの静的な読み取り専用フィールドの値を設定するために使用する必要があり、依存関係プロパティの参照に使用される、依存関係プロパティのキー。
注釈
このメソッドは型 DependencyPropertyKeyを返しますが、 RegisterAttached 型を返します DependencyProperty。 通常、型 DependencyPropertyを表すキーです。 通常、読み取り専用プロパティを表すキーは公開されません。これは、キーを使用して呼び出 SetValue(DependencyPropertyKey, Object)すことによって依存関係プロパティの値を設定できるためです。 クラスの設計は要件に影響しますが、通常は、クラスまたはアプリケーション ロジックの一部として依存関係プロパティを設定するために必要なコードの部分のみに、アクセス DependencyPropertyKey と可視性を制限することをお勧めします。 また、クラスのフィールドとしてpublic static readonly
値を公開することで、読み取り専用の依存関係プロパティのDependencyPropertyKey.DependencyProperty依存関係プロパティ識別子を公開することもお勧めします。
添付プロパティの主なシナリオは XAML での使用であるため、読み取り専用の添付プロパティはまれなシナリオです。 パブリック セッターがない場合、添付プロパティを XAML 構文で設定することはできません。
依存関係プロパティの登録の詳細については、次を参照してください DependencyProperty。
値を継承する依存関係プロパティに RegisterAttached を使用する
依存関係プロパティを添付として登録する特定のシナリオの 1 つは、プロパティ値の Register 継承をサポートすることです。 値を継承する依存関係プロパティは、依存関係プロパティ RegisterAttached を公開するプロパティ ラッパー アクセサーをクラスが定義している場合でも、また、Get* および Set* 静的メソッドを公開して、実際の添付プロパティ サポート アクセサーを提供しない場合でも登録する必要があります。 プロパティ値の継承は、接続されていない依存関係プロパティでは機能するように見えますが、ランタイム ツリー内の特定の要素境界を介した接続されていないプロパティの継承動作は未定義です。 プロパティを添付として効果的に登録すると、添付プロパティがプロパティ システムのグローバル プロパティになり、プロパティ値の継承が要素ツリー内のすべての境界を越えて機能することが保証されます。 メタデータで Inherits を指定する場合は、必ず RegisterAttached を使用してプロパティを登録します。 詳細については、「プロパティ値の継承」を参照してください。