Validation

Wisej.Web.Validation

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Adds a common validation system to any Control.

C#

public class Validation : Component, IExtenderProvider

VB.NET

Public Class Validation
    Inherits Component
    Implements IExtenderProvider

You can drop this extender on any design surface to add validation rules to any control at design time using the added ValidationRules property. You can also use this component at runtime and invoke the SetValidationRules method directly. Validation rules are executed in the order they are added to the array. When a validation rule fails validation, the next rules are NOT executed and the Cancel property of the control's Validating event is set to true.

Constructors

Validation()

Initializes a new instance of the Validation class.

Validation(container)

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

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

Properties

ContainerControl

ContainerControl: 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 Validation extender monitors for errors. (Default: null)

ErrorProvider

IErrorProvider: Associates an IErrorProvider to the Validation extender."/> (Default: null)

When this property is null (default), the validation extender sets the InvalidMessage property of the control being validated to the corresponding InvalidMessage when a validation rule fails. Otherwise it invokes the SetError method passing the control that failed validation and the corresponding InvalidMessage string. You may use an instance of ErrorProvider to display error icons and messages. But you can also implement the IErrorProvider interface in a custom class and manage errors however required by the application. A third option is to assign a Label (or any Control that implements IErrorProvider) to the ErrorProvider property to let the validation extender set the text property to the corresponding InvalidMessage string.

The Label (or any Control that implements IErrorProvider) is automatically hidden (Visible is set to false) when there is no error message to display.

Tag

Object: Returns or sets the object that contains programmer-supplied data associated with the Validation extender. (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.

Clear()

Removes all validation rules.

GetValidationRules(control)

Returns the collection of ValidationRule associated with the specified control .

Parameter	Type	Description
control	Control	Control associated with the validation rules to retrieve.

Returns: ValidationRule[]. Array of the validation rules associated to the control .

OnValidated(e)

Fires the Validated event.

Parameter	Type	Description
e	ValidationEventArgs

OnValidating(e)

Fires the Validating event.

Parameter	Type	Description
e	ValidationEventArgs

ResetValidationRules(control)

Removes all the validation rules from the control .

Parameter	Type	Description
control	Control	Control to remove from the Validation extender.

SetValidationRules(control, rules)

Sets the list of validation rules associated with the specified control .

Parameter	Type	Description
control	Control	Control associated with the validation rules.
rules	ValidationRule[]	List of validation rules to enforce on the specified control .

UpdateBinding()

Updated the bindings.

Events

Validated

ValidationEventHandler Fired after any control associated to the Validation extender has been successfully validated.

You can add an handler to this event and handle the successful validation of all the controls that have a set of validation rules in one place.

Validating

ValidationEventHandler Fired when the any control associated to the Validation extender is being validated.

You can add an handler to this event and handle the validation of all the controls that have a set of validation rules in one place.