データバインディング（WPF）

2007/06/16 (Last updated:2007/07/08)

概要

「WPF」には、データバインディング（data bining）機能があります。（WPF に限らず、最近の GUI 開発フレームワークにはたいていこの機能がありますが。）データバインディングは、単にバインディングとか、和訳してデータ結合とか言ったりする場合もあります。

データバインディングとは

データバインディングというのは、例えば、あるコントロールのプロパティとプロパティを結びつけたり、データベースなどに格納されたデータとリストコントロールを結びつけたりする機構です。

「結びつける」というのは、具体的に言うと、あるコントロール、例えばテキストボックスの中身が変更されたときに、その中身と同期して、他のコントロールの中身を変更したりということです。

例えば、図1および2を見てください。

これの詳細については後々改めて説明しますが、ポイントとしては、スライダーを動かすと、それと連動して、テキストボックスの中身が変化したり、キャンバスが回転したりします。

また、図3のように、同じデータを異なる複数の方法で表示するいうことも考えられます。

さて、このような仕組みを、もし WPF の提供するバインディング機構を使わずに実装しようと思うと、例えば以下のような手順を踏む必要があります。

スライダーコントロールの ValueChanged イベントを拾う
ValueChanged イベントハンドラ中でテキストボックスの中身やキャンバスの回転角を設定する。
もし必要なら、テキストボックスの TextChanged イベントの方でも同様の処理を行う。

この例の場合、ただ1つの値を3つのコントロールで共有するだけなので、このような手順を踏むのもたいした労力ではないですが、同期が必要なコントロールの数が増えてきたり、データ数が多くなってくると、とてもじゃないですが、自前で処理を書きたくはありません。

また、ユーザインターフェース（ビジュアル（視覚・表示）デザイン）とビジネスロジック（ロジック（処理内容）デザイン）の分離の観点から言っても、イベントハンドラ処理を自前で書く必要のないバインディング機構が望まれます。

Binding マークアップ拡張

WPF では、Binding クラスまたは Binding 「マークアップ拡張」を使ってデータバインディングを行います。

例えば、「Attribute Syntax」と Binding 「マークアップ拡張」を使って、以下のように書きます。

<StackPanel
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">

  <Slider Name="slider1" Width="200"/>
  <TextBox Width="80"
    Text="{Binding ElementName=slider1, Path=Value}"/>
</StackPanel>

あるいは、「Property Element Syntax」と Binding クラスを使うなら、以下のような感じ。

<StackPanel
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">

  <Slider Name="slider1" Width="200"/>
  <TextBox Width="80">
    <Binding ElementName="slider1" Path="Value"/>
  </TextBox>
</StackPanel>

これで、スライダーの値とテキストボックス中のテキストが結び付けられます。スライダーを動かすとテキストボックスの中身が変化しますし、その逆もまたしかりです。

（ちなみに、Binding マークアップ拡張の設定次第では、片方向の同期も可能。）

イベントハンドラなどを自前で書く必要はなく、これで全てです。（試しに表示させて見たいならこちら →

BindingSlider.xaml 。） XAML だけで完結したデータバインディング記述が可能です。

また、 ASP.NET のように、 <%# Eval("source") %> というような特殊な記法も必要ないですし、データの同期をしたいタイミングでプログラマが明示的に DataBind() メソッド呼び出す必要もありません。

WPF のデータバインディングでは、データが変更されたことを、そのデータを参照する全てのコントロールに通知する仕組みを持っています。（ただし、この仕組みを活用するためには、同期したいデータのクラスに System.ComponentModel.INotifyPropertyChanged インターフェースを実装する必要があります。）

単純データバインディング

Binding だけで、いろんなタイプのデータバインディングが実現できます。まずは、一番簡単なものということで、単純なデータのバインディングについて説明します。

要するに、前節の例でも挙げたコントロールのプロパティ間のデータ同期のように、 1つのデータを複数のコントロールで同期するものです。前節と似たようなものですが、再び例を挙げてみましょう。

<StackPanel
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">

  <TextBox Name="textBox" FontSize="18pt"
    Text="テキストを入力してください"/>

  <TextBlock FontSize="18pt">
    <TextBlock.Text>
      <Binding ElementName="textBox" Path="Text" />
    </TextBlock.Text>
  </TextBlock>

</StackPanel>

この XAML コードによって、テキストボックスとテキストブロックの中身が同期します。すなわち、テキストボックス内のテキストが変更されたときに、変更結果がテキストブロックの中身に反映されるようになります。

この例のように、コントロール間の同期に Binding を使う場合、 Binding の ElementName プロパティに同期対象のコントロールの Name を、 Path プロパティに同期したいプロパティの名前を指定します。

データの変換・確認

「Binding マークアップ拡張」で例に挙げた、スライダーコントロールの値とテキストボックスの中身を結びつけるコードをもう1歩捻って、スライダーコントロールの値に応じてキャンバスを回転させるような物を作ってみましょう。

完成品は、図1、図2に示すようなものになります。完成品のソース一式はこちら → BindingDependencyProperty.zip。

