ExceptionEventArgs.ErrorText Property

Gets or sets the error description to be displayed in the message box/tooltip.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public string ErrorText { get; set; }

VB.NET

Public Property ErrorText As String

Property Value

Type	Description
String	A string value specifying the text to display in the message box/tooltip.

Remarks

If the ExceptionEventArgs.ExceptionMode property is set to ExceptionMode.DisplayError, the message box displaying the text specified by the ErrorText property is invoked. The message box’s caption is specified by the ExceptionEventArgs.WindowCaption property.

When handling container control events that occur when assigning invalid values to cells, setting the ExceptionEventArgs.ExceptionMode property to ExceptionMode.DisplayError displays a tooltip with the ErrorText string.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ErrorText 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#

how-to-localize-winforms-scheduler-ui-using-the-localizer-class-descendant-t391865/CS/SchedulerLocalizerExample/OutlookAppointmentForm.cs#L282

protected internal virtual void OnEdtStartTimeInvalidValue(object sender, InvalidValueExceptionEventArgs e) {
    e.ErrorText = SchedulerLocalizer.GetString(SchedulerStringId.Msg_DateOutsideLimitInterval);
}

getting-started-with-the-scheduler-e5124/CS/SchedulerGettingStarted/CustomAppointmentForm.cs#L303

{
    e.ErrorText = SchedulerLocalizer.GetString(SchedulerStringId.Msg_InvalidEndDate);
}

lesson-7-create-a-custom-appointment-edit-form-t342127/CS/SchedulerDbExample/CustomAppointmentForm.cs#L271

protected internal virtual void OnEdtEndDateInvalidValue(object sender, InvalidValueExceptionEventArgs e) {
    e.ErrorText = SchedulerLocalizer.GetString(SchedulerStringId.Msg_InvalidEndDate);
}

how-to-create-a-custom-model-for-the-wizardcontrol-e2303/CS/frmMain.cs#L74

private void teEmail_InvalidValue(object sender, DevExpress.XtraEditors.Controls.InvalidValueExceptionEventArgs e) {
    e.ErrorText = "Invalid email address";
}

VB.NET

how-to-localize-winforms-scheduler-ui-using-the-localizer-class-descendant-t391865/VB/SchedulerLocalizationExample_VB/OutlookAppointmentForm.vb#L313

Protected Friend Overridable Sub OnEdtStartTimeInvalidValue(sender As Object, e As InvalidValueExceptionEventArgs)
    e.ErrorText = SchedulerLocalizer.GetString(SchedulerStringId.Msg_DateOutsideLimitInterval)
End Sub

getting-started-with-the-scheduler-e5124/VB/SchedulerGettingStarted/CustomAppointmentForm.vb#L330

Protected Friend Overridable Sub OnEdtEndDateInvalidValue(ByVal sender As Object, ByVal e As InvalidValueExceptionEventArgs)
    e.ErrorText = SchedulerLocalizer.GetString(SchedulerStringId.Msg_InvalidEndDate)
End Sub

lesson-7-create-a-custom-appointment-edit-form-t342127/VB/SchedulerDbExample/CustomAppointmentForm.vb#L332

Protected Friend Overridable Sub OnEdtEndDateInvalidValue(ByVal sender As Object, ByVal e As InvalidValueExceptionEventArgs)
    e.ErrorText = SchedulerLocalizer.GetString(SchedulerStringId.Msg_InvalidEndDate)
End Sub

how-to-create-a-custom-model-for-the-wizardcontrol-e2303/VB/frmMain.vb#L92

Private Sub teEmail_InvalidValue(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.InvalidValueExceptionEventArgs) Handles teEmail.InvalidValue
    e.ErrorText = "Invalid email address"
End Sub