Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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

CustomAnimations

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

Tag

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

Methods

CanExtend(extendee)

Returns a value indicating whether a control can be extended.

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

Clear()

Removes all animations.

GetAnimation(control)

Animation properties.

Returns: Properties. The name of the selected animation.

Throws:

• ArgumentNullException control is null.

OnEnd(e)

Fires the End event.

OnStart(e)

Fires the Start event.

ResetAnimation(control)

Removes all the animation properties from the control .

Run(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

End

AnimationEventHandler Fired when the animation ends.

Start

AnimationEventHandler Fired when the animation begins.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Defines the animation properties.

public class Properties

Public Class Properties

Constructors

Properties()

Creates a new instance of the animation properties.

Properties

Delay

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

Duration

Int32: 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.

Event

String: Returns or sets the animation trigger event. (Default: "")

Keep

Int32: Returns or sets the frame to keep when the animation ends. (Default: -1)

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

Name

String: Returns or sets the name of the selected animation. (Default: "")

Repeat

Int32: Returns or sets the number of times to repeat the animation. (Default: 0)

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

Reverse

Boolean: Returns or sets whether the animation should be executed in reverse order. (Default: False)

Timing

AnimationTiming: Returns or sets the speed curve of an animation. (Default: Default)

Methods

Run()

Runs the animation on the connected component immediately.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Provides data for the Start or End event of a Animation extender.

public class AnimationEventArgs : EventArgs

Public Class AnimationEventArgs
    Inherits EventArgs

Properties

AnimationName

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

Target

Control: The target Control of the animation.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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.1.0.0)

Specifies the speed curve of an animation.

public enum AnimationTiming : Enum

Public Enum AnimationTiming As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

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

public enum ErrorAnimationType : Enum

Public Enum ErrorAnimationType As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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.1.0.0)

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

public enum ErrorIconAlignment : Enum

Public Enum ErrorIconAlignment As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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

Public Class ErrorProvider
    Inherits Component
    Implements IExtenderProvider, ISupportInitialize

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

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

