DataGridView.ValidateCell Event
Occurs after a user changes a cell value in the in-place editor and attempts to select another cell.
Namespace: DevExpress.XamarinForms.DataGrid
Assembly: DevExpress.XamarinForms.Grid.dll
NuGet Package: DevExpress.XamarinForms.Grid
Declaration
public event DataGridValidationEventHandler ValidateCell
Event Data
The ValidateCell event's data class is DataGridValidationEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
ErrorContent | Gets or sets the validation error description. |
FieldName | Gets the field name of the column that contains the cell whose value is being edited. |
Item | Gets an object that specifies a data source record to which the grid’s row containing the currently edited cell corresponds. |
NewValue | Gets the editor’s value. |
OldValue | Gets the cell’s value before editing is started. |
RowHandle | Gets the handle of the row that contains the cell whose value is being edited. |
Example
This example shows how to validate a new cell value when a user modified it in an in-place cell editor and moves focus to another cell.
The DataGridView instance is bound to a collection of orders, and its Quantity column allows users to enter positive numbers only. If a new cell value does not pass validation, an error message is displayed and the user cannot move focus to another cell until the error is corrected.
Follow the steps below to validate cell values:
- Specify Validation Rules
Subscribe to theDataGridView.ValidateCell
event, and implement validation logic in the event handler.
Use the event parameter’s OldValue and NewValue properties to get the cell’s original and new value (the value that should be validated). The FieldName and RowHandle properties allow you to obtain the column and row that contain the cell whose value is being edited.
If a cell value fails validation, set the ErrorContent property to the string that describes the validation error. A user cannot move focus to another cell until the error is fixed and the ErrorContent string is empty. - Indicate Errors
Handle the DataGridView.ValidationError event to provide a response to entering invalid data (for example, show validation error message to users). This event parameter’s ValidationErrorEventArgs.ErrorContent property contains the error description assigned to the DataGridValidationEventArgs.ErrorContent property in theValidateCell
event hander.
<dxg:DataGridView x:Name="grid" ItemsSource="{Binding Orders}"
ValidateCell="Grid_ValidateCell"
ValidationError="Grid_ValidationError">
<!-- ... -->
</dxg:DataGridView>
using Xamarin.Forms;
using DevExpress.XamarinForms.DataGrid;
// ...
private void Grid_ValidateCell(object sender, DataGridValidationEventArgs e) {
if (e.FieldName == "Quantity" && (decimal)e.NewValue <= 0)
e.ErrorContent = "The value must be positive.";
}
private void Grid_ValidationError(object sender, ValidationErrorEventArgs e) {
DisplayAlert("Input Error", e.ErrorContent, "OK");
}