GridCellValidationEventArgs.CellValue Property

Gets the cell’s old valid value.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.1.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public object CellValue { get; }

VB.NET

Public ReadOnly Property CellValue As Object

Property Value

Type	Description
Object	An object that represents the cell’s old valid value.

Remarks

When handling the GridColumn.Validate event, the cell’s curernt value isn’t saved to a data source until it is validated. The event parameter’s CellValue property returns the cell’s old valid value. The current value which is being validated is returned by the event parameter’s Value property.

Example

This example shows how to validate the focused cell’s value. In this example, users cannot reduce the product’s price by more than 30% if the product is on discount.

View Example: How to Validate Cell Editors

XAML

<dxg:GridControl x:Name="grid">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="ProductName">
            <dxg:GridColumn.EditSettings>
                <dxe:TextEditSettings AllowNullInput="False" />
            </dxg:GridColumn.EditSettings>
        </dxg:GridColumn>
        <dxg:GridColumn FieldName="UnitPrice">
            <dxg:GridColumn.EditSettings>
                <dxe:SpinEditSettings DisplayFormat="c2" />
            </dxg:GridColumn.EditSettings>
        </dxg:GridColumn>
        <dxg:GridColumn FieldName="Discontinued" />
    </dxg:GridControl.Columns>
    <dxg:GridControl.View>
        <dxg:TableView AutoWidth="True"
                       ValidateCell="OnValidateCell" />
    </dxg:GridControl.View>
</dxg:GridControl>

C#

void OnValidateCell(object sender, GridCellValidationEventArgs e) {
    if(e.Column.FieldName != nameof(Product.UnitPrice) || !((Product)e.Row).Discontinued)
        return;
    var cellValue = (double)e.CellValue;
    var discount = 100 - Convert.ToDouble(e.Value) / cellValue * 100;
    if(discount > 0 && discount <= 30)
        return;

    e.IsValid = false;
    e.ErrorType = DevExpress.XtraEditors.DXErrorProvider.ErrorType.Critical;
    e.ErrorContent = discount < 0
        ? $"The price cannot be greater than {cellValue}"
        : $"The discount cannot be greater than 30% ({cellValue * 0.7}). Please correct the price.";
}

VB.NET

Private Sub OnValidateCell(ByVal sender As Object, ByVal e As GridCellValidationEventArgs)
    If Not Equals(e.Column.FieldName, NameOf(Product.UnitPrice)) OrElse Not CType(e.Row, Product).Discontinued Then Return
    Dim cellValue = CDbl(e.CellValue)
    Dim discount = 100 - Convert.ToDouble(e.Value) / cellValue * 100
    If discount > 0 AndAlso discount <= 30 Then Return
    e.IsValid = False
    e.ErrorType = DevExpress.XtraEditors.DXErrorProvider.ErrorType.Critical
    e.ErrorContent = If(discount < 0, $"The price cannot be greater than {cellValue}", $"The discount cannot be greater than 30% ({cellValue * 0.7}). Please correct the price.")
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CellValue property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-data-grid-validate-cell-editors/CS/ValidateCell_CodeBehind/MainWindow.xaml.cs#L31

    return;
var cellValue = (double)e.CellValue;
var discount = 100 - Convert.ToDouble(e.Value) / cellValue * 100;

VB.NET

wpf-data-grid-validate-cell-editors/VB/ValidateCell_CodeBehind/MainWindow.xaml.vb#L38

If Not Equals(e.Column.FieldName, NameOf(Product.UnitPrice)) OrElse Not CType(e.Row, Product).Discontinued Then Return
Dim cellValue = CDbl(e.CellValue)
Dim discount = 100 - Convert.ToDouble(e.Value) / cellValue * 100