依存関係プロパティ値の優先順位

[アーティクル]
08/09/2011

ここでは、Windows Presentation Foundation (WPF) プロパティシステムの機能が依存関係プロパティの値にどのように影響する可能性があるかについて説明し、プロパティシステムの側面がプロパティの有効値に適用される際の優先順位を示します。

このトピックは、次のセクションで構成されています。

必要条件
WPF プロパティシステム
複数の場所に "設定" 可能な依存関係プロパティ
依存関係プロパティ設定の優先順位リスト
TemplatedParent
Style プロパティ
既定の (テーマ) スタイル。
動的リソース参照とバインディング
SetCurrentValue
強制、アニメーション、および基本値
トリガー動作
ClearValue および値の優先順位
関連トピック

必要条件

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

WPF プロパティシステム

WPF プロパティシステムは、依存関係プロパティの値をさまざまな要素に基づいて決定するための強力な方法を提供し、リアルタイムのプロパティ検証や遅延バイディングなどの機能を実現すると共に、関連するプロパティに他のプロパティの値の変更について通知します。依存関係プロパティの値を決定するために使用される厳密な順序とロジックは、かなり複雑です。この順序を理解することにより、不必要なプロパティ設定を回避できると同時に、依存関係プロパティ値を変更または取得する操作を行ったにもかかわらず最終的に想定どおりの値が設定されなかった場合、その原因を究明できます。

複数の場所に "設定" 可能な依存関係プロパティ

1 つのプロパティ (Background) に、値に影響を与える可能性がある 3 つの異なる "設定" 操作がある場合の XAML 例を次に示します。

    <Button Background="Red">
      <Button.Style>
        <Style TargetType="{x:Type Button}">
          <Setter Property="Background" Value="Green"/>
          <Style.Triggers>
            <Trigger Property="IsMouseOver" Value="True">
              <Setter Property="Background" Value="Blue" />
            </Trigger>
          </Style.Triggers>
        </Style>
      </Button.Style>
Click
    </Button>

ここでは、赤色、緑色、青色のうち、どの色が適用されるかを考えます。

アニメーション化された値および強制を除き、ローカルのプロパティセットが最も高い優先順位で設定されます。任意のスタイルまたはコントロールテンプレートの上に設定した場合でも、ローカルに値を設定すると、この値が適用されると想定できます。この例では、Background が Red としてローカルに設定されています。したがって、このスコープ内で定義されるスタイルは、これ以外の場合にはそのスコープ内のその型のすべての要素に適用される暗黙のスタイルであっても、Background プロパティに値を指定する際には最高の優先順位を持ちません。 Button インスタンスから Red のローカル値を削除した場合は、スタイルが優先され、ボタンはスタイルから Background 値を取得します。スタイル内ではトリガーが優先されるため、マウスが置かれるとボタンは青色になり、それ以外の場合は緑色になります。

依存関係プロパティ設定の優先順位リスト

依存関係プロパティのランタイム値を割り当てる際に、最終的にプロパティシステムで使用される順序を次に示します。優先順位の高いものから順に示します。このリストは、「依存関係プロパティの概要」で取り上げた一般化を一部拡張したものです。

