Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• Component

  • Component

    • Animation

Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.

public class Animation : Component, IExtenderProvider

Public Class Animation
    Inherits Component
    Implements IExtenderProvider

Constructors

Animation()

Initializes a new instance of the Animation class.

Animation(container)

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

Properties

List<String>: Manages a collection of used defined animation definitions.

Object: Returns or sets the object that contains programmer-supplied data associated with this component. (Default: null)

Methods

Returns a value indicating whether a control can be extended.

Returns: Boolean. true if the control can be extended; otherwise, false.

Removes all animations.

Animation properties.

Returns: Properties. The name of the selected animation.

Throws:

• ArgumentNullException control is null.

Fires the End event.

Fires the Start event.

Removes all the animation properties from the control .

Runs the animation of the specified Control immediately. If the control doesn't have a configured animation this method doesn't do anything.

Events

AnimationEventHandler Fired when the animation ends.

AnimationEventHandler Fired when the animation begins.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Specifies the type of animation to apply to the error provider.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the or event of a extender.

Properties

AnimationName

: Returns the name of the animation that has fired the event.

Target

: The target of the animation.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Specifies the speed curve of an animation.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Defines the animation properties.

Constructors

Properties()

Creates a new instance of the animation properties.

Properties

Delay

: Returns or sets the delay before the animation starts in milliseconds. (Default: 0)

Duration

: Returns or sets the duration of the animation in milliseconds. (Default: 0)

0 = Default. The animation is executed within the duration defined in the animation definition.

-1 = Keeps the default frame as configured in the animation definition.

-1 = Infinite. 0 = Default; the animation is repeated the number of times defined in the animation definition.

Methods

Runs the animation on the connected component immediately.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Specifies constants indicating when the error icon, supplied by an ErrorProvider, should blink to alert the user that an error has occurred.

public enum ErrorBlinkStyle : Enum

Public Enum ErrorBlinkStyle As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the ErrorChanged event.

public delegate void ErrorProviderErrorChangedHandler(Object sender, ErrorProviderErrorChangedEventArgs e)

Public Delegate Sub ErrorProviderErrorChangedHandler(ByVal sender As [Object], ByVal e As ErrorProviderErrorChangedEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

public class ErrorProviderErrorChangedEventArgs : CancelEventArgs

Public Class ErrorProviderErrorChangedEventArgs
    Inherits CancelEventArgs

Constructors

ErrorProviderErrorChangedEventArgs(control, error)

Initializes a new instance of ErrorProviderErrorChangedEventArgs.

Throws:

• ArgumentNullException control is null.

Properties

Control

Control: Controls being notified of an error.

Error

String: Returns or sets the error message related to Control.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the Start or End event of a Animation extender.

public delegate void AnimationEventHandler(Object sender, AnimationEventArgs e)

Public Delegate Sub AnimationEventHandler(ByVal sender As [Object], ByVal e As AnimationEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• Component

  • Component

    • ErrorProvider

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

public class ErrorProvider : Component, IExtenderProvider, ISupportInitialize, IErrorProvider

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.

ErrorProvider(container)

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

Properties

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

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

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

Throws:

• ArgumentOutOfRangeException The value is less than zero.

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

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

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

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

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

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.

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

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

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.

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

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

Methods

Sets the DataSource and DataMember properties.

Returns a value indicating whether a control can 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.

Clears all error providers.

Returns the current error description string for the specified control.

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

Throws:

• ArgumentNullException control is null.

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

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

Throws:

• ArgumentNullException control is null.

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

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

Throws:

• ArgumentNullException control is null.

Sets the error description string for the specified control.

Throws:

• ArgumentNullException control is null.

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

Throws:

• ArgumentNullException control is null.

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

Throws:

• ArgumentNullException control is null.

Updated the bindings.

Events

ErrorProviderErrorChangedHandler

EventHandler Fired when the RightToLeft property changes value.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).

Constructors

HelpTip()

Initializes a new instance of the without a specified container.

HelpTip(container)

Initializes a new instance of the class with a specified container.

Properties

Methods

Returns true if the HelpTip can offer an extender property to the specified target component.

Removes all HelpTip text currently associated with the HelpTip component.

Retrieves the HelpTip text associated with the specified control.

Associates HelpTip text with the specified control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Specifies constants indicating the locations that an error icon can appear in relation to the control with an error.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Add rotation capabilities along the X,Y,Z axis to controls.

Constructors

Rotation()

Initializes a new instance of the extender without a specified container.

Rotation(container)

Initializes a new instance of the extender with a specified container.

Properties

Methods

Removes all rotation properties.

Rotation properties.

Removes all the rotation properties from the control .

Assigns the rotation properties to the control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Adds CSS styling to controls.

Constructors

StyleSheet()

Initializes a new instance of the without a specified container.

StyleSheet(container)

Initializes a new instance of the class with a specified container.

Properties

Methods

Returns true if the StyleSheet extender can offer an extender property to the specified target component.

Removes all css classes.

Retrieves the CSS class name associated with the specified control.

Adds the CSS class name to the specified control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a collection of JavaScript events and their corresponding handler code.

public class ClientEventCollection : IList, ICollection, IEnumerable, IList<ClientEvent>, ICollection<ClientEvent>, IEnumerable<ClientEvent>

Public Class ClientEventCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of ClientEvent), ICollection(Of ClientEvent), IEnumerable(Of ClientEvent)

