# ErrorProvider Namespace: **Wisej.Web** Assembly: **Wisej.Framework** (4.0.0.0) * [Component](https://docs.wisej.com/api/wisej.base/general/wisej.base.component) * [Component](https://docs.wisej.com/api/wisej.web/general/wisej.web.component) * [ErrorProvider](https://docs.wisej.com/api/wisej.web/extenders/errorprovider) Provides a user interface for indicating that a control on a form has an error associated with it. {% tabs %} {% tab title="C#" %} ```csharp public class ErrorProvider : Component, IExtenderProvider, ISupportInitialize, IErrorProvider ``` {% endtab %} {% tab title="VB.NET" %} ```visual-basic Public Class ErrorProvider Inherits Component Implements IExtenderProvider, ISupportInitialize, IErrorProvider ``` {% endtab %} {% endtabs %} ## Constructors ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ErrorProvider() Initializes a new instance of the [ErrorProvider](https://docs.wisej.com/api/wisej.web/extenders/errorprovider) class and initializes the default settings for [BlinkRate](#blinkrate), [BlinkStyle](#blinkstyle), and the [Icon](#icon). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ErrorProvider(containerControl) Initializes a new instance of the [ErrorProvider](https://docs.wisej.com/api/wisej.web/extenders/errorprovider) class attached to a [ContainerControl](https://docs.wisej.com/api/wisej.web/containers/containercontrol). | Name | Type | Description | | -------------------- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | | **containerControl** | [ContainerControl](https://docs.wisej.com/api/wisej.web/containers/containercontrol) | The [ContainerControl](https://docs.wisej.com/api/wisej.web/containers/containercontrol) to monitor for errors. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ErrorProvider(container) Initializes a new instance of the [ErrorProvider](https://docs.wisej.com/api/wisej.web/extenders/errorprovider) class attached to an [IContainer](https://docs.microsoft.com/dotnet/api/system.componentmodel.icontainer) implementation. | Name | Type | Description | | ------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **container** | [IContainer](https://docs.microsoft.com/dotnet/api/system.componentmodel.icontainer) | An [IContainer](https://docs.microsoft.com/dotnet/api/system.componentmodel.icontainer) that represents the container of the [ErrorProvider](https://docs.wisej.com/api/wisej.web/extenders/errorprovider) extender. | ## Properties ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) AllowHtml [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets a value indicating that the control can display HTML in the ErrorMessage property. (Default: `False`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) BlinkAnimation [ErrorAnimationType](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroranimationtype): Returns or sets a value indicating the type of animation to perform when the error icon blinks.. (Default: `Blink`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) BlinkRate [Int32](https://docs.microsoft.com/dotnet/api/system.int32): Returns or sets the rate at which the error icon flashes. (Default: `250`) **Throws:** * [ArgumentOutOfRangeException](https://docs.microsoft.com/dotnet/api/system.argumentoutofrangeexception)\ The value is less than zero. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) BlinkStyle [ErrorBlinkStyle](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.errorblinkstyle): Returns or sets a value indicating when the error icon flashes. (Default: `BlinkIfDifferentError`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ContainerControl [ScrollableControl](https://docs.wisej.com/api/wisej.web/containers/scrollablecontrol): Returns or sets the container [ContainerControl](https://docs.wisej.com/api/wisej.web/containers/containercontrol)that provides the [BindingContext](https://docs.wisej.com/api/wisej.web/data-binding/wisej.web.bindingcontext) for binding to the [IDataErrorInfo](https://docs.microsoft.com/dotnet/api/system.componentmodel.idataerrorinfo) interface implemented by a [DataSource](#datasource). (Default: `null`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DataMember [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the list within a data source to monitor for errors. (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DataSource [Object](https://docs.microsoft.com/dotnet/api/system.object): Returns or sets the data source that the [ErrorProvider](https://docs.wisej.com/api/wisej.web/extenders/errorprovider) monitors for errors. (Default: `null`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) HasErrors [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns true when the error provider contains at least one error. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Icon [Image](https://docs.microsoft.com/dotnet/api/system.drawing.image): Returns or sets the [Image](https://docs.microsoft.com/dotnet/api/system.drawing.image) that is displayed next to a control when an error description string has been set for the control. **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)\ The assigned value of the [Image](https://docs.microsoft.com/dotnet/api/system.drawing.image) is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) IconAlignment [ErrorIconAlignment](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroriconalignment): Returns or sets the default [ErrorIconAlignment](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroriconalignment). (Default: `MiddleRight`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) IconPadding [Int32](https://docs.microsoft.com/dotnet/api/system.int32): Returns or sets the default [ErrorIconAlignment](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroriconalignment). (Default: `0`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) IconSource [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the source URL of the image that is displayed next to a control when an error description string has been set for the control. **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)\ The assigned value of the [Image](https://docs.microsoft.com/dotnet/api/system.drawing.image) is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) RightToLeft [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets a value that indicates whether the component is used in a locale that supports right-to-left fonts. (Default: `False`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Tag [Object](https://docs.microsoft.com/dotnet/api/system.object): Returns or sets an object that contains data about the component. (Default: `null`) ## Methods ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) BindToDataAndErrors(dataSource, dataMember) Sets the [DataSource](#datasource) and [DataMember](#datamember) properties. | Parameter | Type | Description | | -------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | **dataSource** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | A data set based on the [IList](https://docs.microsoft.com/dotnet/api/system.collections.ilist) interface to be monitored for errors. | | **dataMember** | [String](https://docs.microsoft.com/dotnet/api/system.string) | A collection within the *dataSource* to monitor for errors. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) CanExtend(extendee) Returns a value indicating whether a control can be extended. | Parameter | Type | Description | | ------------ | ------------------------------------------------------------- | --------------------------- | | **extendee** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The control to be extended. | **Returns:** [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean). true if the control can be extended; otherwise, false.This property will be true if the object is a [Control](https://docs.wisej.com/api/wisej.web/general/control) and is not a [Form](https://docs.wisej.com/api/wisej.web/containers/form) or [ToolBar](https://docs.wisej.com/api/wisej.web/containers/toolbar). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Clear() Clears all error providers. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) Dispose(disposing) Disposes the component and removes it from the design container. | Parameter | Type | Description | | ------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------- | | **disposing** | [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean) | true when this method is called by the application rather than a finalizer. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) GetError(control) Returns the current error description string for the specified control. | Parameter | Type | Description | | ----------- | --------------------------------------------------------------- | ------------------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The item to get the error description string for. | **Returns:** [String](https://docs.microsoft.com/dotnet/api/system.string). The error description string for the specified control. **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)*control* is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) GetIconAlignment(control) Returns a value indicating where the error icon should be placed in relation to the control. | Parameter | Type | Description | | ----------- | --------------------------------------------------------------- | ----------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The control to get the icon location for. | **Returns:** [ErrorIconAlignment](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroriconalignment). One of the [ErrorIconAlignment](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroriconalignment) values. The default icon alignment is [MiddleRight](https://docs.wisej.com/api/wisej.web/wisej.web.erroriconalignment#fields). **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)*control* is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) GetIconPadding(control) Returns the amount of extra space to leave next to the error icon. | Parameter | Type | Description | | ----------- | --------------------------------------------------------------- | ----------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The control to get the padding for. | **Returns:** [Int32](https://docs.microsoft.com/dotnet/api/system.int32). The number of pixels to leave between the icon and the control. **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)*control* is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnErrorChanged(e) | Parameter | Type | Description | | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | **e** | [ErrorProviderErrorChangedEventArgs](https://docs.wisej.com/api/wisej.web/extenders/errorprovider/wisej.web.errorprovidererrorchangedeventargs) | | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnRightToLeftChanged(e) Fires the [RightToLeftChanged](#righttoleftchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnWebRender(config) Renders the client component. | Parameter | Type | Description | | ---------- | ------------------------------------------------------------- | ----------------------------- | | **config** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | Dynamic configuration object. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SetError(control, value) Sets the error description string for the specified control. | Parameter | Type | Description | | ----------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The control to set the error description string for. | | **value** | [String](https://docs.microsoft.com/dotnet/api/system.string) | The error description string, or null or [Empty](https://docs.microsoft.com/dotnet/api/system.string.empty) to remove the error. | **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)*control* is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SetIconAlignment(control, value) Sets the location where the error icon should be placed in relation to the control. | Parameter | Type | Description | | ----------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The control to set the icon location for. | | **value** | [ErrorIconAlignment](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroriconalignment) | One of the [ErrorIconAlignment](https://docs.wisej.com/api/wisej.web/extenders/wisej.web.erroriconalignment) values. | **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)*control* is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SetIconPadding(control, value) Sets the amount of extra space to leave between the specified control and the error icon. | Parameter | Type | Description | | ----------- | --------------------------------------------------------------- | ---------------------------------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The *control* to set the padding for. | | **value** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | The number of pixels to add between the icon and the *control* . | **Throws:** * [ArgumentNullException](https://docs.microsoft.com/dotnet/api/system.argumentnullexception)*control* is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) UpdateBinding() Updated the bindings. ## Events ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ErrorChanged [ErrorProviderErrorChangedHandler](https://docs.wisej.com/api/wisej.web/extenders/errorprovider/wisej.web.errorprovidererrorchangedhandler) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) RightToLeftChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [RightToLeft](#righttoleft) property changes value. ## Implements | Name | Description | | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | [IUserData](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.iuserdata) | Provides access to the `UserData` and `Tag` properties associated to the component implementing this interface. | | [IErrorProvider](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.ierrorprovider) | Exposes a common api implemented by components that can collect errors in relation to a [Control](https://docs.wisej.com/api/wisej.web/general/control). | | [IWisejComponent](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejcomponent) | All wisej components implement this interface. | | [IWisejSerializable](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejserializable) | Allows an object to serialize itself. |