このトピックでは、ユーザーが Windows Presentation Foundation (WPF) クラスの既存の依存関係プロパティの使用という観点から依存関係プロパティを理解し、「依存関係プロパティの概要」トピックを通読していることを前提としています。このトピックの例を実行するには、Extensible Application Markup Language (XAML) について理解し、WPF アプリケーションの記述に精通している必要があります。

添付プロパティの目的の 1 つは、実際には親要素で定義されるプロパティについて、子要素がそれぞれ別の値を指定できるようにすることです。このシナリオは、たとえば、子要素をユーザー インターフェイス (UI) にどのように表示するかを子要素から親要素に通知させるという状況に応用されます。DockPanel..::.Dock プロパティがその一例です。DockPanel..::.Dock プロパティが添付プロパティとして作成されるのは、このプロパティが DockPanel 自体ではなく DockPanel に含まれる要素に対して設定するように設計されているためです。DockPanel クラスでは、DockProperty という名前の静的 DependencyProperty フィールドが定義されており、添付プロパティのパブリック アクセサとして GetDock メソッドと SetDock メソッドが定義されています。

XAML では、AttachedPropertyProvider.PropertyName 構文を使用して添付プロパティを設定します。

XAML で DockPanel..::.Dock を設定する方法を次の例に示します。

<DockPanel>
  <CheckBox DockPanel.Dock="Top">Hello</CheckBox>
</DockPanel>

使用方法が静的プロパティに少し似ていることに注意してください。名前で指定されたインスタンスを参照するのではなく、添付プロパティを所有および登録する DockPanel 型を常に参照します。

また、XAML では、添付プロパティはマークアップ内で設定する属性であるので、有効な操作は設定のみです。XAML の中でプロパティを直接取得することはできませんが、スタイルのトリガなど、間接的に値を比較する機構があります (詳細については、「スタイルとテンプレート」を参照してください)。

WPF での添付プロパティの実装

添付プロパティはどのオブジェクトに対しても設定可能ですが、プロパティを設定することで具体的な結果が得られたり、その値が他のオブジェクトから使用されたりするわけではありません。大まかにいって、添付プロパティの目的は、さまざまなクラス階層または論理上のリレーションシップから発生するオブジェクトのそれぞれが、所有する型に対して共通の情報を報告できるようにすることです。添付プロパティを定義する型は一般に、次のいずれかのモデルに従います。

• 添付プロパティを定義する型は、添付プロパティの値を設定する要素の親要素になることができるように設計されています。この型は、内部ロジックを通じて自身の子要素を反復処理して値を取得し、その値に対するなんらかの処理を行います。

• 添付プロパティを定義する型は、さまざまな親要素およびコンテンツ モデルの子要素として使用されます。

• 添付プロパティを定義する型は、サービスを表します。その他の型は、添付プロパティの値を設定します。プロパティを設定する要素がサービスのコンテキスト内で評価されるときに、サービス クラスの内部ロジックを通じて添付プロパティの値が取得されます。

親要素で定義された添付プロパティの例

WPF の添付プロパティには、get および set のアクセスを容易にするための標準的な CLR "ラッパー" メソッドはありません。これは、添付プロパティが設定されたインスタンスの CLR 名前空間に、その添付プロパティが属しているとは限らないからです。ただし、XAML リーダーは、XAML の処理時にこれらの値を設定できる必要があります。添付プロパティを有効にするには、添付プロパティの所有者型が GetPropertyName および SetPropertyName の形式で専用アクセサ メソッドを実装する必要があります。コードで添付プロパティを取得または設定するときも、この専用アクセサ メソッドを使用する必要があります。コードの観点から言うと、添付プロパティは、プロパティ アクセサではなくメソッド アクセサを持つバッキング フィールドに似ています。そしてそのバッキング フィールドは、任意のオブジェクトに存在し得るもので、具体的な定義を必要とするものではありません。

コードで添付プロパティを設定する方法を次の例に示します。この例では、myCheckBox は CheckBox クラスのインスタンスです。

DockPanel myDockPanel = new DockPanel();
CheckBox myCheckBox = new CheckBox();
myCheckBox.Content = "Hello";
myDockPanel.Children.Add(myCheckBox);
DockPanel.SetDock(myCheckBox, Dock.Top);

XAML の場合と同様に、コードの 3 行目の時点で myCheckBox が myDockPanel の子要素として追加されていなくても、コードの 4 行目で例外が発生することはありませんが、プロパティ値と親 DockPanel とが相互作用しないので、何も実行されません。子要素で DockPanel..::.Dock 値が設定されていて、親要素の DockPanel が存在する場合にのみ、レンダリングされたアプリケーション内で有効な動作が実行されます。

プロパティを登録するときに、FrameworkPropertyMetadata を設定してプロパティの特性を指定します。たとえば、プロパティがレンダリングやサイズ測定に影響を及ぼすかどうかを指定します。通常、添付プロパティのメタデータは、依存プロパティのメタデータと違いはありません。オーバーライドで添付プロパティ メタデータに既定値を指定した場合、その値は、オーバーライドしたクラスのインスタンスの暗黙の添付プロパティの既定値となります。具体的には、なんらかのプロセスが、Get メソッド アクセサを通じて添付プロパティの値をクエリするときに、メタデータを設定したクラスのインスタンスを指定した場合、その添付プロパティの値が他では特に設定されていないときには、既定値が通知されます。

プロパティ値の継承を有効にするときには、添付プロパティ以外の依存関係プロパティではなく、添付プロパティを使用する必要があります。詳細については、「プロパティ値の継承」を参照してください。

いつ添付プロパティを作成するか

添付プロパティの作成方法

public static readonly DependencyProperty IsBubbleSourceProperty = DependencyProperty.RegisterAttached(
  "IsBubbleSource",
  typeof(Boolean),
  typeof(AquariumObject),
  new FrameworkPropertyMetadata(false, FrameworkPropertyMetadataOptions.AffectsRender)
);
public static void SetIsBubbleSource(UIElement element, Boolean value)
{
  element.SetValue(IsBubbleSourceProperty, value);
}
public static Boolean GetIsBubbleSource(UIElement element)
{
  return (Boolean)element.GetValue(IsBubbleSourceProperty);
}

• 添付プロパティの作成の詳細については、「方法 : 添付プロパティを登録する」を参照してください。

• 依存関係プロパティと添付プロパティの使用方法のより高度なシナリオについては、「カスタム依存関係プロパティ」を参照してください。

• プロパティを添付プロパティおよび依存関係プロパティとして登録するけれども "ラッパー" 実装も公開するということも可能です。この場合、プロパティはその要素に対して設定することも、XAML 添付プロパティ構文をとおして任意の要素に対して設定することもできます。標準の使用法と添付での使用法の両方について適切なシナリオを持つプロパティの例が、FrameworkElement..::.FlowDirection です。

処理手順

概念

参照