次の方法で共有

PropertyPath の XAML 構文

  • [アーティクル]

更新 : 2007 年 11 月

PropertyPath オブジェクトは、PropertyPath 型を値として使用する各種プロパティを設定するうえで、複雑な XAML インライン構文をサポートします。このトピックでは、バインディング構文とアニメーション構文に適用される PropertyPath 構文について説明します。

このトピックには次のセクションが含まれています。

  • PropertyPath を使用する場所
  • データ バインディングにおけるオブジェクトの PropertyPath
  • アニメーション ターゲットの PropertyPath
  • コード内の PropertyPath
  • 関連トピック

PropertyPath を使用する場所

PropertyPath は、さまざまな Windows Presentation Foundation (WPF) 機能で使用される共通のオブジェクトです。共通の PropertyPath を使用してプロパティ パス情報を伝えるにもかかわらず、PropertyPath を型として使用する各機能の使用法はそれぞれ異なります。そのため、機能ごとに構文を説明する方が実際的です。

WPF は主に、PropertyPath を使用して、オブジェクト データ ソースのプロパティを走査するオブジェクト モデル パスを記述し、ターゲット アニメーションのターゲット パスを記述します。

Setter.Property など一部のスタイル プロパティやテンプレート プロパティでは、一見すると PropertyPath と似ているプロパティの修飾名が使用されます。しかし、これは実際の PropertyPath ではなく、DependencyProperty の型コンバータと組み合わせて XAML プロセッサで有効化される、owner.property の修飾文字列形式の使用法です。

データ バインディングにおけるオブジェクトの PropertyPath

データ バインディングは WPF の機能であり、依存関係プロパティのターゲット値にバインドできます。ただし、このようなデータ バインディングのソースが依存関係プロパティである必要はなく、適切なデータ プロバイダで認識される任意のプロパティ型でかまいません。プロパティ パスは特に ObjectDataProvider で使用され、共通言語ランタイム (CLR) オブジェクトのバインディング ソースとそのプロパティを取得するのに使用されます。

XML へのデータ バインディングでは、PropertyPath が使用されないことに注意してください。これは、Binding 内で Path を使用しないためです。代わりに、XPath を使用して、有効な XPath 構文をデータの XML ドキュメント オブジェクト モデル (DOM) に指定します。XPath も文字列として指定されますが、ここでは説明しません。「方法 : XMLDataProvider と XPath クエリを使用して XML データにバインドする」を参照してください。

データ バインディングにおけるプロパティ パスを理解するうえで鍵となるのは、個々のプロパティ値をバインドの対象にすることも、リストまたはコレクションを使用するターゲット プロパティにバインドすることもできるということです。コレクションをバインドする場合、プロパティ パスは個々のコレクション項目を参照するのではなく、コレクションを参照します。データ バインディング エンジンは、ソースのコレクションをターゲットに自動的に一致させ、ListBox に項目配列を読み込むなどの処理が行われます。

データ コンテキストとしての直接のオブジェクト上の単一のプロパティ

<Binding Path="propertyName" .../>

propertyName は、Path の使用に対して、現在の DataContext 内にあるプロパティの名前に解決される必要があります。バインディングがソースを更新する場合、そのプロパティは読み書き可能であり、ソース オブジェクトは変更可能である必要があります。

データ コンテキストとしての直接のオブジェクト上の単一のインデクサ

<Binding Path="[key]" .../>

key には、ディクショナリまたはハッシュ テーブルの型指定されたインデックス、または配列の整数インデックスを指定する必要があります。また、キーの値は、適用先のプロパティに直接バインドできる型である必要があります。たとえば、文字列キーと文字列値が含まれるハッシュ テーブルをこのように使用することで、TextBox の Text にバインドできます。キーがコレクションまたはサブインデックスを指す場合は、この構文を使用して、ターゲット コレクション プロパティにバインドできます。それ以外の場合は、<Binding Path="[key].propertyName" .../> などの構文を通じて、特定のプロパティを参照する必要があります。

必要に応じて、インデックスの型を指定できます。インデックス付きプロパティ パスのこの特徴の詳細については、「Binding.Path」を参照してください。

複数プロパティ (間接的なプロパティの対象化)

<Binding Path="propertyName.propertyName2" .../>

propertyName は、現在の DataContext であるプロパティの名前に解決される必要があります。パス プロパティ propertyName および propertyName2 は、リレーションシップ内に存在する任意のプロパティにすることができます。propertyName2 は、propertyName の値である型に存在するプロパティです。

単一プロパティ、XAML 読み込み名前スコープ外、ランタイム リフレクション

<object property="ownerType.propertyName" .../>