Constructors

ClientEventCollection()

Initializes a new instance of ClientEventCollection.

Properties

Count

Int32: Returns the number of items in the collection.

Item(index)

ClientEvent: Returns the ClientEvent element at the specified index .

Methods

Adds the ClientEvent instance to the collection.

Removes all the ClientEvent items from the collection.

Checks whether the specified item exists in the collection.

Returns: Boolean. True of the collection contains the specified item .

Returns the position of the specified item in the collection.

Returns: Int32. The index of the specified item or -1 if not found.

Inserts the item into the collection at the specified index .

Removes the item from the collection.

Returns: Boolean. True of the specified item was found and removed from the collection.

Removes the ClientEvent item at the location index .

Events

CollectionChangeEventHandler Fired when the collection has changed.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Defines a set of standardized icons that can be associated with a ToolTip.

public enum ToolTipIcon : Enum

Public Enum ToolTipIcon As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• Component

  • Component

    • JavaScript

Allows controls to execute javascript code.

public class JavaScript : Component, IExtenderProvider

Public Class JavaScript
    Inherits Component
    Implements IExtenderProvider

Constructors

JavaScript()

Initializes a new instance of the JavaScript without a specified container.

JavaScript(container)

Initializes a new instance of the JavaScript class with a specified container.

Properties

Object: Returns or sets the object that contains programmer-supplied data associated with the JavaScript extender. (Default: null)

Methods

Returns true if the JavaScript extender can offer an extender property to the specified target component.

Returns: Boolean. true if the JavaScript class can offer one or more extender properties; otherwise, false.

Removes all scripts.

Retrieves the JavaScript code associated with the specified control. The JavaScript code will be execute on the client when the control is created or refreshed.

Returns: String. A String containing the javascript code for the specified control.

Returns the collection of JavaScript event handlers associated with the control.

Returns: ClientEventCollection.

Retrieves the JavaScript file associated with the specified control. The JavaScript code will be execute on the client when the control is created or refreshed.

Returns: String. A String containing the name of the javascript file for the specified control.

Associates JavaScript code with the specified control.

Associates JavaScript file with the specified control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Adds a common validation system to any Control.

public class Validation : Component, IExtenderProvider

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.

Properties

ContainerControl

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

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

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

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.

Object: Returns or sets the object that contains programmer-supplied data associated with the Validation extender. (Default: null)

Methods

Sets the DataSource and DataMember properties.

Returns a value indicating whether a control can be extended.

Returns: Boolean. true if the control can be extended; otherwise, false.

Removes all validation rules.

Returns the collection of ValidationRule associated with the specified control .

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

Fires the Validated event.

Fires the Validating event.

Removes all the validation rules from the control .

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

Updated the bindings.

Events

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.

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.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represent a JavaScript event and the corresponding code to execute on the client when the event is fired.

public class ClientEvent

Public Class ClientEvent

Constructors

ClientEvent()

Initializes a new instance of ClientEvent.

Properties

Event

String: Returns or sets the name of the event. Not all events are available to all controls, which events are fired depends on the widget that corresponds to the control. (Default: null)

JavaScript

String: Returns or sets the JavaScript handler for the event. (Default: "")

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides automatic tab order management to containers.

public class TabOrderManager : Component, IExtenderProvider

Public Class TabOrderManager
    Inherits Component
    Implements IExtenderProvider

Constructors

TabOrderManager()

Initializes a new instance of the TabOrderManager without a specified container.

TabOrderManager(container)

Initializes a new instance of the TabOrderManager class with a specified container.

Methods

AssignTabOrder(container, direction, tabIndex, deep)

Updates the TabIndex of all the children controls.

Returns: Int32.

Removes all TabOrderManagerDirection values.

Returns or sets the TabOrderManagerDirection assigned to the specified container.

Returns: TabOrderManagerDirection. One of the TabOrderManagerDirection values.

Resets the TabOrderManagerDirection assigned to the specified container .

Adds the TabOrderManagerDirection to the specified container.

Updates the tab order of the top container and all its child containers.

Updates the TabIndex of all children controls using the specified TabOrderManagerDirection to calculate the tabbing order.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• ValidationRule

  • EmailValidationRule