プロパティシステムの強制型変換。 強制型変換の詳細については、このトピックの「強制型変換、アニメーション、および基本値」を参照してください。
アクティブなアニメーション、または Hold 動作を使用したアニメーション。 実際的な効果を持たせるためには、プロパティのアニメーションは値がローカルに設定されている場合でも、その基本 (アニメーション化されていない) 値よりも優先される必要があります。詳細については、このトピックの「強制型変換、アニメーション、および基本値」を参照してください。
ローカル値。 ローカル値は "ラッパー" プロパティの利点を利用して設定できます。これは、XAML内で属性またはプロパティ要素として設定することと同じです。また、特定のインスタンスのプロパティを使用して SetValue API を呼び出すことによって設定することもできます。バインディングまたはリソースを使用してローカル値を設定すると、優先順位に関しては値を直接設定した場合と同じように扱われます。
TemplatedParent テンプレートプロパティ。 テンプレート (ControlTemplate または DataTemplate) の一部として作成された要素には、TemplatedParent が含まれます。これが当てはまる状況については、このトピックの「TemplatedParent」を参照してください。テンプレート内では、次の優先順位が適用されます。
1. TemplatedParent テンプレートからのトリガー。
2. TemplatedParent テンプレート内のプロパティセット (通常は XAML 属性によって提供される)。
暗黙のスタイル。 Style プロパティにだけ適用されます。 Style プロパティには、その要素の種類に一致するキーを持つスタイルリソースが設定されます。このスタイルリソースは、ページまたはアプリケーション内に存在する必要があります。暗黙のスタイルリソースの検索はテーマまで進行しません。
スタイルのトリガー。 ページまたはアプリケーションからのスタイル内トリガー (スタイルは明示または暗黙のスタイルですが、優先順位の低い既定のスタイルではありません)。
テンプレートのトリガー。 スタイル内のテンプレートの任意のトリガー、または直接適用されたテンプレート。
スタイルの setter。 ページまたはアプリケーションからのスタイル内 Setter の値。
既定の (テーマ) スタイル。 これが適用される状況とテーマスタイル内でのテーマスタイルとテンプレートの関連付けの詳細については、このトピックの「既定の (テーマ) スタイル」を参照してください。既定のスタイル内では、次の優先順位が適用されます。
1. テーマスタイル内のアクティブなトリガー。
2. テーマスタイル内の setter。
継承。 いくつかの依存関係プロパティは、アプリケーション全体で各要素に明確に設定しなくて済むように、親要素から子要素に値が継承されます。詳細については、プロパティ値の継承を参照してください。
依存関係プロパティのメタデータの既定値。 依存関係プロパティは、その特定のプロパティのプロパティシステム登録によって設定された既定値を持つ場合があります。また、依存関係プロパティを継承する派生クラスは、型ごとにそのメタデータ (既定値を含む) をオーバーライドすることができます。詳細については、「依存関係プロパティのメタデータ」を参照してください。継承されたプロパティについては、既定値の前に継承がチェックされるため、親要素の既定値が子要素よりも優先されます。このため、継承可能なプロパティがどこにも設定されていない場合は、子要素の既定値の代わりにルートまたは親に指定された既定値が使用されます。

TemplatedParent

優先順位項目としての TemplatedParent は、標準のアプリケーションマークアップに直接宣言した要素のプロパティには適用されません。 TemplatedParent の概念は、テンプレートのアプリケーションを通じて成立するビジュアルツリー内の下位項目に対してのみ存在します。プロパティシステムが値の TemplatedParent テンプレートを検索する場合は、その要素を作成したテンプレートが検索されます。一般に、TemplatedParent テンプレートのプロパティ値は、下位要素のローカル値として設定されている場合と同様に機能します。ただし、テンプレートは共有されている可能性があるため、優先順位はローカル値よりも下位である必要があります。詳細については、「TemplatedParent」を参照してください。

Style プロパティ

前に説明した検索の順序は、Style プロパティを除く、存在するすべての依存関係プロパティに適用されます。 Style プロパティは、それ自体のスタイルを設定できないという特異なプロパティであるため、優先順位の項目 5 ～ 8 は適用されません。また、Style のアニメーションまたは強制型変換は推奨されません (Style のアニメーションにはカスタムのアニメーションクラスが必要になります)。 Style プロパティを設定する方法として、残されたのは次の 3 つです。

明示的なスタイル。 Style プロパティを直接設定します。ほとんどのシナリオでは、スタイルをインラインで定義するのではなくリソースとして明示的なキーにより参照します。この場合、Style プロパティ自体はローカル値であるかのように動作します (優先順位の項目 3)。
暗黙のスタイル。 Style プロパティを直接設定しません。ただし、Style はリソース検索シーケンスのどれかのレベル (ページ、アプリケーション) に存在し、適用対象のスタイルの種類に一致するリソースキーによりキーが設定されます。この場合、Style プロパティ自体はシーケンス内で優先順位の項目 5 となるように動作します。この情報は、Style プロパティに DependencyPropertyHelper を使用し、その結果で ImplicitStyleReference を検索することによって確認できます。
既定のスタイル (別名テーマスタイル)。 Style プロパティは直接設定しません。実行時までは、プロパティを読み取ると null が返されます。この方法では、スタイルは、WPF プレゼンテーションエンジンの一部である実行時テーマ評価処理によって生成されます。

テーマ内にない暗黙のスタイルの場合、型は正確に一致する必要があります。たとえば、Button 派生クラス MyButton では、Button のスタイルは暗黙的には使用されません。

既定の (テーマ) スタイル。

WPF に付属するコントロールには既定のスタイルがあります。既定のスタイルはテーマによって異なる可能性があります。既定のスタイルがテーマスタイルとも呼ばれるのは、このような理由があるためです。