ContainerControl: Returns or sets the parent control for this ErrorProvider. (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.

CanExtend(extendee)

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.

Clear()

Clears all error providers.

GetError(control)

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.

GetIconAlignment(control)

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.

GetIconPadding(control)

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.

SetError(control, value)

Sets the error description string for the specified control.

Throws:

• ArgumentNullException control is null.

SetIconAlignment(control, value)

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

Throws:

• ArgumentNullException control is null.

SetIconPadding(control, value)

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

Throws:

• ArgumentNullException control is null.

UpdateBinding()

Updated the bindings.

Events

RightToLeftChanged

EventHandler Fired when the RightToLeft property changes value.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

• Component

  • Component

    • HelpTip

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

public class HelpTip : Component, IExtenderProvider

Public Class HelpTip
    Inherits Component
    Implements IExtenderProvider

Constructors

HelpTip()

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

HelpTip(container)

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

Properties

Active

Boolean: Returns or sets whether the HelpTip provider is currently active. (Default: True)

Alignment

Placement: Returns or sets the position of the HelpTip in relation to the target control. (Default: RightMiddle)

AllowHtml

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

AutoPopDelay

Int32: Returns or sets the period of time the HelpTip remains visible if the pointer is stationary on a control with specified HelpTip text. (Default: 0)

BackColor

Color: Returns or sets the background color for the HelpTip. (Default: Color [Empty])

ForeColor

Color: Returns or sets the foreground color for the HelpTip. (Default: Color [Empty])

HelpTipIcon

ToolTipIcon: Returns or sets a value that defines the type of icon to be displayed alongside the HelpTip text. (Default: Default)

InitialDelay

Int32: Returns or sets the time that passes before the HelpTip appears. (Default: 0)

Tag

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

Methods

CanExtend(target)

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

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

Clear()

Removes all HelpTip text currently associated with the HelpTip component.

GetHelpTip(control)

Retrieves the HelpTip text associated with the specified control.

Returns: String. A String containing the HelpTip text for the specified control.

SetHelpTip(control, caption)

Associates HelpTip text with the specified control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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

Tag

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

Methods

CanExtend(target)

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.

Clear()

Removes all scripts.

GetJavaScript(control)

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.

GetJavaScriptEvents(control)

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

Returns: ClientEventCollection.

GetJavaScriptSource(control)

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.

SetJavaScript(control, script)

Associates JavaScript code with the specified control.

SetJavaScriptSource(control, file)

Associates JavaScript file with the specified control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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()

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.1.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()

Properties

Count

Int32: Returns the number of items in the collection.

Item(index)

ClientEvent: Returns the ClientEvent element at the specified index .

Methods

Add(item)

Adds the ClientEvent instance to the collection.

Clear()

Removes all the ClientEvent items from the collection.

Contains(item)

Checks whether the specified item exists in the collection.

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

IndexOf(item)

Returns the position of the specified item in the collection.

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

Insert(index, item)

Inserts the item into the collection at the specified index .

Remove(item)

Removes the item from the collection.

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

RemoveAt(index)

Removes the ClientEvent item at the location index .

Events

CollectionChanged

CollectionChangeEventHandler Fired when the collection has changed.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

• Component

  • Component

    • Rotation

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

public class Rotation : Component, IWisejExtenderProvider, IExtenderProvider

Public Class Rotation
    Inherits Component
    Implements IWisejExtenderProvider, IExtenderProvider

Constructors

Rotation()

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

Rotation(container)

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

Properties

Tag

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

Methods

CanExtend(target)

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

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

Clear()

Removes all rotation properties.

GetRotation(control)

Rotation properties.

Returns: Properties. A Properties instance with the rotation properties.

ResetRotation(control)

Removes all the rotation properties from the control .

SetRotation(control, properties)

Assigns the rotation properties to the control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the set of CSS3 rotation properties.

public class Properties

Public Class Properties

Constructors

Properties()

Creates a new instance of the rotation properties.

Properties

Enabled

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

HideBackface

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

Origin

String: Changes the position of transformed elements by setting the location of the rotation fulcrum in relation to the widget. If left empty, the default is 50% 50%, the center of the control. (Default: "")

Perspective

Int32: Defines a perspective view for a 3D transformed element. (Default: 0)

RotateX

Int32: Defines a 3D rotation along the X-axis. (Default: 0)

RotateY

Int32: Defines a 3D rotation along the Y-axis. (Default: 0)

RotateZ

Int32: Defines a 3D rotation along the Z-axis. (Default: 0)

ScaleX

Int32: Defines a 3D scale (%) transformation by giving a value for the X-axis. (Default: 100)

ScaleY

Int32: Defines a 3D scale (%) transformation by giving a value for the Y-axis. (Default: 100)

ScaleZ

Int32: Defines a 3D scale (%) transformation by giving a value for the Z-axis. (Default: 100)

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

• Component

  • Component

    • StyleSheet

Adds CSS styling to controls.

public class StyleSheet : Component, IWisejExtenderProvider, IExtenderProvider

Public Class StyleSheet
    Inherits Component
    Implements IWisejExtenderProvider, IExtenderProvider

Constructors

StyleSheet()

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

StyleSheet(container)

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

Properties

Styles

String: Returns or sets the CSS definitions managed by the extender. (Default: "")

StyleSheetSource

String: Returns or set the source of the CSS file containing the CSS definitions managed by the extender. (Default: "")

Tag

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

Methods

CanExtend(target)

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

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

Clear()

Removes all css classes.

GetCssClass(control)

Retrieves the CSS class name associated with the specified control.

Returns: String. The CSS class name added to the specified control.

SetCssClass(control, cssClass)

Adds the CSS class name to the specified control.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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.

Clear()

Removes all TabOrderManagerDirection values.

GetTabOrder(container)

Returns or sets the TabOrderManagerDirection assigned to the specified container.

Returns: TabOrderManagerDirection. One of the TabOrderManagerDirection values.

ResetTabOrder(container)

Resets the TabOrderManagerDirection assigned to the specified container .

SetTabOrder(container, value)

Adds the TabOrderManagerDirection to the specified container.

UpdateTabOrder()

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

UpdateTabOrder(container, direction)

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

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

• Component

  • Component

    • ToolTip

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.

public class ToolTip : Component, IExtenderProvider

Public Class ToolTip
    Inherits Component
    Implements IExtenderProvider

Constructors

ToolTip()

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

ToolTip(container)

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

Properties

Active

Boolean: Returns or sets whether the ToolTip provider is currently active. (Default: True)

Alignment

Nullable<Placement>: Returns or sets the alignment side and position of the tooltips. (Default: null)

AllowHtml

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

AutomaticDelay

Int32: Returns or sets the automatic delay for the ToolTip. (Default: 500)

AutoPopDelay

Int32: Returns or sets the period of time the ToolTip remains visible if the pointer is stationary on a control with specified ToolTip text.

ForeColor

Color: Returns or sets the text color of the ToolTip. (Default: Color [Empty])

InitialDelay

Int32: Returns or sets the time that passes before the ToolTip appears.

Tag

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

ToolTipIcon

ToolTipIcon: Returns or sets a value that defines the type of icon to be displayed alongside the ToolTip text. (Default: Default)

ToolTipIconSource

String: Returns or sets the icon name or URL to use as the ToolTip icon. (Default: null)

Methods

CanExtend(target)

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

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

Clear()

Removes all ToolTip text currently associated with the ToolTip component.

GetToolTip(control)

Retrieves the ToolTip text associated with the specified control.

Returns: String. A String containing the ToolTip text for the specified control.

SetToolTip(control, caption)

Associates ToolTip text with the specified control.

Show(target, text)

Shows the tooltip net to the target component.

Show(text, x, y)

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

Show(text, location)

Shows the tooltip at the specified location .

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.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