ErrorProvider Xojo Plugin

DesktopErrorProvider Control

The ErrorProvider control is a Xojo control to put error providers on forms and windows.

A error provider is a blinking indicator that indicates that a given field has a error. They're used to indicate errors in user input after form or window validation.

The error provider can show errors for many controls at once with just one instance of the error provider.



This version of the control is for new style Xojo DesktopWindow class.

DesktopUIControl
   DesktopErrorProvider

control DesktopErrorProvider

Properties

DebugDataSizeUsed for internal quality control of the plugin.
DisableBlinkIf set to true then the blinking of the error provider is disabled.
Enabled (Inherited) Determines if the control should be enabled when the owning window is opened.
ErrorCountReturns count of errors
Handle (Inherited) Returns a handle to the control.
Height (Inherited) The height (in points) of the control.
HighResImageSets high resolution image that the ErrorProvider should show when in retina mode. (Legacy property)
ImageSets image that the ErrorProvider should show.
Index (Inherited) If the control is used in a control set, this specifies the control's index in the set.
Left (Inherited) The left side of the control in local coordinates (relative to the window)
Top (Inherited) The top of the control in local coordinates (relative to the window).
Visible (Inherited) Determines whether the control is visible when its owning window is opened. The default is True: the control is visible.
Width (Inherited) The width (in points) of the control.
Window (Inherited) The control's parent window.

Methods

ClearClears an error from a given control. This variation takes DesktopUIControl as parameter.
ClearClears an error from a given control. This variation takes RectControl as parameter.
ClearAllClears a errors from all controls that belong to this error provider
Close (Inherited) Closes a control.
GetMessageGets the error message that belongs to a given control. This is for example often used in mouse down event on the error provider.
GetMessageGets the error message that belongs to a given control. This is for example often used in mouse down event on the error provider.
SetFocus (Inherited) If applicable, sets the focus to the DesktopUIControl. KeyDown events are directed to the control.
ShowErrorShows an error for a given control. In this variation shows the error on the right side of the control which is the default side.
ShowErrorShows a error for a given control. In this variation you can chose if the error should be shown on the left or right side of the control.
ShowErrorShows an error for a given control. In this variation shows the error on the right side of the control which is the default side.
ShowErrorShows an error for a given control. In this variation you can chose if the error should be shown on the left or right side of the control.

Events

Closing (Inherited) The control is about to close.
ConstructContextualMenu (Inherited) This event is called when it is appropriate to display a contextual menu for the control.
ContextualMenuItemSelected (Inherited) Fires when a contextual menuitem selectedItem was selected but the MenuItemSelected event and the MenuHandler for the DesktopMenuItem did not handle the menu selection.
DoublePressedThis event is fired when the error is double clicked.
DragEnter (Inherited) Fires when the passed DragItem enters the DesktopUIControl.
DragExit (Inherited) Fires when the passed DragItem exits the DesktopUIControl.
DragOver (Inherited) Fires when the DragItem is over the DesktopUIControl.
DropObject (Inherited) The item represented by Obj has been dropped on the control.
KeyDown (Inherited) The user has pressed the Key passed while the control has the focus.
KeyUp (Inherited) Fires when the passed Key is released in the control that has the focus.
MouseDownThis event is fired when the error gets mouse down on.
MouseDrag (Inherited) The mouse button was pressed inside the control and moved (dragged) at the location local to the control passed in to x, y. The user has moved the mouse inside the control while the mouse button is held down. This event handler receives parameters that indicate where the mouse is in coordinates local to the control.
MouseEnterThis event is fired when the mouse enters the error.
MouseExitThis event is fired when the exits enters the error.
MouseMoveThis event is fired when the mouse moves on the error.
MouseUpThis event is fired when the error gets mouse up on.
MouseWheel (Inherited) The mouse wheel has been moved.
RequestBuddyControlUse this event to solve cases when you have complex embedding and the ErrorProvider fails to embed canvas to display the Error symbol.

Supported Platforms:

  • macOS Intel 32 bit
  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit