方法: DataGrid コントロールを使用して検証を実装する

DataGrid コントロールでは、セル レベルと行レベルの両方で検証を実行できます。 セル レベルの検証では、ユーザーが値を更新したときに、バインドされたデータ オブジェクトの個々のプロパティを検証します。 行レベルの検証では、ユーザーが行に対する変更をコミットしたときに、データ オブジェクト全体を検証します。 検証エラーに対してカスタマイズした視覚的フィードバックを提供したり、DataGrid コントロールで提供される既定の視覚的フィードバックを使用したりすることもできます。

以下の手順では、検証規則を DataGrid バインディングに適用し、視覚的フィードバックをカスタマイズする方法について説明します。

個別のセル値を検証するには

• 列で使用されるバインディングに対して 1 つ以上の検証規則を指定します。 これは、「データ バインディングの概要」に説明されている単純なコントロールのデータの検証に似ています。

  次の例では、ビジネス オブジェクトの別々のプロパティにバインドされた 4 つの列がある DataGrid コントロールを示します。 そのうちの 3 つの列では、ValidatesOnExceptions プロパティを true に設定して、ExceptionValidationRule を指定しています。

  <Grid>
  
    <Grid.Resources>
      <local:Courses x:Key="courses"/>
    </Grid.Resources>
  
    <DataGrid Name="dataGrid1" FontSize="20"
      ItemsSource="{StaticResource courses}" 
      AutoGenerateColumns="False">
      <DataGrid.Columns>
        <DataGridTextColumn Header="Course Name" 
          Binding="{Binding Name, TargetNullValue=(enter a course name)}"/>
        <DataGridTextColumn Header="Course ID"
          Binding="{Binding Id, ValidatesOnExceptions=True}"/>
        <DataGridTextColumn Header="Start Date"
          Binding="{Binding StartDate, ValidatesOnExceptions=True, 
            StringFormat=d}"/>
        <DataGridTextColumn Header="End Date"
          Binding="{Binding EndDate, ValidatesOnExceptions=True,
            StringFormat=d}"/>
      </DataGrid.Columns>
    </DataGrid>
  
  </Grid>
  

  ユーザーが無効な値 (Course ID 列の整数以外など) を入力すると、赤い枠線がセルの周囲に表示されます。 この既定の検証フィードバックは、次の手順に従って変更できます。

セルの検証フィードバックをカスタマイズするには

• 列の EditingElementStyle プロパティを、列の編集コントロールに適したスタイルに設定します。 編集コントロールは実行時に作成されるため、単純なコントロールのように Validation.ErrorTemplate 添付プロパティを使用することはできません。

  次の例では、前の例を更新して、検証規則のある 3 つの列で共有されるエラー スタイルを追加します。 ユーザーが無効な値を入力すると、スタイルによってセルの背景色が変更され、ツールヒントが追加されます。 トリガーを使用して検証エラーがあるかどうかを確認していることに注意してください。 現在はセル用のエラー テンプレートがないため、この処理が必要です。

  <DataGrid.Resources>
    <Style x:Key="errorStyle" TargetType="{x:Type TextBox}">
      <Setter Property="Padding" Value="-2"/>
      <Style.Triggers>
        <Trigger Property="Validation.HasError" Value="True">
          <Setter Property="Background" Value="Red"/>
          <Setter Property="ToolTip" 
            Value="{Binding RelativeSource={RelativeSource Self},
              Path=(Validation.Errors)[0].ErrorContent}"/>
        </Trigger>
      </Style.Triggers>
    </Style>
  </DataGrid.Resources>
  
  <DataGrid.Columns>
    <DataGridTextColumn Header="Course Name" 
      Binding="{Binding Name, TargetNullValue=(enter a course name)}"/>
    <DataGridTextColumn Header="Course ID"
      EditingElementStyle="{StaticResource errorStyle}"
      Binding="{Binding Id, ValidatesOnExceptions=True}"/>
    <DataGridTextColumn Header="Start Date"
      EditingElementStyle="{StaticResource errorStyle}"
      Binding="{Binding StartDate, ValidatesOnExceptions=True, 
        StringFormat=d}"/>
    <DataGridTextColumn Header="End Date"
      EditingElementStyle="{StaticResource errorStyle}"
      Binding="{Binding EndDate, ValidatesOnExceptions=True,
        StringFormat=d}"/>
  </DataGrid.Columns>
  

  列で使用される CellStyle を置き換えると、より広範囲なカスタマイズを実装できます。

