依存関係プロパティ値の優先順位
このトピックでは、Windows Presentation Foundation (WPF) プロパティ システムの動作が依存関係プロパティの値に与える影響と、システムのさまざまな部分がプロパティの有効な値に適用する優先順位について説明します。
前提条件
このトピックは、WPF クラスの既存の依存関係プロパティのコンシューマーの観点から依存関係プロパティを理解しており、「依存関係プロパティの概要」を読んでいることを前提としています。 このトピックの例に従うには、XAML を理解し、WPF アプリケーションの記述方法についても理解しておく必要があります。
WPF プロパティ システム
WPF プロパティ システムは、依存関係プロパティの値をさまざまな要因によって決定し、リアルタイム プロパティの検証や遅延バインディングなどの機能を有効にし、他のプロパティの値の変更を関連プロパティに通知する、強力な手段を提供します。 依存関係プロパティの値の決定に使われる正確な順序とロジックはかなり複雑です。 この順序を知っておくと、不要なプロパティの設定を避けることができ、依存関係プロパティの値を設定または予測しようとしても期待通りにならない正確な理由についての混乱も解決される可能性があります。
依存関係プロパティは複数の場所で "設定" される可能性がある
次の XAML の例では、同じプロパティ (Background) に、値に影響を与える可能性がある 3 つの異なる "設定" 操作があります。
<StackPanel>
<StackPanel.Resources>
<ControlTemplate x:Key="ButtonTemplate" TargetType="{x:Type Button}">
<Border Background="{TemplateBinding Background}" BorderThickness="{TemplateBinding BorderThickness}"
BorderBrush="{TemplateBinding BorderBrush}">
<ContentPresenter HorizontalAlignment="Center" VerticalAlignment="Center" />
</Border>
</ControlTemplate>
</StackPanel.Resources>
<Button Template="{StaticResource ButtonTemplate}" Background="Red">
<Button.Style>
<Style TargetType="{x:Type Button}">
<Setter Property="Background" Value="Blue"/>
<Style.Triggers>
<Trigger Property="IsMouseOver" Value="True">
<Setter Property="Background" Value="Yellow" />
</Trigger>
</Style.Triggers>
</Style>
</Button.Style>
Which color do you expect?
</Button>
</StackPanel>
さて、赤、緑、青のどの色になるでしょうか。
アニメーション化された値および強制型変換の場合を除き、ローカル プロパティ セットは最高の優先順位で設定されます。 ローカルに値を設定する場合は、スタイルまたはコントロール テンプレートであっても、その値が採用されるものと期待できます。 この例では、Background はローカルで Red に設定されています。 したがって、このスコープで定義されているスタイルは、それがたとえ暗黙的スタイルであり、他の値が設定されなければそのスコープ内にあるその型のすべての要素に適用される場合でも、Background プロパティの値の設定に関して最高の優先順位ではありません。 Button インスタンスからローカル値の Red を削除すると、スタイルが優先されるようになり、ボタンの Background の値はスタイルから取得されます。 スタイル内ではトリガーが優先されるので、ボタンはマウスでポイントすると青になり、それ以外の場合は緑になります。
依存関係プロパティの設定の優先順位一覧
次に示すのは、依存関係プロパティの実行時の値を割り当てるときにプロパティ システムが使う明確な順序です。 優先順位が高いものから順に示されています。 この一覧では、「依存関係プロパティの概要」で一般化されていたものを拡張してあります。
プロパティ システムの強制型変換。 強制型変換について詳しくは、後の「強制型変換、アニメーション、基本値」をご覧ください。
アクティブなアニメーション、または保留動作のアニメーション。 実際的な効果を得るためには、プロパティのアニメーションは、基本 (アニメーション化されていない) 値 (ローカルに設定された値であっても) より高い優先順位を持つことができる必要があります。 詳しくは、後の「強制型変換、アニメーション、基本値」をご覧ください。
ローカル値。 ローカル値は、便利な "ラッパー" プロパティを使用して設定するか (これは、XAML で属性またはプロパティ要素として設定することと同じです)、または特定のインスタンスのプロパティを使用して SetValue API を呼び出すことにより設定します。 バインドまたはリソースを使ってローカル値を設定する場合、これらは直接値が設定された場合のように優先されます。
TemplatedParent テンプレート プロパティ。 テンプレート (ControlTemplate または DataTemplate) の一部として作成された場合、要素には TemplatedParent があります。 これが適用されるケースについて詳しくは、後の「TemplatedParent」をご覧ください。 テンプレート内では、次の優先順位が適用されます。
TemplatedParent テンプレートからのトリガー。
TemplatedParent テンプレートでのプロパティ セット (通常は XAML 属性により)。
暗黙的スタイル。
Styleプロパティのみに適用されます。Styleプロパティは、その要素の型と一致するキーを持つスタイル リソースによって設定されます。 そのスタイル リソースは、ページまたはアプリケーション内に存在する必要があります。暗黙的スタイル リソースの参照はテーマまでは及びません。スタイルのトリガー。 ページまたはアプリケーションに含まれるスタイル内のトリガー (これらのスタイルは、明示的スタイルまたは暗黙的スタイルどちらの場合もありますが、優先順位の低い既定スタイルではありません)。
テンプレートのトリガー。 スタイル内のテンプレートまたは直接適用されたテンプレートからのトリガーです。
スタイルのセッター。 ページまたはアプリケーションのスタイル内の Setter からの値。
既定 (テーマ) のスタイル。 これが適用される場合、およびテーマ スタイルとテーマ スタイル内のテンプレートの関係について詳しくは、後の「既定 (テーマ) のスタイル」をご覧ください。 既定のスタイル内では、次の優先順位が適用されます。
テーマ スタイル内のアクティブなトリガー。
テーマ スタイル内のセッター。
継承。 いくつかの依存関係プロパティは親要素から子要素に値を継承するので、アプリケーション全体で各要素に値を明示的に設定する必要はありません。 詳しくは、「プロパティ値の継承」をご覧ください。
依存関係プロパティのメタデータの既定値。 どの依存関係プロパティも、その特定のプロパティがプロパティ システムに登録されるときに設定される既定値を持つことができます。 また、依存関係プロパティを継承する派生クラスには、型ごとにそのメタデータ (既定値を含む) をオーバーライドするオプションがあります。 詳しくは、「依存関係プロパティのメタデータ」をご覧ください。 継承は既定値の前にチェックされるため、継承されるプロパティの場合、親要素の既定値の方が子要素より優先されます。 その結果、継承可能なプロパティがどこでも設定されていない場合は、ルートまたは親で指定されている既定値が、子要素の既定値の代わりに使われます。
TemplatedParent
優先順位の項目としての TemplatedParent は、標準アプリケーション マークアップで直接宣言された要素のプロパティには適用されません。 TemplatedParent の概念は、テンプレートの適用によって作成されるビジュアル ツリー内の子項目に対してのみ存在します。 プロパティ システムで TemplatedParent テンプレートの値が検索されるときは、その要素を作成したテンプレートが検索されます。 TemplatedParent テンプレートから設定されるプロパティ値は、通常、子要素でローカルな値として設定された場合と同じように処理されますが、テンプレートは共有される可能性があるため、このようにローカル値より優先順位が低くなります。 詳細については、「TemplatedParent」を参照してください。
スタイル プロパティ
前に説明した参照の順序は、Style プロパティを除くすべての依存関係プロパティに適用されます。 Style プロパティは、それ自体にスタイルを設定できないという点が他とは異なり、そのため優先順位の項目 5 から 8 は適用されません。 また、Style に対してアニメーション化または強制型変換を行うことは推奨されません (そして、Style のアニメーション化にはカスタム アニメーション クラスが必要です)。 これにより、Style プロパティを設定するには 3 つの方法が残ります。
明示的スタイル。 Style プロパティは直接設定されます。 ほとんどの場合、スタイルはインラインでは定義されず、代わりにリソースとして明示的なキーにより参照されます。 この場合、スタイル プロパティ自体は、ローカル値と同じように扱われます (優先順位の項目 3)。
暗黙的スタイル。 Style プロパティは直接設定されません。 ただし、Style はリソース参照シーケンスのいずれかのレベルに存在し (ページ、アプリケーション)、スタイルが適用される型と一致するリソース キーを使ってキーが設定されます。 この場合、Style プロパティ自体は、項目 5 としてシーケンス内で識別される優先順位に従います。 このような状況は、Style プロパティに対して DependencyPropertyHelper を使用し、結果で ImplicitStyleReference を探すことによって検出できます。
既定のスタイル (テーマ スタイルとも呼ばれています)。Style プロパティは直接設定されません。実際、実行時まで
nullとして読み取られます。 この場合、スタイルは、WPF プレゼンテーション エンジンの一部である実行時テーマ評価によって決定されます。
テーマに含まれない暗黙的スタイルの場合は、型が厳密に一致する必要があります。MyButtonButton の派生クラスでは、Button のスタイルは暗黙的に使用されません。
既定 (テーマ) のスタイル
WPF に付属するすべてのコントロールには、既定のスタイルがあります。 既定のスタイルはテーマによって異なる場合があり、そのため、この既定のスタイルはテーマのスタイルとも呼ばれます。
コントロールの既定のスタイルで見つかる最も重要な情報はコントロール テンプレートであり、これは Template プロパティのセッターとしてテーマのスタイル内に存在します。 既定のスタイルにテンプレートがない場合、カスタム スタイルの一部としてカスタム テンプレートがないコントロールは、まったく表示されません。 既定のスタイルのテンプレートは、各コントロールの外観に基本的な構造を提供し、テンプレートのビジュアル ツリーで定義されているプロパティと、対応するコントロール クラスの間の接続を定義します。 各コントロールでは、テンプレートを完全に置き換えることなくコントロールの外観に影響を与えることができる、一連のプロパティが公開されています。 たとえば、Thumb コントロールの既定の外観について考えます。これは、ScrollBar のコンポーネントです。
Thumb には、特定のカスタマイズ可能なプロパティがあります。 Thumb の既定のテンプレートでは、べベルの外観を作成するため、入れ子になった複数の Border コンポーネントで基本的な構造とビジュアル ツリーが作成されます。 テンプレートの一部であるプロパティが、Thumb クラスによるカスタマイズのために公開されることが意図されている場合、テンプレート内で TemplateBinding によってそのプロパティを公開する必要があります。 Thumb の場合、これらの境界のさまざまなプロパティによって、Background や BorderThickness などのプロパティに対するテンプレートのバインドが共有されます。 しかし、他の特定のプロパティや視覚的な配置は、コントロール テンプレートにハードコードされているか、またはテーマから直接取得される値にバインドされており、テンプレート全体を置き換えない限り変更できません。 一般に、プロパティがテンプレート化された親から取得され、テンプレートのバインドによって公開されない場合は、それをターゲットにする簡単な方法がないため、そのプロパティをスタイルによって調整することはできません。 ただし、適用されるテンプレートのプロパティ値継承または既定値によって、そのプロパティに影響を与えることはできます。
テーマのスタイルでは、定義のキーとして型を使います。 ただし、特定の要素のインスタンスにテーマが適用される場合は、コントロールで DefaultStyleKey プロパティをチェックすることによってこの型のテーマ参照が実行されます。 これは、暗黙的スタイルで行われるリテラル型の使用とは対照的です。 実装で変更しなかった場合でも、DefaultStyleKey の値は派生クラスに継承されます (プロパティを変更する方法として意図されているのは、プロパティ レベルでのオーバーライドするのではなく、プロパティ メタデータでの既定値の変更です)。 この間接参照により、基底クラスは、他の方法ではスタイルを持たない派生要素に対してテーマのスタイルを定義できます (または、さらに重要なのは、スタイル内にテンプレートを持たず、既定の外観がないということです)。 したがって、MyButton を Button から派生しながら、既定のテンプレート Button を取得することもできます。 MyButton コントロールを作成するときに動作を変更したい場合は、MyButton の DefaultStyleKey に対する依存関係プロパティ メタデータを、異なるキーを返すようにオーバーライドした後、MyButton のテンプレートを含む関連するテーマ スタイルを定義します。これを MyButton コントロールと共にパッケージ化する必要があります。 テーマ、スタイル、コントロールの作成について詳しくは、「コントロールの作成の概要」をご覧ください。
動的リソース参照とバインド
動的リソース参照とバインド操作には、それらが設定される場所での優先順位が適用されます。 たとえば、ローカル値に適用される動的リソースは優先順位の項目 3 に準拠し、テーマ スタイル内のプロパティ セッターに対するバインドには優先順位の項目 9 が適用されます。 動的リソース参照とバインドはどちらもアプリケーションの実行時状態から値を取得できる必要があるので、特定のプロパティに対するプロパティ値の優先順位を決定する実際のプロセスは、実行時まで拡張されます。
厳密に言うと、動的リソース参照はプロパティ システムの一部ではありませんが、上で示したシーケンスに対応する独自の参照順序を持ちます。 その優先順位について詳しくは、「XAML リソース」をご覧ください。 基本的な優先順位をまとめると、ページ ルートの要素、アプリケーション、テーマ、システムになります。
動的リソースとバインドには設定された場所での優先順位がありますが、値は遅延されます。 その 1 つの帰結として、ローカル値に動的リソースまたはバインドを設定した場合、ローカル値を変更すると動的リソースまたはバインドが完全に置き換えられます。 ClearValue メソッドを呼び出してローカルに設定された値をクリアした場合であっても、動的リソースまたはバインドは復元されません。 実際、動的リソースまたはバインドが設定されている (リテラル ローカル値を持たない) プロパティに対して ClearValue を呼び出す場合、ClearValue の呼び出しによってもクリアされます。
SetCurrentValue
SetCurrentValue メソッドはプロパティを設定するもう 1 つの方法ですが、優先順位の順序には含まれません。 代わりに、SetCurrentValue を使用すると、前の値のソースを上書きすることなく、プロパティの値を変更することができます。 ローカル値の優先順位を値に与えることなく値を設定したい場合はいつでも、SetCurrentValue を使用することができます。 たとえば、プロパティがトリガーによって設定された後、SetCurrentValue によって別の値を割り当てられた場合でも、プロパティ システムではトリガーが優先され、トリガーのアクションが発生するとプロパティは変化します。 SetCurrentValue を使用すると、高い優先順位のソースを指定することなく、プロパティの値を変更できます。 同様に、SetCurrentValue を使用すると、バインドを上書きすることなく、プロパティの値を変更できます。
強制型変換、アニメーション、基本値
強制型変換とアニメーションはどちらも、この SDK で "基本値" と呼ぶ値に対して作用します。 したがって、基本値とは、項目 2 に達するまで項目をさかのぼって評価されることにより決定される値です。
アニメーションの場合、アニメーションで特定の動作に対して "From" と "To" の両方が指定されていない場合、またはアニメーションが完了すると基本値に意図的に戻る場合は、基本値を使ってアニメーション化される値に影響を及ぼすことができます。 実際にどうなるのかを見るには、「From, To, and By Animation Target Values Sample」(アニメーション ターゲット値 From、To、By のサンプル) をご覧ください。 この例で、四角形の高さのローカル値を、初期ローカル値がアニメーションの "From" と異なるように設定してみます。 アニメーションが "From" の値を使ってすぐに開始し、開始すると基本値を置き換えることがわかります。 Stop FillBehavior を指定することによって完了したら、アニメーション前に見つかった値に戻るようにアニメーションで指定されている場合があります。 その後は、通常の優先順位が基本値の決定に使用されます。
1 つのプロパティに複数のアニメーションが適用され、各アニメーションが値の優先順位の異なるポイントから定義されている場合があります。 ただし、これらのアニメーションは、優先順位の高いアニメーションから単純に適用されるのではなく、値が合成される可能性があります。 これは、アニメーションの定義方法と、アニメーション化される値の型に依存します。 プロパティのアニメーション化について詳しくは、「アニメーションの概要」をご覧ください。
強制型変換は、すべての最高レベルで適用されます。 既に実行されているアニメーションであっても値の強制型変換が適用されます。 WPF の既存の依存関係プロパティの一部には、組み込みの強制型変換があります。 カスタム依存関係プロパティの強制型変換の動作を定義するには、CoerceValueCallback を作成し、プロパティ作成時にメタデータの一部としてコールバックを渡します。 派生クラスでプロパティのメタデータをオーバーライドすることにより、既存のプロパティの強制型変換の動作をオーバーライドすることもできます。 強制型変換と基本値の相互作用は、その時点で強制型変換に対する制約が存在するものとして適用されるように行われますが、基本値はそれでも保持されます。 したがって、強制型変換の制約が後で無効になった場合、強制型変換はその基本値に可能な最も近い値を返し、プロパティに対する強制型変換の影響はすべての制約が無効になるとすぐに終了する可能性があります。 強制型変換の動作について詳しくは、「依存関係プロパティのコールバックと検証」をご覧ください。
トリガー動作
コントロールでは、テーマの既定のスタイルの一部としてトリガー動作が定義されていることがよくあります。 コントロールにローカル プロパティを設定すると、ユーザー駆動のイベントに対してトリガーが視覚的または動作的に応答できなくなる可能性があります。 プロパティ トリガーの最も一般的な用途は、コントロールまたは IsSelected などの状態プロパティに対するものです。 たとえば、既定では、Button が無効になると (IsEnabled に対するトリガーが false)、テーマ スタイルの Foreground の値によってコントロールは "グレー表示" になります。 しかし、ローカルな Foreground 値を設定すると、このプロパティ トリガー シナリオでも、通常のグレー表示色はローカル プロパティ セットによって優先順位でオーバーライドされます。 テーマ レベルのトリガー動作があるプロパティの値を設定するときは注意し、そのコントロールの目的のユーザー エクスペリエンスに過度に干渉していないことを確認する必要があります。
ClearValue と値の優先順位
ClearValue メソッドでは、要素で設定された依存関係プロパティからローカルに適用された値をクリアする便利な手段が提供されます。 ただし、ClearValue の呼び出しでは、プロパティ登録の間にメタデータで設定された既定値が新しい有効な値になることは保証されません。 値の優先順位に関係する他のすべての要因はアクティブなままです。 ローカルで設定された値が優先順位のシーケンスから削除されるだけです。 たとえば、テーマ スタイルによっても設定されるプロパティに対して ClearValue を呼び出した場合、メタデータに基づく既定値ではなく、テーマの値が新しい値として適用されます。 プロパティの値に関与するすべての要素をプロセスから排除し、登録されているメタデータの既定値に値を設定したい場合は、依存関係プロパティのメタデータを照会してその既定値を明示的に取得した後、SetValue を呼び出してその既定値をプロパティにローカルで設定できます。
関連項目
.NET Desktop feedback
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示