All pages
Powered by GitBook
1 of 15

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Extenders

ErrorBlinkStyle

Wisej.Web.ErrorBlinkStyle

Namespace: Wisej.Web

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

Name
Description

Used By

Name
Description

ErrorAnimationType

Wisej.Web.ErrorAnimationType

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public enum ErrorAnimationType : Enum
Public Enum ErrorAnimationType As [Enum]

Fields

Name
Description

Used By

Name
Description

ToolTipIcon

Wisej.Web.ToolTipIcon

Namespace: Wisej.Web

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

Name
Description

Used By

Name
Description

AnimationEventArgs

Wisej.Web.AnimationEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the or event of a extender.

ErrorIconAlignment

Wisej.Web.ErrorIconAlignment

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Fields

AnimationEventHandler

Wisej.Web.AnimationEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

Animation

Wisej.Web.Animation

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

AlwaysBlink

Always blink when the error icon is first displayed, or when a error description string is set for the control and the error icon is already displayed.

BlinkIfDifferentError

Blinks when the icon is already displayed and a new error string is set for the control.

NeverBlink

Never blink the error icon.

ErrorProvider.BlinkStyle

Returns or sets a value indicating when the error icon flashes.

Blink

Blink animation, the element appears and disappears.

Bounce

Bounce animation. The element bounces up and down.

None

No animation.

Tada

Tada animation. The element is zoomed, giggles and returns to its original size and location..

ErrorProvider.BlinkAnimation

Returns or sets a value indicating the type of animation to perform when the error icon blinks..

Default

Use the icon defined in the theme.

Error

An error icon.

Info

An information icon.

None

No icon.

Warning

A warning icon.

HelpTip.HelpTipIcon

Returns or sets a value that defines the type of icon to be displayed alongside the HelpTip text.

ToolTip.ToolTipIcon

Returns or sets a value that defines the type of icon to be displayed alongside the ToolTip text.

Properties

AnimationName

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

Target

Control: The target Control of the animation.

Used By

Name
Description

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

Start
End
Animation
Public Class AnimationEventArgs
    Inherits EventArgs
public class AnimationEventArgs : EventArgs
Name
Description

BottomLeft

The icon appears aligned with the bottom of the control and the left of the control.

BottomRight

The icon appears aligned with the bottom of the control and the right of the control.

MiddleLeft

The icon appears aligned with the middle of the control and the left of the control.

MiddleRight

The icon appears aligned with the middle of the control and the right of the control.

TopLeft

The icon appears aligned with the top of the control and to the left of the control.

TopRight

Used By

Name
Description

Returns or sets the default .

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

Public Enum ErrorIconAlignment As [Enum]
public enum ErrorIconAlignment : Enum
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

Fired when the animation begins.

Fired when the animation ends.

Start
End
Animation
Public Delegate Sub AnimationEventHandler(ByVal sender As [Object], ByVal e As AnimationEventArgs)
public delegate void AnimationEventHandler(Object sender, AnimationEventArgs e)

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 an IContainer implementation.

Name
Type
Description

container

An that represents the container of the extender.

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.

Methods

CanExtend(extendee)

Returns a value indicating whether a control can be extended.

Parameter
Type
Description

extendee

The control to be extended.

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

Clear()

Removes all animations.

GetAnimation(control)

Animation properties.

Parameter
Type
Description

control

The control to get the animation name for.

Returns: Properties. The name of the selected animation.

Throws:

  • ArgumentNullException control is null.

OnEnd(e)

Fires the End event.

Parameter
Type
Description

e

OnStart(e)

Fires the Start event.

Parameter
Type
Description

e

ResetAnimation(control)

Removes all the animation properties from the control .

Parameter
Type
Description

control

Control to remove from the extender.

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.

Parameter
Type
Description

control

The control to animate.

Events

End

AnimationEventHandler Fired when the animation ends.

Start

AnimationEventHandler Fired when the animation begins.

Implements

Name
Description

All wisej components implement this interface.

Allows an object to serialize itself.

Component
Component

The icon appears aligned with the top of the control and to the right of the control.

