{Binding} マークアップ拡張

[アーティクル]
07/13/2023

注意

Windows 10 では、パフォーマンスと開発者の生産性向上のために最適化された新しいバインドメカニズムを利用できます。「{x:Bind} マークアップ拡張」をご覧ください。

注意

{Binding} によりアプリでデータバインディングを使う方法に関する一般的な情報 (および {x:Bind} と {Binding} の全体的な比較) については、「データバインディングの詳細」をご覧ください。

{Binding} マークアップ拡張は、コントロールのプロパティをコードなどのデータソースの値にデータバインドするために使われます。 {Binding} マークアップ拡張は、XAML の読み込み時に Binding クラスのインスタンスに変換されます。このバインドオブジェクトは、データソースのプロパティから値を取得し、その値をコントロールのプロパティにプッシュします。必要な場合、バインディングオブジェクトは、データソースプロパティの値の変化を監視し、その変化に基づいて自分自身を更新するように構成できます。また、そのコントロールの値の変化をソースプロパティにプッシュするように構成することもできます。データバインディングのターゲットとなるプロパティは、依存関係プロパティである必要があります。詳しくは、「依存関係プロパティの概要」をご覧ください。

{Binding} には、ローカル値と同じ依存関係プロパティの優先順位があります。命令型コードにローカル値を設定すると、マークアップに設定されたすべての {Binding} の影響がなくなります。

XAML 属性の使用方法

<object property="{Binding}" .../>
-or-
<object property="{Binding propertyPath}" .../>
-or-
<object property="{Binding bindingProperties}" .../>
-or-
<object property="{Binding propertyPath, bindingProperties}" .../>

項目	説明
propertyPath	バインドのプロパティパスを指定する文字列。詳しくは、以下の「プロパティパス」をご覧ください。
bindingProperties	propName=value[, propName=value]* 名前と値のペアの構文を使って指定する、1 つ以上のバインドプロパティ。
propName	Binding オブジェクトで設定するプロパティの文字列名。たとえば、"Converter" です。
value	プロパティに設定する値。引数の構文は、下記の「{Binding} で設定できる Binding クラスのプロパティ」セクションで示しているプロパティによって異なります。

[プロパティのパス]

Path は、バインド先のプロパティ (ソースプロパティ) を表します。 Path は位置パラメーターであるため、パラメーター名を明示的に使用する ({Binding Path=EmployeeID}) ことも、最初の無名パラメーターとして指定する ({Binding EmployeeID}) こともできます。

Path の型はプロパティパスであり、この文字列は、カスタム型または framework 型のプロパティまたはサブプロパティに評価されます。型は DependencyObject にすることができますが、そうしなければならないわけではありません。プロパティパスのステップは、ドット (.) で区切ります。複数の区切り記号を指定することで、連続するサブプロパティを走査できます。バインドされているオブジェクトを実装するために使用するプログラミング言語に関係なく、ドット区切り記号を使います。

たとえば、UI を従業員オブジェクトの名プロパティにバインドする場合、プロパティパスは "Employee.FirstName" のようになります。従業員の扶養家族を含むプロパティに項目コントロールをバインドする場合、プロパティパスは "Employee.Dependents" となり、"Dependents" の項目の表示には項目コントロールの項目テンプレートが使われます。

データソースがコレクションである場合、プロパティパスには、位置またはインデックスによりコレクション内の項目を指定できます。たとえば "Teams[0].Players" の場合、"0" をリテラル "[]" で囲むことで、コレクション内の最初の項目が指定されます。

既にある DependencyObject への ElementName バインドを使う場合は、プロパティパスの一部として添付プロパティを使うことができます。添付プロパティの名前に含まれるドットがプロパティパスへのステップとは見なされないように、添付プロパティを明確に示すには、所有者で修飾された添付プロパティの名前を、(AutomationProperties.Name) のようにかっこで囲みます。

プロパティパスの中間オブジェクトは、実行時の形式で PropertyPath オブジェクトとして格納されますが、ほとんどのシナリオでは、コードで PropertyPath オブジェクトを操作する必要はありません。通常、XAML を使って必要なバインド情報を指定できます。

プロパティパスの文字列の構文、アニメーション機能領域のプロパティパス、PropertyPath オブジェクトの作成について詳しくは、「プロパティパス構文」をご覧ください。

{Binding} で設定できる Binding クラスのプロパティ

{Binding} は、bindingProperties プレースホルダー構文で示されます。これは、マークアップ拡張で設定可能な Binding の読み取り/書き込みプロパティが複数あるためです。プロパティは、propName=value ペアをコンマで区切ることにより、任意の順序で設定できます。プロパティによっては、型変換をサポートしていない型が必要なものがあります。そのため、これらのプロパティでは、{Binding} 内で入れ子にされた独自のマークアップ拡張が必要です。

