DependencyProperty.Register メソッド

定義

プロパティの指定したプロパティ名、プロパティの種類、所有者の種類、およびプロパティ メタデータを使用して、依存関係プロパティを登録します。 登録された依存関係プロパティを所有する DependencyObject 派生クラスを定義または初期化する場合は、このメソッドを使用します。

 static DependencyProperty Register(winrt::hstring const& name, TypeName const& propertyType, TypeName const& ownerType, PropertyMetadata const& typeMetadata);
public static DependencyProperty Register(string name, System.Type propertyType, System.Type ownerType, PropertyMetadata typeMetadata);
function register(name, propertyType, ownerType, typeMetadata)
Public Shared Function Register (name As String, propertyType As Type, ownerType As Type, typeMetadata As PropertyMetadata) As DependencyProperty

パラメーター

name
String

winrt::hstring

登録する依存関係プロパティの名前。

propertyType
TypeName Type

型参照としての プロパティの型 (System.Type for Microsoft .NET、Visual C++ コンポーネント拡張機能の TypeName ヘルパー構造体 (C++/CX))。

ownerType
TypeName Type

依存関係プロパティを型参照として登録している所有者型 (System.Type for Microsoft .NET、Visual C++ コンポーネント拡張機能 (C++/CX) の TypeName ヘルパー構造体)。

typeMetadata
PropertyMetadata

プロパティ メタデータ インスタンス。 これには、既定値と PropertyChangedCallback 実装参照を含めることができます。 このパラメーターの渡し null は、既定値パラメーターとして PropertyMetadata.Create を呼び出して作成された新しい PropertyMetadata インスタンスを渡すことと null 同じです。

戻り値

DependencyObject 派生クラスのパブリック静的読み取り専用フィールドに通常格納される 依存関係 プロパティ識別子。 その後、識別子は、独自のコードとサードパーティのユーザー コードの両方で使用され、後で依存関係プロパティを参照し、その値をプログラムで設定したり、 コードで Binding をアタッチしたりするなどの操作に使用されます。

注釈

カスタム依存関係プロパティを登録する方法については、「 カスタム依存関係プロパティ」のトピックで詳しく説明されています (例を参照)。

通常、依存関係プロパティの登録は、アプリが最初に開始されたとき、またはアプリ コードによって定義された DependencyObject 派生クラスが最初に使用される場合にのみ行います。 依存関係プロパティは、アプリの有効期間の早い段階で登録する必要があります。これにより、アプリ内の他のコードと XAML が、依存関係プロパティを登録して使用できるようになる前に、依存関係プロパティの使用を試みないようにする必要があります。 正確に登録する方法とタイミングは、プログラミング言語によって異なります。 C# または Microsoft Visual Basic の場合、依存関係プロパティを所有するクラスの静的クラスの初期化中に依存関係プロパティを登録するのが一般的です。 このようにして、インスタンスを初期化するコードまたは XAML は、その静的構築を呼び出し、依存関係プロパティを登録します。 Visual C++ コンポーネント拡張機能 (C++/CX) の場合、静的クラスの初期化は使用できない手法であるため、通常は、 アプリケーション オブジェクトの初期化の一環として、アプリで使用するすべてのカスタム依存関係プロパティを登録するアプリ全体のヘルパー メソッドを定義する必要があります。 Visual C++ コンポーネント拡張機能 (C++/CX) に必要な特別な手法など、カスタム依存関係プロパティを登録する方法とタイミングの例については、「 カスタム依存関係プロパティ」を参照してください。

適用対象

こちらもご覧ください