単一行の複数の値を検証するには

1. バインドされたデータ オブジェクトの複数のプロパティをチェックする ValidationRule サブクラスを実装します。 Validate メソッドの実装で、value パラメーターの値を BindingGroup インスタンスにキャストします。 その後、Items プロパティを使用してデータ オブジェクトにアクセスできます。

   この処理によって Course オブジェクトの StartDate プロパティ値が EndDate プロパティ値より前かどうかを検証する例を次に示します。

   Public Class CourseValidationRule
       Inherits ValidationRule
   
       Public Overrides Function Validate(ByVal value As Object, _
           ByVal cultureInfo As System.Globalization.CultureInfo) _
           As ValidationResult
   
           Dim course As Course = _
               CType(CType(value, BindingGroup).Items(0), Course)
   
           If course.StartDate > course.EndDate Then
               Return New ValidationResult(False, _
                   "Start Date must be earlier than End Date.")
           Else
               Return ValidationResult.ValidResult
           End If
   
       End Function
   
   End Class
   

   public class CourseValidationRule : ValidationRule
   {
       public override ValidationResult Validate(object value,
           System.Globalization.CultureInfo cultureInfo)
       {
           Course course = (value as BindingGroup).Items[0] as Course;
           if (course.StartDate > course.EndDate)
           {
               return new ValidationResult(false,
                   "Start Date must be earlier than End Date.");
           }
           else
           {
               return ValidationResult.ValidResult;
           }
       }
   }
   

2. DataGrid.RowValidationRules コレクションに検証規則を追加します。 RowValidationRules プロパティは、コントロールで使用されるすべてのバインディングをグループ化する BindingGroup インスタンスの ValidationRules プロパティへの直接アクセスを可能にします。

   XAML に RowValidationRules プロパティを設定する例を次に示します。 ValidationStep プロパティが UpdatedValue に設定されているため、検証はバインドされたデータ オブジェクトの更新後にのみ行われます。

   <DataGrid.RowValidationRules>
     <local:CourseValidationRule ValidationStep="UpdatedValue"/>
   </DataGrid.RowValidationRules>
   

   ユーザーが、開始日より前の終了日を指定すると、赤い感嘆符 (!) が行ヘッダーに表示されます。 この既定の検証フィードバックは、次の手順に従って変更できます。

行の検証フィードバックをカスタマイズするには

• DataGrid.RowValidationErrorTemplate プロパティを設定します。 このプロパティを使用して、個々の DataGrid コントロールの行の検証フィードバックをカスタマイズできます。 暗黙の行スタイルを使用して DataGridRow.ValidationErrorTemplate プロパティを設定することにより、複数のコントロールに影響を与えることもできます。

  より視覚的なインジケーターで既定の行の検証フィードバックを置き換える例を次に示します。 ユーザーが無効な値を入力すると、赤い円で囲まれた白い感嘆符が行ヘッダーに表示されます。 これは、行とセルのどちらの検証エラーでも発生します。 関連付けられているエラー メッセージがツールヒントに表示されます。

  <DataGrid.RowValidationErrorTemplate>
    <ControlTemplate>
      <Grid Margin="0,-2,0,-2"
        ToolTip="{Binding RelativeSource={RelativeSource
        FindAncestor, AncestorType={x:Type DataGridRow}},
        Path=(Validation.Errors)[0].ErrorContent}">
        <Ellipse StrokeThickness="0" Fill="Red" 
          Width="{TemplateBinding FontSize}" 
          Height="{TemplateBinding FontSize}" />
        <TextBlock Text="!" FontSize="{TemplateBinding FontSize}" 
          FontWeight="Bold" Foreground="White" 
          HorizontalAlignment="Center"  />
      </Grid>
    </ControlTemplate>
  </DataGrid.RowValidationErrorTemplate>
  

