ErrorProvider

Wisej.Web.ErrorProvider

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • ErrorProvider

Provides a user interface for indicating that a control on a form has an error associated with it.

C#

public class ErrorProvider : Component, IExtenderProvider, ISupportInitialize, IErrorProvider

VB.NET

Public Class ErrorProvider
    Inherits Component
    Implements IExtenderProvider, ISupportInitialize, IErrorProvider

Constructors

ErrorProvider()

Initializes a new instance of the ErrorProvider class and initializes the default settings for BlinkRate, BlinkStyle, and the Icon.

ErrorProvider(containerControl)

Initializes a new instance of the ErrorProvider class attached to a ContainerControl.

Name	Type	Description
containerControl	ContainerControl	The ContainerControl to monitor for errors.

ErrorProvider(container)

Initializes a new instance of the ErrorProvider class attached to an IContainer implementation.

Name	Type	Description
container	IContainer	An IContainer that represents the container of the ErrorProvider extender.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the control can display HTML in the ErrorMessage property. (Default: False)

BlinkAnimation

ErrorAnimationType: Returns or sets a value indicating the type of animation to perform when the error icon blinks.. (Default: Blink)

BlinkRate

Int32: Returns or sets the rate at which the error icon flashes. (Default: 250)

Throws:

• ArgumentOutOfRangeException The value is less than zero.

BlinkStyle

ErrorBlinkStyle: Returns or sets a value indicating when the error icon flashes. (Default: BlinkIfDifferentError)

ContainerControl

ScrollableControl: Returns or sets the container ContainerControlthat provides the BindingContext for binding to the IDataErrorInfo interface implemented by a DataSource. (Default: null)

DataMember

String: Returns or sets the list within a data source to monitor for errors. (Default: "")

DataSource

Object: Returns or sets the data source that the ErrorProvider monitors for errors. (Default: null)

HasErrors

Boolean: Returns true when the error provider contains at least one error.

Icon

Image: Returns or sets the Image that is displayed next to a control when an error description string has been set for the control.

Throws:

• ArgumentNullException The assigned value of the Image is null.

IconAlignment

ErrorIconAlignment: Returns or sets the default ErrorIconAlignment. (Default: MiddleRight)

IconPadding

Int32: Returns or sets the default ErrorIconAlignment. (Default: 0)

IconSource

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 The assigned value of the Image is null.

RightToLeft

Boolean: Returns or sets a value that indicates whether the component is used in a locale that supports right-to-left fonts. (Default: False)

Tag

Object: Returns or sets an object that contains data about the component. (Default: null)

Methods

BindToDataAndErrors(dataSource, dataMember)

Sets the DataSource and DataMember properties.

Parameter	Type	Description
dataSource	Object	A data set based on the IList interface to be monitored for errors.
dataMember	String	A collection within the dataSource to monitor for errors.

CanExtend(extendee)

Returns a value indicating whether a control can be extended.

Parameter	Type	Description
extendee	Object	The control to be extended.

Returns: Boolean. true if the control can be extended; otherwise, false.This property will be true if the object is a Control and is not a Form or ToolBar.

Clear()

Clears all error providers.

Dispose(disposing)

Disposes the component and removes it from the design container.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

GetError(control)

Returns the current error description string for the specified control.

Parameter	Type	Description
control	Control	The item to get the error description string for.

Returns: String. The error description string for the specified control.

Throws:

• ArgumentNullExceptioncontrol is null.

GetIconAlignment(control)

Returns a value indicating where the error icon should be placed in relation to the control.

Parameter	Type	Description
control	Control	The control to get the icon location for.

Returns: ErrorIconAlignment. One of the ErrorIconAlignment values. The default icon alignment is MiddleRight.

Throws:

• ArgumentNullExceptioncontrol is null.

GetIconPadding(control)

Returns the amount of extra space to leave next to the error icon.

Parameter	Type	Description
control	Control	The control to get the padding for.

Returns: Int32. The number of pixels to leave between the icon and the control.

Throws:

• ArgumentNullExceptioncontrol is null.

OnErrorChanged(e)

Parameter	Type	Description
e	ErrorProviderErrorChangedEventArgs

OnRightToLeftChanged(e)

Fires the RightToLeftChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

SetError(control, value)

Sets the error description string for the specified control.

Parameter	Type	Description
control	Control	The control to set the error description string for.
value	String	The error description string, or null or Empty to remove the error.

Throws:

• ArgumentNullExceptioncontrol is null.

SetIconAlignment(control, value)

Sets the location where the error icon should be placed in relation to the control.

Parameter	Type	Description
control	Control	The control to set the icon location for.
value	ErrorIconAlignment	One of the ErrorIconAlignment values.

Throws:

• ArgumentNullExceptioncontrol is null.

SetIconPadding(control, value)

Sets the amount of extra space to leave between the specified control and the error icon.

Parameter	Type	Description
control	Control	The control to set the padding for.
value	Int32	The number of pixels to add between the icon and the control .

Throws:

• ArgumentNullExceptioncontrol is null.

UpdateBinding()

Updated the bindings.

Events

ErrorChanged

ErrorProviderErrorChangedHandler

RightToLeftChanged

EventHandler Fired when the RightToLeft property changes value.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IErrorProvider	Exposes a common api implemented by components that can collect errors in relation to a Control.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.