この構文は、CLR プロパティへのデータ バインディングのソース パス専用であり、プロパティへの単一ステップ パスのみ指定できます。propertyName は、ownerType に存在するプロパティの名前に解決される必要があります。ownerType は、ランタイム リフレクションに基づいて検出される型であることが必要です。そのため、XML プレフィックスによる ownerType の修飾は無効です。このようなプレフィックスは、リフレクションでは意味がなく、コンパイル時の XAML に対してのみ有効なためです。次のセクションを参照してください。

単一プロパティ、スタイル/テンプレートを通じてコンテキストに添付または待機

<object property="(ownerType.propertyName)" .../>

かっこは、PropertyPath 内のこのプロパティを、部分修飾を使用して構築する必要があることを示します。XML 名前空間を使用して型を検出できます。ownerType は、各アセンブリ内の XmlnsDefinitionAttribute 宣言を通じて、XAML プロセッサがアクセスできる型を検索します。ほとんどのアプリケーションは、https://schemas.microsoft.com/winfx/2006/xaml/presentation 名前空間に対応付けられた既定の XML を持ちます。そのため、プレフィックスは通常、カスタム型や、名前空間の外部の型に限って必要です。propertyName は、ownerType に存在するプロパティの名前に解決される必要があります。この構文は、通常、次のいずれかの場合に使用されます。

  • 指定されたターゲット型を持たないスタイルまたはテンプレート内の XAML でパスが指定されている場合。通常、これ以外のケースでの修飾子の使用は無効です。スタイルやテンプレート以外のケースでは、プロパティは型ではなくインスタンス上に存在します。

  • プロパティが添付プロパティの場合。

  • 静的プロパティにバインドしている場合。この場合、ownerType は実際に型です。

ストーリーボード ターゲットとして使用する場合、propertyName として指定されるプロパティは、DependencyProperty にする必要があります。

ソースの走査 (コレクションの階層のバインディング)

<object Path="propertyName/propertyNameX" .../>

この構文内の / を使用して階層的なデータ ソース オブジェクト内を移動し、後続する / 文字で階層への複数ステップがサポートされます。ソースの走査は現在のレコード ポインタ位置に対応しており、これはデータをビューの UI と同期することによって決定されます。階層的なデータ ソース オブジェクトのバインディング、およびデータ バインディングにおける現在のレコード ポインタの概念の詳細については、「方法 : 階層データでマスタ詳細パターンを使用する」または「データ バインディングの概要」を参照してください。

メモ :

この構文は、一見すると XPath に似ています。XML データ ソースにバインドするための実際の XPath 式は Path 値としては使用されず、代わりに、同時には指定できない XPath プロパティで使用される必要があります。

複数のインデクサ

<object Path="[index1,index2...]" .../>
or
<object Path="propertyName[index,index2...]" .../>

あるオブジェクトが複数のインデクサをサポートする場合、そのインデクサは、配列参照構文のように、順番に指定できます。当該のオブジェクトは、現在のコンテキスト、または複数のインデクサ オブジェクトが含まれるプロパティの値です。

既定では、インデクサ値は、基になるオブジェクトの特性を使用して型指定されます。必要に応じて、インデックスの型を指定できます。インデクサの型指定の詳細については、「Binding.Path」を参照してください。

構文の混合

上記の各構文は、混在させることができます。たとえば、SolidColorBrush オブジェクトのピクセル グリッド配列が含まれる、ColorGrid プロパティの特定の x、y にある色へのプロパティ パスを作成する例を次に示します。

<Rectangle Fill="{Binding ColorGrid[20,30].SolidColorBrushResult}" .../>

アニメーション ターゲットの PropertyPath

アニメーションのターゲット プロパティは依存関係プロパティであり、Freezable またはプリミティブ型を使用します。ただし、型のターゲット プロパティと最終的なアニメーション プロパティは異なるオブジェクト上に存在できます。アニメーションの場合は、プロパティ パスを使用して、プロパティ値内のオブジェクトとプロパティのリレーションシップを調べることによって、名前付きのアニメーション ターゲット オブジェクトのプロパティと目的のターゲット アニメーション プロパティの間の接続が定義されます。

アニメーションに関するオブジェクトとプロパティの一般的な注意事項

一般的なアニメーションの概念の詳細については、「ストーリーボードの概要」および「アニメーションの概要」を参照してください。

アニメーション化される値型またはプロパティは、Freezable 型またはプリミティブである必要があります。パスを開始するプロパティは、指定された TargetName 型に存在する依存関係プロパティの名前に解決される必要があります。

既にフリーズしている Freezable のアニメーションの複製をサポートするには、TargetName が、FrameworkElement または FrameworkContentElement 派生クラスである必要があります。