使用例

次の例では、セルおよび行の検証の詳細なデモンストレーションを示します。 Course クラスは、トランザクションをサポートするために、IEditableObject を実装するサンプル データ オブジェクトを提供します。 DataGrid コントロールは、IEditableObject とやり取りして、ユーザーが Esc キーを押すことで変更を元に戻せるようにします。

メモ
Visual Basic を使用している場合は、MainWindow.xaml の最初の行で、x:Class="DataGridValidation.MainWindow" を x:Class="MainWindow" に置き換えてください。

検証をテストするには、次の操作を試します。

• Course ID 列に、整数以外の値を入力します。

• End Date 列に、Start Date より前の日付を入力します。

• Course ID、Start Date、または End Date の値を削除します。

• 無効なセル値を元に戻すには、カーソルをセルに戻し、Esc キーを押します。

• 現在のセルが編集モードのときに行全体の変更を元に戻すには、Esc キーを 2 回押します。

• 検証エラーが発生した場合は、行ヘッダーのインジケーターの上にマウス ポインターを移動すると、関連するエラー メッセージが表示されます。

Imports System.Collections.ObjectModel
Imports System.ComponentModel

Public Class MainWindow

    Private Sub dataGrid1_InitializingNewItem(ByVal sender As System.Object, _
        ByVal e As System.Windows.Controls.InitializingNewItemEventArgs) _
        Handles dataGrid1.InitializingNewItem

        Dim newCourse As Course = CType(e.NewItem, Course)
        newCourse.StartDate = DateTime.Today
        newCourse.EndDate = DateTime.Today

    End Sub

End Class

Public Class Courses
    Inherits ObservableCollection(Of Course)

    Sub New()
        Me.Add(New Course With { _
            .Name = "Learning WPF", _
            .Id = 1001, _
            .StartDate = New DateTime(2010, 1, 11), _
            .EndDate = New DateTime(2010, 1, 22) _
        })
        Me.Add(New Course With { _
            .Name = "Learning Silverlight", _
            .Id = 1002, _
            .StartDate = New DateTime(2010, 1, 25), _
            .EndDate = New DateTime(2010, 2, 5) _
        })
        Me.Add(New Course With { _
            .Name = "Learning Expression Blend", _
            .Id = 1003, _
            .StartDate = New DateTime(2010, 2, 8), _
            .EndDate = New DateTime(2010, 2, 19) _
        })
        Me.Add(New Course With { _
            .Name = "Learning LINQ", _
            .Id = 1004, _
            .StartDate = New DateTime(2010, 2, 22), _
            .EndDate = New DateTime(2010, 3, 5) _
        })
    End Sub

End Class

Public Class Course
    Implements IEditableObject, INotifyPropertyChanged

    Private _name As String
    Public Property Name As String
        Get
            Return _name
        End Get
        Set(ByVal value As String)
            If _name = value Then Return
            _name = value
            OnPropertyChanged("Name")
        End Set
    End Property

    Private _number As Integer
    Public Property Id As Integer
        Get
            Return _number
        End Get
        Set(ByVal value As Integer)
            If _number = value Then Return
            _number = value
            OnPropertyChanged("Id")
        End Set
    End Property

    Private _startDate As DateTime
    Public Property StartDate As DateTime
        Get
            Return _startDate
        End Get
        Set(ByVal value As DateTime)
            If _startDate = value Then Return
            _startDate = value
            OnPropertyChanged("StartDate")
        End Set
    End Property

    Private _endDate As DateTime
    Public Property EndDate As DateTime
        Get
            Return _endDate
        End Get
        Set(ByVal value As DateTime)
            If _endDate = value Then Return
            _endDate = value
            OnPropertyChanged("EndDate")
        End Set
    End Property