プロパティ	説明
パス	上記の「プロパティパス」をご覧ください。
Converter	バインドエンジンによって呼び出されるコンバーターオブジェクトを指定します。コンバーターは、{StaticResource} マークアップ拡張を使ってリソースディクショナリのそのオブジェクトを参照するマークアップで設定できます。
ConverterLanguage	コンバーターで使うカルチャを指定します (Converter を設定する場合)。カルチャは、標準ベースの識別子として設定できます。詳しくは、「ConverterLanguage」をご覧ください。
ConverterParameter	コンバーターロジックで使うことができるコンバーターパラメーターを指定します (Converter を設定する場合)。ほとんどのコンバーターは、渡された値から変換に必要なすべての情報を取得するという単純なロジックを使っており、ConverterParameter 値を必要としません。 ConverterParameter パラメーターは、ConverterParameter で渡された値を利用する条件付きロジックを持つ、より複雑なコンバーターを実装するために存在します。また、文字列以外の値を使うコンバーターも作成できますが、一般的ではありません。詳しくは、「ConverterParameter」の「注釈」をご覧ください。
ElementName	Name プロパティまたは x:Name 属性がある別の要素を同じ XAML コンストラクトで参照して、データソースを指定します。通常は、関連する値を共有するか、1 つの UI 要素のサブプロパティを使って別の要素の特定の値を指定するために使われます (XAML コントロールテンプレートなどで)。
FallbackValue	ソースまたはパスを解決できない場合に表示する値を指定します。
モード	バインドモードを、"OneTime"、"OneWay"、"TwoWay" のいずれかの値で指定します。これらは、BindingMode 列挙体の定数名に対応します。既定は "OneWay" です。これは、{x:Bind} の既定値 (OneTime) とは異なる点に注意してください。
RelativeSource	バインディングターゲットの位置に対するバインドソースの位置を記述することで、データソースを指定します。これは、XAML コントロールテンプレート内のバインドで最もよく使われます。 {RelativeSource} マークアップ拡張を設定します。
ソース	オブジェクトのデータソースを指定します。 Binding マークアップ拡張では、Source プロパティに {StaticResource} マークアップ拡張参照などのオブジェクト参照を指定する必要があります。このプロパティを指定しない場合、実行中のデータコンテキストによりソースが指定されます。個々のバインドで Source 値を指定する代わりに、複数のバインドで共有 DataContext を利用する方が一般的です。詳しくは、「DataContext」または「データバインディングの詳細」を参照してください。
TargetNullValue	ソース値が解決されるが、明示的に null である場合に表示する値を設定します。
UpdateSourceTrigger	バインドソースの更新のタイミングを指定します。指定されていない場合は、既定値は Default です。

注: マークアップを {x:Bind} から {Binding} に変換する場合は、Mode プロパティの既定値の違いに注意してください。

Converter、ConverterLanguage、ConverterLanguage はいずれも、バインドソースの値または型を、バインディングターゲットのプロパティと互換性のある型または値に変換するシナリオに関係があります。例や詳しい情報については、「データバインディングの詳細」の「データの変換」をご覧ください。

注意

Windows 10、バージョン1607 以降では、XAML フレームワークにブール値と Visibility 値のコンバーターが組み込まれています。コンバーターは、Visible 列挙値に対して true を、Collapsed に対して false をマッピングします。これにより、コンバーターを作成せずに Visibility プロパティをブール値にバインドできます。組み込みのコンバーターを使用するには、アプリの最小のターゲット SDK バージョンが 14393 以降である必要があります。アプリがそれよりも前のバージョンの Windows 10 をターゲットとしている場合は使うことができません。ターゲットバージョンについて詳しくは、「バージョンアダプティブコード」をご覧ください。

Source、RelativeSource、ElementName では、バインドソースを指定します。そのため、これらは相互に排他的です。

ヒント:Path や ConverterParameter のように、値に 1 つの中かっこを指定する必要がある場合は、\{ のように円記号 (バックスラッシュ) を中かっこの前に付けます。別の方法として、エスケープする必要がある中かっこを含む文字列全体を ConverterParameter='{Mix}' のように別の種類の引用符で囲みます。

例

<!-- binding a UI element to a view model -->    
<Page ... >
    <Page.DataContext>
        <local:BookstoreViewModel/>
    </Page.DataContext>

    <GridView ItemsSource="{Binding BookSkus}" SelectedItem="{Binding SelectedBookSku, Mode=TwoWay}" ... />
</Page>

<!-- binding a UI element to another UI element -->
<Page ... >
    <Page.Resources>
        <local:S2Formatter x:Key="GradeConverter"/>
    </Page.Resources>

    <Slider x:Name="sliderValueConverter" ... />
    <TextBox Text="{Binding Path=Value, ElementName=sliderValueConverter,
        Mode=OneWay,
        Converter={StaticResource GradeConverter}}"/>
</Page>

2 番目の例では、ElementName、Path、Mode、Converter の 4 種類の Binding プロパティを設定します。 Path はここで、Binding プロパティであることが明示的に示された状態で表示されています。 Path は、データバインドソースに評価されます。このデータバインドソースは、同じランタイムオブジェクトツリーにある別のオブジェクト、具体的には sliderValueConverter という名前の Slider です。

Converter プロパティの値が別のマークアップ拡張 {StaticResource} マークアップ拡張を使っていることに注意してください。つまり、ここでは入れ子になったマークアップ拡張が 2 つ使われています。内側のものが最初に評価されます。このため、リソースが取得されると、バインドに使える実用的な IValueConverter (リソースの local:S2Formatter 要素によってインスタンス化されるカスタムクラス) が存在することになります。

ツールのサポート

Microsoft Visual Studio の Microsoft IntelliSense では、XAML マークアップエディターで {Binding} を作成している間、データコンテキストのプロパティが表示されます。「{Binding」と入力するとすぐに、Path に適したデータコンテキストプロパティがドロップダウンに表示されます。 IntelliSense は、Binding の他のプロパティに関しても役立ちます。これが機能するためには、マークアップページにデータコンテキストまたは設計時のデータコンテキストを設定する必要があります。 [定義へ移動] (F12) は、{Binding} でも機能します。または、データバインディングのダイアログを使うこともできます。