ターゲット オブジェクト上の単一プロパティ

<animation Storyboard.TargetProperty="propertyName" .../>

propertyName は、指定された TargetName 型に存在する依存関係プロパティの名前に解決される必要があります。

間接的なプロパティの対象化

<animation Storyboard.TargetProperty="propertyName.propertyName2" .../>

propertyName は、指定された TargetName 型に存在する、Freezable 値型またはプリミティブのプロパティである必要があります。

propertyName2 は、propertyName の値であるオブジェクトに存在する依存関係プロパティの名前に解決される必要があります。言い換えると、propertyName2 は、propertyName PropertyType 型の依存関係プロパティとして存在する必要があります。

適用されるスタイルとテンプレートにより、アニメーションの間接的な対象化が必要です。アニメーションを対象にするには、ターゲット オブジェクトの TargetName が必要であり、その名前は x:Name または Name によって設定されます。テンプレート要素とスタイル要素にも名前を設定できますが、その名前は、スタイルとテンプレートの名前スコープ内でのみ有効です (テンプレートとスタイルがアプリケーション マークアップと名前スコープを共有していない場合、名前は一意ではありません。スタイルとテンプレートはインスタンス間で完全に共有されており、重複する名前が永続化されます)。このため、アニメーション化する要素の個々のプロパティがスタイルやテンプレートに基づく場合は、スタイル テンプレートに基づかない、名前付きの要素インスタンスで操作を開始し、スタイルまたはテンプレートのビジュアル ツリーに対象を移動し、アニメーション化する目的のプロパティにアクセスします。

たとえば、Panel の Background プロパティは、テーマ テンプレートに基づく完全な Brush (実際には SolidColorBrush) です。Brush を完全にアニメーション化するには、BrushAnimation (多くの場合、Brush 型ごとに 1 つ) であることが必要ですが、このような型はありません。Brush をアニメーション化するには、代わりに、特定の Brush 型のプロパティをアニメーション化します。SolidColorBrush からその Color までを取得して、ColorAnimation を適用します。この例のプロパティ パスは Background.Color です。

添付プロパティ

<animation Storyboard.TargetProperty="(ownerType.propertyName)" .../>

かっこは、PropertyPath 内のこのプロパティを、部分修飾を使用して構築する必要があることを示します。XML 名前空間を使用して型を検出できます。ownerType は、各アセンブリ内の XmlnsDefinitionAttribute 宣言を通じて、XAML プロセッサがアクセスできる型を検索します。ほとんどのアプリケーションは、https://schemas.microsoft.com/winfx/2006/xaml/presentation 名前空間に対応付けられた既定の XML を持ちます。そのため、プレフィックスは通常、カスタム型や、名前空間の外部の型に限って必要です。propertyName は、ownerType に存在するプロパティの名前に解決される必要があります。propertyName として指定されるプロパティは、DependencyProperty にする必要があります (すべての WPF 添付プロパティは、依存関係プロパティとして実装されます。そのため、この問題は、カスタム添付プロパティにのみ関係します)。

インデクサ

<animation Storyboard.TargetProperty="propertyName.propertyName2[index].propertyName3" .../>

ほとんどの依存関係プロパティまたは Freezable 型は、インデクサをサポートしていません。そのため、アニメーション パス内でインデクサを使用するのは、名前付きターゲット上でチェーンを開始するプロパティと、最終的にアニメーション化されるプロパティの間の中間位置に限られます。提供される構文の中で、これは propertyName2 です。たとえば、RenderTransform.Children[1].Angle などのプロパティ パス内で、中間プロパティが TransformGroup などのコレクションの場合は、インデクサの使用が必要になることがあります。

コード内の PropertyPath

PropertyPath を構築する方法を含めて、PropertyPath をコードで使用する方法については、PropertyPath の参照トピックを参照してください。

一般に、PropertyPath は、バインディングでの使用と単純なアニメーションでの使用を目的とするコンストラクタ、および複雑なアニメーションでの使用を目的とするコンストラクタの、2 種類のコンストラクタを使用するように設計されています。オブジェクトが文字列であるバインディング使用の場合は、PropertyPath(Object) シグネチャを使用します。オブジェクトが DependencyProperty である 1 ステップのアニメーション パスの場合は、PropertyPath(Object) シグネチャを使用します。複雑なアニメーションの場合は、PropertyPath(String, array<Object[]) シグネチャを使用します。後者のコンストラクタでは、先頭のパラメータ用のトークン文字列と、トークン文字列内の位置に設定されるオブジェクトの配列を使用して、プロパティ パスのリレーションシップを定義します。

参照

概念

データ バインディングの概要

ストーリーボードの概要

参照

PropertyPath