ErrorProvider.IconAlignment
ErrorIconAlignment
ErrorProvider.GetIconAlignment
Object
AnimationEventArgs
AnimationEventArgs
Animation.Start
Animation.End
AnimationEventHandler
Start
End
Animation
IContainer
IContainer
Animation
Object
Control
AnimationEventArgs
AnimationEventArgs
Control
Animation
Control
IWisejComponent
IWisejSerializable

StyleSheet

Wisej.Web.StyleSheet

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

  • Component

    • Component

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.

Name
Type
Description

Properties

Styles

: Returns or sets the CSS definitions managed by the extender.

StyleSheetSource

: Returns or set the source of the CSS file containing the CSS definitions managed by the extender.

Tag

: Returns or sets the object that contains programmer-supplied data associated with the extender.

Methods

CanExtend(target)

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

Parameter
Type
Description

Returns: . true if the 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.

Parameter
Type
Description

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

SetCssClass(control, cssClass)

Adds the CSS class name to the specified control.

Parameter
Type
Description

Implements

Name
Description

Rotation

Wisej.Web.Rotation

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

HelpTip

Wisej.Web.HelpTip

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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.

Name
Type
Description

container

An that represents the container of the extender.

Properties

Tag

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

Methods

CanExtend(target)

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

Parameter
Type
Description

target

The target object to add an extender property to.

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.

Parameter
Type
Description

control

The for which to retrieve the rotation properties.

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

ResetRotation(control)

Removes all the rotation properties from the control .

Parameter
Type
Description

control

Control to remove from the extender.

SetRotation(control, properties)

Assigns the rotation properties to the control.

Parameter
Type
Description

control

The control to rotate.

properties

An instance of defining the rotation style.

Implements

Name
Description

All wisej components implement this interface.

Defines the interface for extending properties to other components in a container.

Allows an object to serialize itself.

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.

Name
Type
Description

container

An that represents the container of the extender.

Properties

Active

Boolean: Returns or sets whether the HelpTip provider is currently active.

Alignment

Placement: Returns or sets the position of the HelpTip in relation to the target control.

AllowHtml

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

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.

BackColor

Color: Returns or sets the background color for the HelpTip.

ForeColor

Color: Returns or sets the foreground color for the HelpTip.

HelpTipIcon

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

InitialDelay

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

Tag

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

Methods

CanExtend(target)

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

Parameter
Type
Description

target

The target object to add an extender property to.

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.

Parameter
Type
Description

control

The for which to retrieve the text.

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

SetHelpTip(control, caption)

Associates HelpTip text with the specified control.

Parameter
Type
Description

control

The to associate the HelpTip text with.

caption

The HelpTip text to display when the pointer is on the control.

Implements

Name
Description

All wisej components implement this interface.

Allows an object to serialize itself.

Component
Component

container

IContainer

An IContainer that represents the container of the StyleSheet extender.

target

Object

The target object to add an extender property to.

control

Control

The Control for which to retrieve the CSS class name.

control

Control

The Control to add the CSS class name to.

cssClass

String

The CSS class name to add to the control.

IWisejComponent

All wisej components implement this interface.

IWisejExtenderProvider

Defines the interface for extending properties to other components in a container.

IWisejSerializable

Allows an object to serialize itself.

StyleSheet
Public Class StyleSheet
    Inherits Component
    Implements IWisejExtenderProvider, IExtenderProvider
StyleSheet
StyleSheet
String
String
Object
StyleSheet
Boolean
StyleSheet
String
public class StyleSheet : Component, IWisejExtenderProvider, IExtenderProvider

TabOrderManager

Wisej.Web.TabOrderManager

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides automatic tab order management to containers.

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.

Name
Type
Description

container

An that represents the container of the extender.

Methods

AssignTabOrder(container, direction, tabIndex, deep)

Updates the TabIndex of all the children controls.

Parameter
Type
Description

container

Container owning the children to update.

direction

One of indicating how to increase the tab index.

tabIndex

Starting tab index.

Returns: Int32.

Clear()

Removes all TabOrderManagerDirection values.

GetTabOrder(container)

Returns or sets the TabOrderManagerDirection assigned to the specified container.

Parameter
Type
Description

container

The container that will use the to automatically arrange the of its children.

Returns: TabOrderManagerDirection. One of the TabOrderManagerDirection values.

ResetTabOrder(container)

