BaseEdit.ErrorText Property

Gets or sets the error description for the editor.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[Browsable(false)]
public string ErrorText { get; set; }

VB.NET

<Browsable(False)>
Public Property ErrorText As String

Property Value

Type	Description
String	A string value specifying the error description for the editor.

Remarks

If the ErrorText property is specified, the editor displays an error icon at the near edge. The tooltip contains the error description. To display the tooltip, hover the error icon with the mouse pointer.

The default error icon () is specified by the static BaseEdit.DefaultErrorIcon property. To customize the error icon for a specific editor, use the BaseEdit.ErrorImageOptions property.

You can specify an error when you validate a value in a RepositoryItem.Validating event handler. For example, if the value is not valid, you may leave the editor focused until the value is corrected. Use the ErrorText property to informe a user how to correct the value.

C#

using DevExpress.XtraEditors;

private void textEdit1_Validating(object sender, CancelEventArgs e) {
    TextEdit textEdit = sender as TextEdit;
    string editValue = textEdit.EditValue as string;
    Regex regex = new Regex("^[a-zA-Z0-9 ]*$");
    if (!regex.IsMatch(editValue)) {
        textEdit.ErrorText = "The name should only contain alphanumeric characters";
        textEdit.ErrorImageOptions.ImageUri.Uri = "SpellCheckAsYouType;Size16x16";
        e.Cancel = true;
    }
}

VB.NET

Imports DevExpress.XtraEditors

Private Sub textEdit1_Validating(ByVal sender As Object, ByVal e As CancelEventArgs) _
    Handles textEdit1.Validating
    Dim textEdit As TextEdit = TryCast(sender, TextEdit)
    Dim editValue As String = TryCast(textEdit.EditValue, String)
    Dim regex As New Regex("^[a-zA-Z0-9 ]*$")
    If Not regex.IsMatch(editValue) Then
        textEdit.ErrorText = "The name should only contain alphanumeric characters"
        textEdit.ErrorImageOptions.ImageUri.Uri = "SpellCheckAsYouType;Size16x16"
        e.Cancel = True
    End If
End Sub

Tip

You can also use the ErrorProvider component as this provides a flexible way to indicate errors, especially for standalone data-bound controls.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#L348

    return String.IsNullOrEmpty(this.edtEndTime.ErrorText) && String.IsNullOrEmpty(this.edtEndDate.ErrorText) && String.IsNullOrEmpty(this.edtStartDate.ErrorText) && String.IsNullOrEmpty(this.edtStartTime.ErrorText);
}

VB.NET

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

    Return [String].IsNullOrEmpty(Me.edtEndTime.ErrorText) AndAlso [String].IsNullOrEmpty(Me.edtEndDate.ErrorText) AndAlso [String].IsNullOrEmpty(Me.edtStartDate.ErrorText) AndAlso [String].IsNullOrEmpty(Me.edtStartTime.ErrorText)
End Function