HOW TO：使用 DataGrid 控制項實作驗證

DataGrid 控制項可讓您在儲存格和資料列層級執行驗證。 使用儲存格層級驗證，可在使用者更新值時驗證所繫結資料物件的個別屬性。 使用資料列層級驗證，可在使用者認可資料列變更時驗證整個資料物件。 您也可以提供驗證錯誤的自訂視覺化回應，或使用 DataGrid 控制項提供的預設視覺化回應。

下列程序描述如何將驗證規則套用至 DataGrid 繫結，以及自訂視覺化回應。

若要驗證個別儲存格值

• 針對與資料行搭配使用的繫結，指定一個或多個驗證規則。 這類似於驗證簡單控制項中的資料 (如資料繫結概觀所述)。

  下列範例顯示 DataGrid 控制項，其具有四個資料行繫結至商務物件的不同屬性。 其中三個資料行將 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 附加屬性。

  下列範例使用驗證規則加入三個資料行共用的錯誤樣式，來更新上一個範例。 如果使用者輸入無效值，則樣式會變更儲存格背景色彩，並加入工具提示。 請注意觸發程式的使用，以判斷是否發生驗證錯誤。 這是必要的條件，因為目前沒有儲存格專用的錯誤範本。

  <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 鍵。

• 發生驗證錯誤時，請將滑鼠指標移至資料列標頭的指標上方，以查看相關錯誤訊息。

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>

請參閱

工作

HOW TO：實作繫結驗證

HOW TO：對自訂物件實作驗證邏輯

參考

DataGrid

其他資源

DataGrid

資料繫結 (WPF)