以下に示す XAML ファイルでは、簡単化のために、キャンバスの中身ははしょってあります。

<Window x:Class="BindingDependencyProperty.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Title="Binding デモ" Height="300" Width="300"
  >

  <WrapPanel>
    <Slider Name="slider1" Width="200"/>

    <TextBox Width="80"
      Text="{Binding ElementName=slider1, Path=Value}"/>

    <Canvas Width="200" Height="200">
      <Canvas.RenderTransform>
        <RotateTransform CenterX="100" CenterY="100"
          Angle="{Binding ElementName=slider1, Path=Value}"/>
      </Canvas.RenderTransform>

      <Label Canvas.Left="84" Canvas.Top="75" FontSize="20">↑</Label>

    </Canvas>
  </WrapPanel>
</Window>

値の変換

これで、スライダーの位置に応じてキャンバスが回転するんですが、 1つ問題があります。 Slider の Value プロパティの値の範囲は 0～10 なので、最大で10度ほどしかキャンバスが回転しません。（WPF では、回転などの角度のスケールは1周360度。）

これを例えば、スライダーの端から端でちょうど1周するようにしたければ、 0～10 の範囲を 0～360 に変換する仕組みが必要になります。

この手の変換を実現するのが、Binding.Converter プロパティ（System.Windows.Data.IValueConverter 型）です。まず、IValueConverter を実装する変換クラスを作ります。

using System.Windows.Data;

namespace BindingDependencyProperty
{
  /// <summary>
  /// スライダーコントロールの Value （0～10）を角度（0 ～ 360）に変換。
  /// </summary>
  [ValueConversion(typeof(double), typeof(string))]
  public class SliderAngleConverter : IValueConverter
  {
    const double FACTOR = 360.0 / 10.0;

    public object Convert(object value, System.Type targetType,
      object parameter, System.Globalization.CultureInfo culture)
    {
      double v = (double)value;
      return v * FACTOR;
    }

    public object ConvertBack(object value, System.Type targetType,
      object parameter, System.Globalization.CultureInfo culture)
    {
      string s = (string)value;
      double v;
      if (!double.TryParse(s, out v))
        return 0;
      return v / FACTOR;
    }
  }
}

で、XAML 側では、以下のようにして Binding に Converter を設定します。

<Window x:Class="BindingDependencyProperty.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:c="clr-namespace:BindingDependencyProperty"
  Title="Binding デモ" Height="300" Width="300"
  >
  <Window.Resources>
    <c:SliderAngleConverter x:Key="dateConverter"/>
  </Window.Resources>

  <WrapPanel>
    <Slider Name="slider1" Width="200"/>

    <TextBox Width="80"
      Text="{Binding ElementName=slider1, Path=Value,
        Converter={StaticResource dateConverter}}"/>

    <Canvas Width="200" Height="200">
      <Canvas.RenderTransform>
        <RotateTransform CenterX="100" CenterY="100"
          Angle="{Binding ElementName=slider1, Path=Value,
            Converter={StaticResource dateConverter}}"/>
      </Canvas.RenderTransform>

      <Label Canvas.Left="84" Canvas.Top="75" FontSize="20">↑</Label>

    </Canvas>
  </WrapPanel>
</Window>

値の有効性の確認

もう1点、テキストボックスには数値以外の文字列を入力することもできます。上述の Conveter では、無効な文字列が入力された場合には 0 に変換していますが、無効な文字列の確認やエラーの表示などを行いたい場合もあります。

WPF の Binding では、値の有効性の確認機能もあります。値の確認には、Binding.ValidationRules プロパティ（System.Windows.Controls.ValidationRule 型のコレクション）を使います。

まず、ValidationRule を継承する確認用のクラスを作ります。不正な入力があった場合には、ValidationResult のコンストラクタの第一引数を false に設定します。

using System.Windows.Controls;

namespace BindingDependencyProperty
{
  public class AngleRangeRule : ValidationRule
  {
    public override ValidationResult Validate(object value,
      System.Globalization.CultureInfo cultureInfo)
    {
      double result;

      if (!double.TryParse(value as string, out result))
        return new ValidationResult(false, "文字列が不正です");

      if (result < 0 || result > 360)
        return new ValidationResult(false, "値の範囲が不正です");

      return new ValidationResult(true, null);
    }
  }
}

XAML 側では、以下のようにして Binding に ValidationRules を設定します。

<Window x:Class="BindingDependencyProperty.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:c="clr-namespace:BindingDependencyProperty"
  Title="Binding デモ" Height="300" Width="300"
  >
  <Window.Resources>
    <c:SliderAngleConverter x:Key="dateConverter"/>
    <c:AngleRangeRule x:Key="angleRule"/>
  </Window.Resources>

  <WrapPanel>
    <Slider Name="slider1" Width="200"/>

    <TextBox Width="80">
      <Binding ElementName="slider1" Path="Value"
               Converter="{StaticResource dateConverter}">
        <Binding.ValidationRules>
          <c:AngleRangeRule />
        </Binding.ValidationRules>
      </Binding>
    </TextBox>

    <Canvas Width="200" Height="200">
      <Canvas.RenderTransform>
        <RotateTransform CenterX="100" CenterY="100"
          Angle="{Binding ElementName=slider1, Path=Value,
            Converter={StaticResource dateConverter}}"/>
      </Canvas.RenderTransform>

      <Label Canvas.Left="84" Canvas.Top="75" FontSize="20">↑</Label>

    </Canvas>
  </WrapPanel>
