DependencyProperty クラス

定義

public ref class DependencyProperty sealed

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class DependencyProperty final

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class DependencyProperty

Public NotInheritable Class DependencyProperty

継承

Object Platform::Object IInspectable DependencyProperty

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

例

この例では、 DependencyProperty がクラスのパブリック静的メンバーとして確立される基本的な使用方法を示します。 これを行うには、 Register を呼び出し、戻り値をクラスのメンバーとして格納します。 その他の例については、「 カスタム依存関係プロパティ」を参照してください。

public class Fish : Control
{
    public static readonly DependencyProperty SpeciesProperty =
    DependencyProperty.Register(
    "Species",
    typeof(String),
    typeof(Fish), null
    );
    public string Species
    {
        get { return (string)GetValue(SpeciesProperty); }
        set { SetValue(SpeciesProperty, (string)value); }
    }
}

注釈

依存関係プロパティの概念については、 依存関係プロパティの概要に関するトピックで詳しく説明します。

DependencyPropertyのインスタンスは、多くの場合、依存関係プロパティ識別子としてドキュメントで参照されます。 識別子は、特定の DependencyObject 所有者型に登録された依存関係プロパティを参照する方法を提供します。 所有者型がプロパティを登録すると、所有者型は、 DependencyProperty インスタンスを識別子として公開します。これは、所有者クラスの静的メンバーです。

所有者 DependencyObject は、依存関係プロパティのプロパティ ストアを提供します。 コードで依存関係プロパティを使用する場合は、SetValue などのプロパティ システム メソッドの呼び出しの入力としてDependencyProperty識別子を使用できます。 ただし、ほとんどの場合、 ラッパーを取得または設定することで、依存関係プロパティの取得または設定が簡単になります。この概念については、 依存関係プロパティの概要で説明します。

DependencyProperty では、値を入力するための XAML 属性構文のネイティブ変換がサポートされています。これは、 Setter が プロパティ 値を指定するときに使用されます。 この変換では ownerTypeName を使用します。入力文字列の propertyName フォーム。

Windows ランタイムは、DependencyObject のDependencyProperty識別子とプロパティ ストレージを持つ XAML 添付プロパティ言語機能を実装します。 詳細については、「 添付プロパティの概要」を参照してください。

カスタム依存関係プロパティ

カスタム型のプロパティで値の式、データ バインディング、またはアニメーションをサポートする場合は、次のガイドラインに従って依存関係プロパティを使用してプロパティをバックアップする必要があります。

• Register メソッドを使用して依存関係プロパティを 登録 し、 DependencyPropertyを返します。 これは依存関係プロパティ識別子です。 このオブジェクトは、クラス内のアクセス可能な静的読み取り専用プロパティとして公開する必要があります。 慣例により、この DependencyProperty 識別子フィールドの名前は "Property" で終わる必要があります。
• 登録時に、 プロパティの PropertyMetadata を指定して、プロパティの動作をさらに定義できます。
• プロパティの get アクセサーと set アクセサーを指定します。これらはプロパティ ラッパーであり、すべての呼び出し元のプロパティへのアクセスを簡略化します。

依存関係プロパティ名への XAML 参照

XAML マークアップで通常設定されるプロパティの中には、値として DependencyProperty を使用するものもあります。 たとえば、XAML で Setter.Property を 設定します。 XAML でこのようなプロパティを設定するには、依存関係プロパティの名前を属性値として指定します。

Setter.Property の場合、依存関係プロパティ名を参照する型のスコープは、Setter が存在する Style の TargetType によって既に指定されています。 TargetType オブジェクトの依存関係プロパティの場合は、依存関係プロパティの単純な名前を使用して Setter.Property 値を指定できます。 たとえば、スライダーを対象とするスタイルがあり、Orientation プロパティのスタイルを設定する場合、Property 属性値は "Orientation" に設定できます。 単純な名前は、依存関係プロパティがターゲット型のより深い継承のクラスから取得されている限り、機能します。 たとえば、スライダーのスタイルで Visibility プロパティのスタイルを設定するには、Property 属性値 "Visibility" が機能します。 その場合 、可視性 は UIElement によって定義されましたが、 Slider に継承されます。

Setter.Property を使用して、添付プロパティ名を参照することもできます。 属性値には、XAML でその添付プロパティを属性として設定する場合と同様 に、AttachedPropertyOwner.AttachedPropertyName という形式を使用します。 たとえば、スタイルの添付プロパティ AutomationProperties.ItemType を設定する Setterを次に示します。<Setter Property="AutomationProperties.ItemType" Value="Navigation Button"/>

コードでの DependencyProperty (依存関係プロパティ識別子) の使用

DependencyProperty値を入力パラメーターとして使用するWindows ランタイム プロパティ システムのユーティリティ メソッドには、いくつかのメソッドがあります。 これらには次のものが含まれます。

• DependencyObject.ClearValue
• DependencyObject.GetAnimationBaseValue
• DependencyObject.GetValue
• DependencyObject.ReadLocalValue
• DependencyObject.SetValue
• DependencyPropertyChangedEventArgs.Property
• Setter(DependencyProperty,Object) コンストラクター

こちらもご覧ください

• カスタム依存関係プロパティ
• 依存関係プロパティの概要
• カスタム添付プロパティ
• XAML ユーザー コントロールとカスタム コントロールのサンプル