BaseEdit.DefaultErrorImageOptions Property

Gets a set of options that allow you to assign and customize the default icon displayed when an error is associated with the editor.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

csharp

public static BaseEditErrorImageOptions DefaultErrorImageOptions { get; }

Public Shared ReadOnly Property DefaultErrorImageOptions As BaseEditErrorImageOptions

Property Value

Type	Description
BaseEditErrorImageOptions

A BaseEditErrorImageOptions object that stores properties that allow you to assign and customize the default icon displayed when an error is associated with the editor.

Remarks

You can display an error icon next to an editor to indicate that the editor value is not valid. The default icon is displayed to the left of the editor.

Customize the Default Error Icon

Use the static (Shared in VB) DefaultErrorImageOptions property to access options that allow you to customize the error icon for all editors:

Image/SvgImageSpecifies a custom image used as an error icon.AlignmentSpecifies image alignment relatively to the editor.

Note

Specify these properties before editor initialization (in the Main method). Editors do not react to subsequent changes.

C#
VB.NET

csharp

static void Main() {
  BaseEdit.DefaultErrorImageOptions.SvgImage = Properties.Resources.errorIcon;
  BaseEdit.DefaultErrorImageOptions.Alignment = ErrorIconAlignment.BottomRight;

  Application.EnableVisualStyles();
  Application.SetCompatibleTextRenderingDefault(false);
  Application.Run(new Form1());
}

Shared Sub Main()
  BaseEdit.DefaultErrorImageOptions.SvgImage = My.Resources.errorIcon
  BaseEdit.DefaultErrorImageOptions.Alignment = ErrorIconAlignment.BottomRight

  Application.EnableVisualStyles()
  Application.SetCompatibleTextRenderingDefault(False)
  Application.Run(New Form1())
End Sub

Customize the Error Icon for an Individual Editor

Use an editor’s ErrorImageOptions property to access the following options:

Image/SvgImageSpecifies a custom image used as an error icon.AlignmentSpecifies image alignment relatively to the editor.

Individual editor settings have priority over DefaultErrorImageOptions settings.

C#
VB.NET

csharp

public Form1() {
  InitializeComponent();
  textEdit1.ErrorImageOptions.SvgImage = svgImageCollection1["error"];
  textEdit1.ErrorImageOptions.Alignment = ErrorIconAlignment.TopLeft;
}

Public Sub New()
  InitializeComponent()
  textEdit1.ErrorImageOptions.SvgImage = svgImageCollection1("error")
  textEdit1.ErrorImageOptions.Alignment = ErrorIconAlignment.TopLeft
End Sub

Customize Error Tooltip Text

Use the ErrorText property to specify error tooltip text for a standalone editor. If you use an editor in a data-aware control, use the parent control’s ValidatingEditor event to validate the editor value and display an error icon. Read the following help topic for more information: Manage user Input.

Tip

For information on how to validate editor values, read the following help topic: Validation.