コントロールの既定のスタイルに含まれる最も重要な情報は、コントロールテンプレートです。このテンプレートは、テーマスタイルでは Template プロパティの setter として存在します。既定のスタイルにテンプレートがなかったとしたら、カスタムスタイルの一部としてカスタムテンプレートを持たないコントロールは、表示形式をまったく持たないことになります。既定のスタイルのテンプレートによって、コントロールの表示形式に基本構造が与えられ、テンプレートのビジュアルツリーに定義されたプロパティとそれに対応するコントロールクラスが適切に接続されます。コントロールからは、テンプレートを完全に置き換えなくてもコントロールの表示形式を変更できる一連のプロパティが提供されます。たとえば、Thumb コントロールの既定の表示形式を例として説明します。このコントロールは、ScrollBar のコンポーネントです。

Thumb は、特定のカスタマイズしたプロパティを持ちます。 Thumb の既定のテンプレートによって、傾斜して表示されるいくつかの入れ子になった Border コンポーネントから成る基本構造とビジュアルツリーが作成されます。テンプレートの一部であるプロパティを Thumb クラスによってカスタマイズされることを意図して公開する場合は、テンプレート内で TemplateBinding を使用してそのプロパティを公開する必要があります。 Thumb では、これらの境界のさまざまなプロパティは Background や BorderThickness などのプロパティへのテンプレートバインディングを共有します。しかし、他の特定のプロパティやビジュアル配置は、コントロールテンプレート内にハードコーディングされるかテーマに直接設定された値にバインドされており、テンプレート全体を置き換えるには不十分であるため変更できません。一般にプロパティが、テンプレート化されている親に由来し、テンプレートバインディングから公開されない場合、対象をこのプロパティに設定する簡単な方法がないため、スタイルを使用して調整することはできません。しかし、このプロパティも、適用されるテンプレートのプロパティ値継承による、または既定値による影響を受けます。

テーマスタイルの定義では、データ型がキーとして使用されます。ただし、テーマを特定の要素インスタンスに適用すると、この型に対するテーマの検索は、コントロールの DefaultStyleKey プロパティをチェックすることにより実行されます。これは、暗黙のスタイルでリテラル型が使用されるのと対照的です。 DefaultStyleKey の値は、実装側で変更されない場合でも派生クラスに継承されます (プロパティを変更する方法として意図されているのは、プロパティレベルでオーバーライドすることではなく、既定値をプロパティメタデータで変更することです)。このような間接的な方法を使うことにより、基本クラスでは、他の方法ではスタイルを持つことがない (さらに重要なことには、そのスタイル内にテンプレートを持たないため既定の表示形式をまったく持つことがない) 派生要素にテーマスタイルを定義できます。そのため、MyButton を Button から派生でき、さらに Button 既定テンプレートを取得できます。 MyButton コントロールの作成者が別の動作を必要とする場合は、別のキーを返すよう DefaultStyleKey の依存関係プロパティのメタデータを MyButton でオーバーライドし、MyButton コントロールにパッケージ化する必要がある MyButton 用テンプレートなどを関連テーマスタイルに定義できます。テーマ、スタイル、およびコントロールの作成の詳細については、「コントロールの作成の概要」を参照してください。

動的リソース参照とバインディング

動的リソース参照とバインディング操作では、設定された場所の優先順位が優先されます。たとえば、ローカル値に適用される動的リソースは優先順位の項目 3 に準拠し、テーマスタイル内のプロパティ setter のバインディングは優先順位の項目 9 で適用されます。動的リソース参照とバインディングはどちらも、アプリケーションの実行時の状態から値を取得できる必要があります。このため、指定された任意のプロパティに対してプロパティ値の優先順位を決定する実際のプロセスは、実行時まで拡張されます。

動的リソース参照は、厳密にはプロパティシステムの一部ではありませんが、前に述べた順序に関連する独自の検索順序を持ちます。この優先順位の詳細については、「リソースの概要」を参照してください。この優先順位は、簡単に要約すると、ページルート、アプリケーション、テーマ、システムに対する要素です。

動的リソース参照とバインディング操作は設定された場所の優先順位を持ちますが、その値は遅延されます。このため、動的リソースまたはバインディングをローカル値に設定した場合、このローカル値を変更すると動的バインディングまたはバインディング全体が完全に置き換えられます。ローカルに設定された値を消去するために ClearValue メソッドを呼び出した場合でも、動的リソースまたはバインディングは復元されません。実際、動的リソースまたはバインディングが指定されたプロパティ (リテラルのローカル値ではない) で ClearValue を呼び出した場合、これらもこの ClearValue の呼び出しによって消去されます。

SetCurrentValue