#Region "IEditableObject"

    Private backupCopy As Course
    Private inEdit As Boolean

    Public Sub BeginEdit() Implements IEditableObject.BeginEdit
        If inEdit Then Return
        inEdit = True
        backupCopy = CType(Me.MemberwiseClone(), Course)
    End Sub

    Public Sub CancelEdit() Implements IEditableObject.CancelEdit
        If Not inEdit Then Return
        inEdit = False
        Me.Name = backupCopy.Name
        Me.Id = backupCopy.Id
        Me.StartDate = backupCopy.StartDate
        Me.EndDate = backupCopy.EndDate
    End Sub

    Public Sub EndEdit() Implements IEditableObject.EndEdit
        If Not inEdit Then Return
        inEdit = False
        backupCopy = Nothing
    End Sub

#End Region

#Region "INotifyPropertyChanged"

    Public Event PropertyChanged As PropertyChangedEventHandler _
        Implements INotifyPropertyChanged.PropertyChanged

    Private Sub OnPropertyChanged(ByVal propertyName As String)
        RaiseEvent PropertyChanged(Me, _
           New PropertyChangedEventArgs(propertyName))
    End Sub

#End Region

End Class

Public Class CourseValidationRule
    Inherits ValidationRule

    Public Overrides Function Validate(ByVal value As Object, _
        ByVal cultureInfo As System.Globalization.CultureInfo) _
        As ValidationResult

        Dim course As Course = _
            CType(CType(value, BindingGroup).Items(0), Course)

        If course.StartDate > course.EndDate Then
            Return New ValidationResult(False, _
                "Start Date must be earlier than End Date.")
        Else
            Return ValidationResult.ValidResult
        End If

    End Function

End Class

using System;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;

namespace DataGridValidation
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
            dataGrid1.InitializingNewItem += (sender, e) =>
            {
                Course newCourse = e.NewItem as Course;
                newCourse.StartDate = newCourse.EndDate = DateTime.Today;
            };
        }
    }

    public class Courses : ObservableCollection<Course>
    {
        public Courses()
        {
            this.Add(new Course
            {
                Name = "Learning WPF",
                Id = 1001,
                StartDate = new DateTime(2010, 1, 11),
                EndDate = new DateTime(2010, 1, 22)
            });
            this.Add(new Course
            {
                Name = "Learning Silverlight",
                Id = 1002,
                StartDate = new DateTime(2010, 1, 25),
                EndDate = new DateTime(2010, 2, 5)
            });
            this.Add(new Course
            {
                Name = "Learning Expression Blend",
                Id = 1003,
                StartDate = new DateTime(2010, 2, 8),
                EndDate = new DateTime(2010, 2, 19)
            });
            this.Add(new Course
            {
                Name = "Learning LINQ",
                Id = 1004,
                StartDate = new DateTime(2010, 2, 22),
                EndDate = new DateTime(2010, 3, 5)
            });
        }
    }

    public class Course : IEditableObject, INotifyPropertyChanged
    {
        private string _name;
        public string Name
        {
            get
            {
                return _name;
            }
            set
            {
                if (_name == value) return;
                _name = value;
                OnPropertyChanged("Name");
            }
        }

        private int _number;
        public int Id
        {
            get
            {
                return _number;
            }
            set
            {
                if (_number == value) return;
                _number = value;
                OnPropertyChanged("Id");
            }
        }

        private DateTime _startDate;
        public DateTime StartDate
        {
            get
            {
                return _startDate;
            }
            set
            {
                if (_startDate == value) return;
                _startDate = value;
                OnPropertyChanged("StartDate");
            }
        }

        private DateTime _endDate;
        public DateTime EndDate
        {
            get
            {
                return _endDate;
            }
            set
            {
                if (_endDate == value) return;
                _endDate = value;
                OnPropertyChanged("EndDate");
            }
        }

        #region IEditableObject

        private Course backupCopy;
        private bool inEdit;

        public void BeginEdit()
        {
            if (inEdit) return;
            inEdit = true;
            backupCopy = this.MemberwiseClone() as Course;
        }

        public void CancelEdit()
        {
            if (!inEdit) return;
            inEdit = false;
            this.Name = backupCopy.Name;
            this.Id = backupCopy.Id;
            this.StartDate = backupCopy.StartDate;
            this.EndDate = backupCopy.EndDate;
        }

        public void EndEdit()
        {
            if (!inEdit) return;
            inEdit = false;
            backupCopy = null;
        }

        #endregion

        #region INotifyPropertyChanged

        public event PropertyChangedEventHandler PropertyChanged;

        private void OnPropertyChanged(string propertyName)
        {
            if (PropertyChanged != null)
            {
                PropertyChanged(this,
                    new PropertyChangedEventArgs(propertyName));
            }
        }

        #endregion

    }

    public class CourseValidationRule : ValidationRule
    {
        public override ValidationResult Validate(object value,
            System.Globalization.CultureInfo cultureInfo)
        {
            Course course = (value as BindingGroup).Items[0] as Course;
            if (course.StartDate > course.EndDate)
            {
                return new ValidationResult(false,
                    "Start Date must be earlier than End Date.");
            }
            else
            {
                return ValidationResult.ValidResult;
            }
        }
    }

}

