VGridControlBase.InvalidRecordException Event

Fires when a record fails validation or when it cannot be saved to the data source.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v24.2.dll

Declaration

C#

public event InvalidRecordExceptionEventHandler InvalidRecordException

VB.NET

Public Event InvalidRecordException As InvalidRecordExceptionEventHandler

Event Data

The InvalidRecordException event's data class is DevExpress.XtraVerticalGrid.Events.InvalidRecordExceptionEventArgs.

Remarks

If a record was modified and is about to lose focus, the vertical grid raises the VGridControlBase.ValidateRecord event. You can handle this event to check the record’s data for validity. If the record fails validation or cannot be saved to the data source due to database restrictions, the InvalidRecordException is raised.

Handle the InvalidRecordException event to provide an appropriate response to invalid data being entered. The event parameter’s properties allow you to identify the record whose data failed validation, the exception that raised the event and to specify the error description. The actual response is specified by the ExceptionEventArgs.ExceptionMode parameter. You can display an error message box, discard the changes made, raise an exception or take no action.

For more information, see Validation.

Example

Assume that the vertical grid contains two rows: “OrderDate” and “RequiredDate”. The value in the first row must be less than the value in the second one. So we need to validate their values in a record when it is about to be saved to the data source. For this purpose, the VGridControlBase.ValidateRecord event is handled.

If the record fails validation, we set errors for the rows with corresponding descriptions using the VGridControlBase.SetRowError method. The descriptions will be displayed when the mouse cursor hovers over the error icons.

The VGridControlBase.InvalidRecordException event is handled in order to suppress displaying the default error message box.

The following image shows a vertical grid after a record fails validation.

C#

using DevExpress.XtraVerticalGrid.Events;

private void vGridControl1_ValidateRecord(object sender, ValidateRecordEventArgs e) {
   VGridControl vGrid = sender as VGridControl;
   // Get the value of the first row.
   DateTime value1 = Convert.ToDateTime(vGrid.GetCellValue(editorRow2, 
     e.RecordIndex));
   // Get the value of the second row.
   DateTime value2 = Convert.ToDateTime(vGrid.GetCellValue(editorRow3, 
     e.RecordIndex));
   if (value1 >= value2) {
      e.Valid = false;
      // Set errors with specific descriptions for the rows.
      vGrid.SetRowError(editorRow2.Properties, 
        "The value must be less than Required Date");
      vGrid.SetRowError(editorRow3.Properties, 
        "The value must be greater than Order Date");
   }
}

private void vGridControl1_InvalidRecordException(object sender, 
InvalidRecordExceptionEventArgs e) {
   // Suppress displaying the error message box.
   e.ExceptionMode = DevExpress.XtraEditors.Controls.ExceptionMode.NoAction;
}

VB.NET

Imports DevExpress.XtraVerticalGrid.Events
Private Sub VGridControl1_ValidateRecord(ByVal sender As Object, _
ByVal e As ValidateRecordEventArgs) Handles VGridControl1.ValidateRecord
   Dim vGrid As VGridControl = sender
   ' Get the value of the first row.
   Dim date1 As DateTime = CType(vGrid.GetCellValue( _
     rowOrderDate, e.RecordIndex), DateTime)
   ' Get the value of the second row.
   Dim date2 As DateTime = CType(vGrid.GetCellValue( _
     rowRequiredDate, e.RecordIndex), DateTime)
   If date1 >= date2 Then
      e.Valid = False
      ' Set errors with specific descriptions for the rows.
      vGrid.SetRowError(rowOrderDate.Properties, _
        "The value must be less than Required Date")
      vGrid.SetRowError(rowRequiredDate.Properties, _
        "The value must be greater than Order Date")
   End If
End Sub

Private Sub VGridControl1_InvalidRecordException(ByVal sender As Object, _
ByVal e As InvalidRecordExceptionEventArgs) _
Handles VGridControl1.InvalidRecordException
   ' Suppress displaying the error message box.
   e.ExceptionMode = DevExpress.XtraEditors.Controls.ExceptionMode.NoAction
End Sub