</Window>

これで値の有効性の確認が行われるようになります。デフォルトの動作では、無効な入力があった場合、テキストボックスの淵が赤くなります。

無効な入力があった場合の動作を変更したい場合、テキストボックスに Validation.ErrorTemplate 依存プロパティ（ControlTemplate 型）を設定します。（コントロールテンプレートに関しては、「テンプレート（WPF）」で説明。）

<Window x:Class="BindingDependencyProperty.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:c="clr-namespace:BindingDependencyProperty"
  Title="Binding デモ" Height="300" Width="300"
  >
  <Window.Resources>
    <c:SliderAngleConverter x:Key="dateConverter"/>
    <c:AngleRangeRule x:Key="angleRule"/>
  </Window.Resources>

  <WrapPanel>
    <Slider Name="slider1" Width="200"/>

    <TextBox Width="80">
      <Binding ElementName="slider1" Path="Value"
               Converter="{StaticResource dateConverter}">
        <Binding.ValidationRules>
          <c:AngleRangeRule />
        </Binding.ValidationRules>
      </Binding>
      <Validation.ErrorTemplate>
        <ControlTemplate>
          <Border BorderBrush="#ffff00" BorderThickness="3">
            <AdornedElementPlaceholder/>
          </Border>
        </ControlTemplate>
      </Validation.ErrorTemplate>
    </TextBox>

    <Canvas Width="200" Height="200">
      <Canvas.RenderTransform>
        <RotateTransform CenterX="100" CenterY="100"
          Angle="{Binding ElementName=slider1, Path=Value,
            Converter={StaticResource dateConverter}}"/>
      </Canvas.RenderTransform>

      <Label Canvas.Left="84" Canvas.Top="75" FontSize="20">↑</Label>

    </Canvas>
  </WrapPanel>
</Window>

もしくは、Validation.HasError プロパティをトリガーにしたり、 Validation.Error イベントを拾ってイベント処理する方法もあります。

FrameworkElement クラスの DataContext プロパティ

<Page
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  >

  <Page.Resources>
    <XmlDataProvider x:Key=" LagoonCompany">
      <x:XData>
        <Members xmlns="">
          <Member>Duch</Member> 
          <Member>Benny</Member> 
          <Member>Levy</Member> 
          <Member>Rock</Member> 
        </Members>
      </x:XData>
    </XmlDataProvider>
  </Page.Resources>

  <ListBox Width="200" Height="300" 
           ItemsSource="{Binding Source={StaticResource LagoonCompany}, 
           XPath=/Members/Member}">
  </ListBox>

</Page>

ListBox が XML 中のデータを表示する機能を持っているので、 Binding マークアップ拡張を使って ItemsSource と XML を同期させています。

ADO.NET

ADO.NET のデータをバインディング

コード中でのデータバインディング設定

コードビハインド中でのバインディング設定

Binding myNewBindDef = new Binding("TheDate");

myNewBindDef.Mode = BindingMode.OneWay;
myNewBindDef.Source = myChangedData;
myNewBindDef.Converter = TheConverter;
myNewBindDef.ConverterCulture = new CultureInfo("en-US");

// myDatetext is a TextBlock object that is the binding target object
BindingOperations.SetBinding(myDateText,
  TextBlock.TextProperty, myNewBindDef);

BindingOperations.SetBinding(myDateText,
  TextBlock.ForegroundProperty, myNewBindDef);

サンプル

図1, 2のソース

図3のソース

class Item
{
  public double X { get; set; }
  public double Y { get; set; }
  public double Value { get; set; }
}

ObservableCollection<Item> Data;

一覧表示、バブルチャート

更新履歴

2023/10/24

コレクション式

[C#]

2023/09/20

[雑記] InlineArray

[C#]

2023/07/29

更新：ローカル関数と匿名関数

[C#]

2023/06/21

C# 12.0 の新機能

[C#]

2023/04/15

[雑記] 明確な代入ルール

[C#]

ブログ

2024/04/04

データバインディング（WPF）

目次

概要

データバインディングとは

Binding マークアップ拡張

単純データバインディング

データの変換・確認

値の変換

値の有効性の確認

予定

双方向データバインディングと変更の通知

複合データバインディング

CollectionViewSource

Object

XML

ADO.NET

コード中でのデータバインディング設定

サンプル

更新履歴

コレクション式

[雑記] InlineArray

更新：ローカル関数と匿名関数

C# 12.0 の新機能

[雑記] 明確な代入ルール

ブログ

ref/ref struct 変数を非同期メソッド中で使えるように

Lock クラス

Extensions (拡張型)

C# 13 でのコレクション式 - ディクショナリ式

C# 13 でのコレクション式 - 制限の緩和の話