<Window x:Class="DataGridValidation.MainWindow"
  xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:local="clr-namespace:DataGridValidation"
  Title="DataGrid Validation Example" Height="240" Width="600">

  <Grid>

    <Grid.Resources>
      <local:Courses x:Key="courses"/>
    </Grid.Resources>

    <DataGrid Name="dataGrid1" FontSize="20" RowHeaderWidth="27"
      ItemsSource="{StaticResource courses}" 
      AutoGenerateColumns="False">

      <DataGrid.Resources>
        <Style x:Key="errorStyle" TargetType="{x:Type TextBox}">
          <Setter Property="Padding" Value="-2"/>
          <Style.Triggers>
            <Trigger Property="Validation.HasError" Value="True">
              <Setter Property="Background" Value="Red"/>
              <Setter Property="ToolTip" 
                Value="{Binding RelativeSource={RelativeSource Self},
                  Path=(Validation.Errors)[0].ErrorContent}"/>
            </Trigger>
          </Style.Triggers>
        </Style>
      </DataGrid.Resources>

      <DataGrid.Columns>
        <DataGridTextColumn Header="Course Name" 
          Binding="{Binding Name, TargetNullValue=(enter a course name)}"/>
        <DataGridTextColumn Header="Course ID"
          EditingElementStyle="{StaticResource errorStyle}"
          Binding="{Binding Id, ValidatesOnExceptions=True}"/>
        <DataGridTextColumn Header="Start Date"
          EditingElementStyle="{StaticResource errorStyle}"
          Binding="{Binding StartDate, ValidatesOnExceptions=True, 
            StringFormat=d}"/>
        <DataGridTextColumn Header="End Date"
          EditingElementStyle="{StaticResource errorStyle}"
          Binding="{Binding EndDate, ValidatesOnExceptions=True,
            StringFormat=d}"/>
      </DataGrid.Columns>

      <DataGrid.RowValidationRules>
        <local:CourseValidationRule ValidationStep="UpdatedValue"/>
      </DataGrid.RowValidationRules>

      <DataGrid.RowValidationErrorTemplate>
        <ControlTemplate>
          <Grid Margin="0,-2,0,-2"
            ToolTip="{Binding RelativeSource={RelativeSource
            FindAncestor, AncestorType={x:Type DataGridRow}},
            Path=(Validation.Errors)[0].ErrorContent}">
            <Ellipse StrokeThickness="0" Fill="Red" 
              Width="{TemplateBinding FontSize}" 
              Height="{TemplateBinding FontSize}" />
            <TextBlock Text="!" FontSize="{TemplateBinding FontSize}" 
              FontWeight="Bold" Foreground="White" 
              HorizontalAlignment="Center"  />
          </Grid>
        </ControlTemplate>
      </DataGrid.RowValidationErrorTemplate>

    </DataGrid>

  </Grid>
</Window>

参照

処理手順

方法 : バインディングの検証の実装

方法 : カスタム オブジェクトに検証ロジックを実装する

参照

DataGrid

その他の技術情報

DataGrid

データ バインド (WPF)