Validates email addresses.

public class EmailValidationRule : ValidationRule

Public Class EmailValidationRule
    Inherits ValidationRule

Constructors

EmailValidationRule()

Initializes a new instance of EmailValidationRule.

Properties

InvalidDomains

String[]: Returns or sets a list of invalid domains: i.e. "dropmail.com", "protonmail.com". (Default: null)

Name

String: Returns or sets the name of the validation rule. (Default: "Email")

Boolean: Returns or sets whether the control can be empty or its required to have a value. (Default: False)

String[]: Returns or sets a list of valid domains: i.e. "mycompany.com", "gmail.com", "hotmail.com". (Default: null)

Methods

Validates the control using the validation rule.

Returns: Boolean. true if the validation is successful; otherwise false.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• ValidationRule

  • DecimalValidationRule

Validates decimal values.

public class DecimalValidationRule : ValidationRule

Public Class DecimalValidationRule
    Inherits ValidationRule

Constructors

DecimalValidationRule()

Initializes a new instance of the DecimalValidationRule class.

Properties

DecimalDigits

Nullable<Int32>: Returns or sets the required number of decimal digits; or null to allow any number of decimals. (Default: null)

Format

Boolean: Returns or sets whether to format the value of the control after validation. (Default: False)

Nullable<Decimal>: Returns or sets the maximum value; or null for no maximum. (Default: null)

Nullable<Decimal>: Returns or sets the minimum value; or null for no minimum. (Default: null)

String: Returns or sets the name of the validation rule. (Default: "Decimal")

Boolean: Returns or sets whether the control can be empty or its required to have a value. (Default: False)

Methods

Invoked after the control has been successfully validated.

Validates the control using the validation rule.

Returns: Boolean. true if the validation is successful; otherwise false.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• ValidationRule

  • CurrencyValidationRule

Validates currency values.

public class CurrencyValidationRule : ValidationRule

Public Class CurrencyValidationRule
    Inherits ValidationRule

Constructors

CurrencyValidationRule()

Initializes a new instance of the CurrencyValidationRule class.

Properties

CurrencySymbol

String: Returns or sets the currency symbol to validate. The default is null to use the current CurrencySymbol. (Default: null)

DecimalDigits

Nullable<Int32>: Returns or sets the required number of decimal digits; or null to use the current CurrencyDecimalDigits. (Default: null)

Boolean: Returns or sets whether to format the value of the control after validation. (Default: False)

Nullable<Decimal>: Returns or sets the maximum value; or null for no maximum. (Default: null)

Nullable<Decimal>: Returns or sets the minimum value; or null for no minimum. (Default: null)

String: Returns or sets the name of the validation rule. (Default: "Currency")

Boolean: Returns or sets whether the control can be empty or its required to have a value. (Default: False)

Methods

Invoked after the control has been successfully validated.

Validates the control using the validation rule.

Returns: Boolean. true if the validation is successful; otherwise false.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event handlers.

Properties

Control

: Control being validated.

InvalidMessage

: Message to return when validation fails.

Rules

: Rules associated to the being validated.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Validates the control using a custom expression.

Constructors

RegexValidationRule()

Initializes a new instance of .

Properties

FilterExpression

: Returns or sets the filter property (i.e. ) property on editable controls that support filtering of the keys as they are typed. (Default: null)

Name

Methods

Invoked when the control associated with the validation rule is created and ready to be rendered on the client.

Validates the control using the validation rule.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.

Constructors

ToolTip()

Initializes a new instance of the without a specified container.

ToolTip(container)

Initializes a new instance of the class with a specified container.

Properties

Methods

Returns true if the ToolTip can offer an extender property to the specified target component.

Removes all ToolTip text currently associated with the ToolTip component.

Retrieves the ToolTip text associated with the specified control.

Associates ToolTip text with the specified control.

Shows the tooltip net to the target component.

Shows the tooltip at the specified x and y screen coordinates.

Shows the tooltip at the specified location .

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Validates long integer values.

Constructors

IntegerValidationRule()

Initializes a new instance of the class.

Properties

MaximumValue

: Returns or sets the maximum value; or null for no maximum. (Default: null)

MinimumValue

Methods

Validates the control using the validation rule.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the set of CSS3 rotation properties.

Constructors

Properties()

Creates a new instance of the rotation properties.

Properties

Enabled

: Enables or disables the rotation. (Default: True)

HideBackface

: Hides the backside of a rotated component. (Default: False)

Origin

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Validates controls that cannot be left empty.

Constructors

RequiredValidationRule()

Initializes a new instance of the class.

Properties

MinimumLength

: Returns or sets the required minimum number of characters. (Default: null)

Name

Methods

Validates the control using the validation rule.