ASPxGridView.CustomErrorText Event

Enables you to provide custom error descriptions.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

C#

public event ASPxGridViewCustomErrorTextEventHandler CustomErrorText

VB.NET

Public Event CustomErrorText As ASPxGridViewCustomErrorTextEventHandler

Event Data

The CustomErrorText event's data class is ASPxGridViewCustomErrorTextEventArgs. The following properties provide information specific to this event:

Property	Description
ErrorText	Gets or sets the error text. Inherited from ASPxGridCustomErrorTextEventArgs.
ErrorTextKind	Indicates the error source. Inherited from ASPxGridCustomErrorTextEventArgs.
Exception	Gets the exception. Inherited from ASPxGridCustomErrorTextEventArgs.

Remarks

The CustomErrorText event occurs when any exception is raised within the ASPxGridView, and allows you to change the error text displayed by default. This can be useful if you want to localize error messages.

Use the ASPxGridCustomErrorTextEventArgs.ErrorText property to specify the error text.

The exception can be obtained via the ASPxGridCustomErrorTextEventArgs.Exception property. If the exception has been raised within the ASPxGridView.RowValidating event handler, the ASPxGridCustomErrorTextEventArgs.ErrorTextKind property returns GridErrorTextKind.RowValidate. Otherwise, it returns GridErrorTextKind.General.

Online Example

• ASPxGridView in Batch Edit mode - Implement the Select All feature for the CheckBox column

Example

The code sample below demonstrates how you can handle the CustomErrorText event to specify the particular error text, based on the exception type.

C#

protected void ASPxGridView1_CustomErrorText(object sender,
DevExpress.Web.ASPxGridViewCustomErrorTextEventArgs e) {
    if (e.Exception is NullReferenceException)
        e.ErrorText = "NullReferenceException Text";
    else if (e.Exception is InvalidOperationException)
        e.ErrorText = "InvalidOperationException Text";
    ...
}