Resets the TabOrderManagerDirection assigned to the specified container .

Parameter
Type
Description

container

SetTabOrder(container, value)

Adds the TabOrderManagerDirection to the specified container.

Parameter
Type
Description

container

The container to assign the to.

value

New to assign to the 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.

Parameter
Type
Description

container

The that container the child control to update.

direction

The used to determine the new tabbing order.

Public Class TabOrderManager
    Inherits Component
    Implements IExtenderProvider
public class TabOrderManager : Component, IExtenderProvider
IContainer
IContainer
Rotation
Object
Control
Control
Control
Rotation
Control
Properties
Properties
IWisejComponent
IWisejExtenderProvider
IWisejSerializable
IContainer
IContainer
HelpTip
Object
Control
Control
HelpTip
Control
Control
String
IWisejComponent
IWisejSerializable

deep

Boolean

True to assign the tab index of all children at all levels.

IContainer
IContainer
JavaScript
Control
TabOrderManagerDirection
TabOrderManagerDirection
Int32
Control
TabOrderManager
TabIndex
Control
Control
TabOrderManagerDirection
TabOrderManagerDirection
TabOrderManagerDirection
Control
Control
TabOrderManagerDirection
TabOrderManagerDirection

ToolTip

Wisej.Web.ToolTip

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

  • Component

    • Component

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.

Name
Type
Description

Properties

Active

: Returns or sets whether the ToolTip provider is currently active.

Alignment

: Returns or sets the alignment side and position of the tooltips.

AllowHtml

: Returns or sets a value indicating that the control can display HTML in the Text property.

AutomaticDelay

: Returns or sets the automatic delay for the ToolTip.

AutoPopDelay

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

ForeColor

: Returns or sets the text color of the ToolTip.

InitialDelay

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

Tag

: Returns or sets the object that contains programmer-supplied data associated with the .

ToolTipIcon

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

ToolTipIconSource

: Returns or sets the icon name or URL to use as the ToolTip icon.

Methods

CanExtend(target)

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

Parameter
Type
Description

Returns: . true if the 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.

Parameter
Type
Description

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

SetToolTip(control, caption)

Associates ToolTip text with the specified control.

Parameter
Type
Description

Show(target, text)

Shows the tooltip net to the target component.

Parameter
Type
Description

Show(text, x, y)

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

Parameter
Type
Description

Show(text, location)

Shows the tooltip at the specified location .

Parameter
Type
Description

Implements

Name
Description

container

IContainer

An IContainer that represents the container of the ToolTip extender.

target

Object

The target object to add an extender property to.

control

Control

The Control for which to retrieve the ToolTip text.

control

Control

The Control to associate the ToolTip text with.

caption

String

The ToolTip text to display when the pointer is on the control.

target

IWisejComponent

A Wisej control or component (i.e. column, header).

text

String

Text to show in the tooltip.

text

String

Text to show in the tooltip.

x

Int32

y

Int32

text

String

Text to show in the tooltip.

location

Point

Location of the tooltip in screen coordinates.

IWisejComponent

All wisej components implement this interface.

IWisejSerializable

Allows an object to serialize itself.

ToolTip
Public Class ToolTip
    Inherits Component
    Implements IExtenderProvider
ToolTip
ToolTip
Boolean
Nullable<Placement>
Boolean
Int32
Int32
Color
Int32
Object
ToolTip
ToolTipIcon
String
Boolean
ToolTip
String
String
public class ToolTip : Component, IExtenderProvider

JavaScript

Wisej.Web.JavaScript

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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.

Name
Type
Description

container

An that represents the container of the extender.

Properties

Tag

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

Methods

CanExtend(target)

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

Parameter
Type
Description

target

The target object to add an extender property to.

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.

Parameter
Type
Description

control

The for which to retrieve the JavaScript code.

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.

Parameter
Type
Description

control

The to attach the JavaScript event handlers to.

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.

Parameter
Type
Description

control

The for which to retrieve the JavaScript file.

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.

Parameter
Type
Description

control

The to associate the JavaScript with.

script

The JavaScript code to execute when the control is created.

SetJavaScriptSource(control, file)

Associates JavaScript file with the specified control.

Parameter
Type
Description

control

The to associate the JavaScript file with.

file

