BaseEdit.ErrorText Property

Gets or sets the tooltip displayed when the mouse pointer hovers over the error icon.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.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 that specifies the tooltip displayed when the mouse pointer hovers over the error icon.

Remarks

You can display an error icon next to the editor to indicate that the editor’s value is not valid. The default icon is displayed to the left of the editor. Use the static (Shared in VB) DefaultErrorImageOptions property to access the following options that allow you to customize the default icon:

• Image — a custom raster image used as an error icon. The icon’s size must be 12x12 pixels. This property is equivalent to the DefaultErrorIcon property.
• Alignment — an alignment relative to the editor. This property is equivalent to the DefaultErrorIconAlignment property.

Update these properties before the editor is initialized. You can also use the ErrorImageOptions property to access the same options that allow you to customize the error icon for an individual editor:

• Image — a custom raster image used as an error icon. This property is equivalent to the ErrorIcon property.
• Alignment — an alignment relative to the editor. This property is equivalent to the ErrorIconAlignment property.

The icon is shown if an error message is assigned to the ErrorText property. The error message is displayed in a tooltip that appears when the mouse pointer hovers over the icon.

Tip

Use the ErrorText property to display an icon with a tooltip next to a stand-alone editor. If you use an editor in a data-aware control, use the control’s following events to validate an editor’s value and display an error icon: BaseView.ValidatingEditor, TreeList.ValidatingEditor, and VGridControlBase.ValidatingEditor.

If an editor value is invalid (the error icon and text are shown), users can press “Esc” to clear the ErrorText and revert the editor back to its OldEditValue. To disable this default behavior, handle the KeyPress event:

C#

txtNewNote.KeyPress += TxtNewNote_KeyPress;

private void TxtNewNote_KeyPress(object sender, KeyPressEventArgs e) {
    MemoEdit edit = sender as MemoEdit;
    if (e.KeyChar == (char)Keys.Escape && !string.IsNullOrEmpty(edit.ErrorText))
        e.Handled = true;
}

VB.NET

Private txtNewNote.KeyPress += AddressOf TxtNewNote_KeyPress

Private Sub TxtNewNote_KeyPress(ByVal sender As Object, ByVal e As KeyPressEventArgs)
    Dim edit As MemoEdit = TryCast(sender, MemoEdit)
    If e.KeyChar = CChar(Keys.Escape) AndAlso (Not String.IsNullOrEmpty(edit.ErrorText)) Then
        e.Handled = True
    End If
End Sub

Example

You can handle the Control.Validating or RepositoryItem.Validating event to validate the editor’s value. The code below uses the ErrorText property to inform 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.Image = svgImageCollection1.GetImage(0, new Size(12, 12));
        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.Image = svgImageCollection1.GetImage(0, new Size(12, 12))
        e.Cancel = True
    End If
End Sub

Tip

You can also use the ErrorProvider component to validate editors.

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#

winforms-scheduler-localizer-translate-ui/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

winforms-scheduler-localizer-translate-ui/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