SetCurrentValue メソッドはプロパティを設定するためのもう 1 つの方法ですが、プロパティの設定は優先順位の順に行われません。 SetCurrentValue を使用すると、前の値のソースを上書きすることなくプロパティ値を変更できます。 SetCurrentValue は、ローカル値の優先順位を与えずに値を設定する場合にいつでも使用できます。たとえば、トリガーによってプロパティが設定され、SetCurrentValue を介してこのプロパティに別の値が割り当てられた場合、プロパティシステムはトリガーを考慮するため、トリガーのアクションが発生するとプロパティは変更されます。 SetCurrentValue を使用すると、高い優先順位を持つソースを与えることなくプロパティ値を変更できます。同様に、SetCurrentValue を使用すると、バインディングを上書きすることなくプロパティ値を変更できます。

強制、アニメーション、および基本値

強制とアニメーションはどちらも、この SDK 全体で "基本値" と呼ばれる値に基づいて機能します。基本値は、項目 2 に達するまで項目を上方に評価することによって決定される値です。

アニメーションでは、特定の動作に "From" と "To" の両方を指定していない場合、またはアニメーションが完了すると基本値に戻るようにする場合に、基本値はアニメーション化される値に影響を与えます。これを実際に確かめるには、アニメーションのターゲット値 (From、To、および By) のサンプルを実行します。ローカル値の初期値をアニメーション内の "From" とは異なる値にするために、例の中で四角形の高さを示すローカル値を設定してください。アニメーションは "From" 値を使用して直ちに開始され、開始後にこの基本値を置き換えます。アニメーションは、Stop FillBehavior を指定してアニメーションを完了した後、アニメーションの前に見つかった値に戻るように指定できます。それ以降、基本値の決定には通常の優先順位が使用されます。

1 つのプロパティに複数のアニメーションが適用され、アニメーションごとに値の優先順位に関する定義が異なる場合が考えられます。この場合は、単に優先順位が高いアニメーションを適用するのではなく、アニメーションでそれらの値を組み合わせることがあります。これは、アニメーションが実際にどのように定義されているか、およびアニメーション化される値の型によって異なります。プロパティのアニメーション化の詳細については、「アニメーションの概要」を参照してください。

強制は、最高レベルで適用されます。既に実行中のアニメーションでも、値の強制に制約されます。 WPF 内の既存の依存関係プロパティの中には、組み込みの強制を持つものがあります。カスタム依存関係プロパティの場合は、プロパティの作成時に CoerceValueCallback を記述し、メタデータの一部としてコールバックを渡すことにより、カスタム依存関係プロパティの強制動作を定義します。また、派生クラス内のそのプロパティでメタデータをオーバーライドすることにより、既存のプロパティの強制動作をオーバーライドすることもできます。強制の制約がその時点の制約として適用されるが基本値は引き続き保持されるという形で、強制は基本値と関係しています。したがって、その後で強制の制約が解除されると、強制はその基本値に最も近い値を返し、制約がすべて解除された場合には、強制のプロパティへの影響は直ちになくなる可能性があります。強制型変換の動作の詳細については、「依存関係プロパティのコールバックと検証」を参照してください。

トリガー動作

多くの場合、コントロールは、トリガー動作をテーマ内の既定のスタイルの一部として定義します。コントロールにローカルプロパティを設定すると、ユーザーによる表示上または動作上のイベントに対してトリガーが応答できなくなる場合があります。プロパティトリガーは、最も一般的には、コントロールプロパティや IsSelected などの状態プロパティのために使用されます。たとえば、既定で Button が無効な場合 (IsEnabled のトリガーが false の場合)、テーマスタイル内の Foreground 値によってコントロールは "灰色表示" されます。ただし、ローカルの Foreground 値を設定している場合は、プロパティがトリガーされるというこのシナリオでも、ローカルプロパティセットが通常の灰色表示よりも優先されます。テーマレベルのトリガー動作が含まれるプロパティの値の設定は慎重に行い、そのコントロールで意図されるユーザーエクスペリエンスに過度に干渉しないようにしてください。

ClearValue および値の優先順位

ClearValue メソッドは、要素に設定される依存関係プロパティからローカルに適用された値を消去するのに役立つ方法を提供します。ただし、ClearValue を呼び出しても、プロパティの登録時にメタデータ内に設定された既定値が新しい有効値になることは保証されません。値の優先順位に関係するその他すべての値は依然としてアクティブです。ローカルに設定された値のみが、一連の優先順位から削除されています。たとえば、テーマスタイルによっても設定されているプロパティで ClearValue を呼び出すと、テーマ値はメタデータに基づいた既定値ではなく新しい値として適用されます。プロセスから関連するすべてのプロパティ値を取得して、登録されたメタデータの既定値に値を設定する場合は、依存関係プロパティのメタデータを照会することによって明確に既定値を取得でき、さらにこの既定値を使用し、SetValue を呼び出してプロパティをローカルに設定できます。