The JavaScript file to execute when the control is created.

Implements

Name
Description

All wisej components implement this interface.

Allows an object to serialize itself.

Component
Component
IContainer
IContainer
JavaScript
Object
Control
Control
Control
Control
Control
Control
Control
Control
String
Control
Control
String
IWisejComponent
IWisejSerializable

ErrorProvider

Wisej.Web.ErrorProvider

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

  • Component

    • Component

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

Constructors

ErrorProvider()

Initializes a new instance of the class and initializes the default settings for , , and the .

ErrorProvider(containerControl)

Initializes a new instance of the class attached to a .

Name
Type
Description

ErrorProvider(container)

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

Name
Type
Description

Properties

AllowHtml

: Returns or sets a value indicating that the control can display HTML in the ErrorMessage property.

BlinkAnimation

: Returns or sets a value indicating the type of animation to perform when the error icon blinks..

BlinkRate

: Returns or sets the rate at which the error icon flashes.

Throws:

  • The value is less than zero.

BlinkStyle

: Returns or sets a value indicating when the error icon flashes.

ContainerControl

: Returns or sets the parent control for this .

DataMember

: Returns or sets the list within a data source to monitor for errors.

DataSource

: Returns or sets the data source that the monitors for errors.

HasErrors

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

Icon

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

Throws:

  • The assigned value of the is null.

IconAlignment

: Returns or sets the default .

IconPadding

: Returns or sets the default .

IconSource

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

  • The assigned value of the is null.

RightToLeft

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

Tag

: Returns or sets an object that contains data about the component.

Methods

BindToDataAndErrors(dataSource, dataMember)

Sets the and properties.

Parameter
Type
Description

CanExtend(extendee)

Returns a value indicating whether a control can be extended.

Parameter
Type
Description

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

Clear()

Clears all error providers.

GetError(control)

Returns the current error description string for the specified control.

Parameter
Type
Description

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

Throws:

  • control is null.

GetIconAlignment(control)

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

Parameter
Type
Description

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

Throws:

  • control is null.

GetIconPadding(control)

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

Parameter
Type
Description

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

Throws:

  • control is null.

SetError(control, value)

Sets the error description string for the specified control.

Parameter
Type
Description

Throws:

  • control is null.

SetIconAlignment(control, value)

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

Parameter
Type
Description

Throws:

  • control is null.

SetIconPadding(control, value)

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

Parameter
Type
Description

Throws:

  • control is null.

UpdateBinding()

Updated the bindings.

Events

RightToLeftChanged

Fired when the property changes value.

Implements

Name
Description

containerControl

ContainerControl

The ContainerControl to monitor for errors.

container

IContainer

An IContainer that represents the container of the ErrorProvider extender.

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.

extendee

Object

The control to be extended.

control

Control

The item to get the error description string for.

control

Control

The control to get the icon location for.

control

Control

The control to get the padding for.

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.

control

Control

The control to set the icon location for.

value

ErrorIconAlignment

One of the ErrorIconAlignment values.

control

Control

The control to set the padding for.

value

Int32

The number of pixels to add between the icon and the control .

IWisejComponent

All wisej components implement this interface.

IWisejSerializable

Allows an object to serialize itself.

ErrorProvider
Public Class ErrorProvider
    Inherits Component
    Implements IExtenderProvider, ISupportInitialize
ErrorProvider
BlinkRate
BlinkStyle
Icon
ErrorProvider
ContainerControl
ErrorProvider
IContainer
Boolean
ErrorAnimationType
Int32
ArgumentOutOfRangeException
ErrorBlinkStyle
ContainerControl
ErrorProvider
String
Object
ErrorProvider
Boolean
Image
Image
ArgumentNullException
Image
ErrorIconAlignment
ErrorIconAlignment
Int32
ErrorIconAlignment
String
ArgumentNullException
Image
Boolean
Object
DataSource
DataMember
Boolean
Control
Form
ToolBar
String
ArgumentNullException
ErrorIconAlignment
ErrorIconAlignment
MiddleRight
ArgumentNullException
Int32
ArgumentNullException
ArgumentNullException
ArgumentNullException
ArgumentNullException
EventHandler
RightToLeft
public class ErrorProvider : Component, IExtenderProvider, ISupportInitialize