Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This book covers the full API for the Wisej.Framework assembly only. For an in-depth guide of Wisej features, please refer to the Concepts book. For the extensions API and concepts, please refer to the Extensions book.
Instance method, or property, or event.
Static method or property or event.
Protected method or property or event.
Deprecated method or property or event.
This is the API book, for the concepts documentation please refer to the link below. The concept documentation and the namespace reference are a never-ending work in progress. We update it almost daily. Please check back if what you are looking for is not available.
We assume that you have a good working knowledge of the following tools and technologies:
C# or VB.NET
.NET in general
Visual Studio
JavaScript
Wisej.Web.Application PageCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Holds the collection of all top-level application pages.
: Returns the total number of currently open pages.
: Returns the page at the specified index.
: Returns the first page with the specified name, the search is case insensitive.
Returns an enumerator that iterates through the open pages.
Returns: .
Wisej.Web.HashChangedEventArgs
sender
The source of the event.
hlpevent
A HelpEventArgs object that contains the event data.
Fired when the user requests help for a control by pressing F1.
Public Delegate Sub HelpEventHandler(ByVal sender As [Object], ByVal hlpevent As HelpEventArgs)value
Initial hash value.
Represents the method that will handle the HashChanged event.
Public Class HashChangedEventArgs
Inherits EventArgsPublic Class PageCollection
Inherits ICollection
Implements IEnumerableWisej.Web.ResponsiveProfileChangedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the ResponsiveProfileChanged event.
Public Class ResponsiveProfileChangedEventArgs
Inherits EventArgsInitializes a new instance of the ResponsiveProfileChangedEventArgs class.
oldValue
Previous .
newValue
New active .
ClientProfile: The new active profile.
ClientProfile: The previously active profile.
Represents the method that will handle the Application.ResponsiveProfileChanged event.
Wisej.Web.HelpEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the HelpRequested event.
Public Class HelpEventArgs
Inherits EventArgsInitializes a new instance of the HelpEventArgs class.
target
The that had the focus when the user pressed F1.
Boolean: Returns or sets a value indicating whether the help event was handled.
Control: Returns the Control that had the focus when the user pressed F1.
Represents the method that will handle the event of a .
Wisej.Web.ControlEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the ControlAdded and ControlRemoved events of the Control class.
Public Delegate Sub ControlEventHandler(ByVal sender As [Object], ByVal e As ControlEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when a multiple-document interface (MDI) child form is added to the mdi parent.
Fired when a multiple-document interface (MDI) child form is removed from the mdi parent.
Wisej.Web.ControlEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the ControlAdded and ControlRemoved events.
Public Class ControlEventArgs
Inherits EventArgsInitializes a new instance of the ControlEventArgs class for the specified control.
control
The to store in this event.
Control: Returns the control object used by this event.
Represents the method that will handle the and events of the class.
Wisej.Web.ResponsiveProfileChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the Application.ResponsiveProfileChanged event.
Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when the active responsive profile is changed.
Fired when the active responsive profile is changed.
Wisej.Web.KeyPressEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the event.
Initializes a new instance of the class.
: Returns or sets whether the event was handled.
: Returns or sets the character corresponding to the key pressed.
public delegate void HelpEventHandler(Object sender, HelpEventArgs hlpevent)public delegate void ControlEventHandler(Object sender, ControlEventArgs e)public delegate void ResponsiveProfileChangedEventHandler(Object sender, ResponsiveProfileChangedEventArgs e)sender
The source of the event.
e
A PinchEventArgs that contains the event data.
Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch.
Public Delegate Sub PinchEventHandler(ByVal sender As [Object], ByVal e As PinchEventArgs)public delegate void PinchEventHandler(Object sender, PinchEventArgs e)keyChar
The ASCII character corresponding to the key the user pressed.
Public Class KeyPressEventArgs
Inherits EventArgspublic class KeyPressEventArgs : EventArgspublic class ResponsiveProfileChangedEventArgs : EventArgspublic class HelpEventArgs : EventArgspublic class ControlEventArgs : EventArgsWisej.Web.KeyEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the KeyDown or KeyUp event.
public class KeyEventArgs : EventArgsPublic Class KeyEventArgs
Inherits EventArgsInitializes a new instance of the KeyEventArgs class.
keyData
A representing the key that was pressed, combined with any modifier flags that indicate which CTRL, SHIFT, and ALT keys were pressed at the same time. Possible values are obtained be applying the bitwise OR (|) operator to constants from the enumeration.
Boolean: Returns whether the ALT key was pressed.
Boolean: Returns whether the CTRL key was pressed.
Boolean: Returns or sets whether the event was handled.
Keys: Returns the keyboard code..
Keys: Returns the key data.
Int32: Returns the keyboard value.
Keys: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.
Boolean: Returns a value indicating whether the SHIFT key was pressed.
Returns whether the Alt key is pressed.
Returns: Boolean.
Returns whether the Control key is pressed.
Returns: Boolean.
Returns whether the Shift key is pressed.
Returns: Boolean.
Represents the method that will handle the or event of a .
public class PageCollection : ICollection, IEnumerablepublic class HashChangedEventArgs : EventArgsWisej.Web.MenuButtonItemClickedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the ItemClicked event of a Button control.
public delegate void MenuButtonItemClickedEventHandler(Object sender, MenuButtonItemClickedEventArgs e)Public Delegate Sub MenuButtonItemClickedEventHandler(ByVal sender As [Object], ByVal e As MenuButtonItemClickedEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when the user clicks one of the drop down menu items.
Wisej.Web.PaintEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the Paint event.
public class PaintEventArgs : EventArgsPublic Class PaintEventArgs
Inherits EventArgsInitializes a new instance of the PaintEventArgs class with the specified graphics and clipping rectangle.
graphics
The used to paint the item.
clipRect
The that represents the rectangle in which to paint.
Rectangle: Returns the rectangle in which to paint.
Graphics: Returns the graphics used to paint.
Represents the method that will handle the event of a .
Wisej.Web.FileDialogLoadPathEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the LoadPath and LoadPath events.
public delegate void FileDialogLoadPathEventHandler(Object sender, FileDialogLoadPathEventArgs e)Public Delegate Sub FileDialogLoadPathEventHandler(ByVal sender As [Object], ByVal e As FileDialogLoadPathEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when the file dialog is loading a file or folder.
Fired when the file dialog is loading a file or folder.
Wisej.Web.PreviewKeyDownEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the PreviewKeyDown event.
public delegate void PreviewKeyDownEventHandler(Object sender, PreviewKeyDownEventArgs e)Public Delegate Sub PreviewKeyDownEventHandler(ByVal sender As [Object], ByVal e As PreviewKeyDownEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired before the event when a key is pressed while focus is on this control.
Wisej.Web.AcceleratorEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the event.
Initializes a new instance of the class.
: Returns the Wisej component that generated the "keydown" event'.
Wisej.Web.MenuButtonItemClickedEventArgs
Wisej.Web.TrackEventArgs
Wisej.Web.SwipeEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for event.
: Returns whether the performed swipe was on the x or y axis.
: Returns the direction of the performed swipe in reference to the axis: X = Up / Down Y = Left / Right
: Returns the distance of the performed swipe.
: Returns the duration the performed swipe took.
: Returns the start time of the performed swipe.
: Returns the velocity of the performed swipe.
Wisej.Web.DataRepeaterAddRemoveItemsCancelEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the event.
Initializes a new instance of the class.
: Gets the number of items being deleted.
: Returns the index of the item that is being deleted.
Wisej.Web.Screen
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a display device or multiple display devices on a single system.
: Returns the bounds of the display.
: Returns the device name associated with a display.
: Returns the working area of the browser. The working area is the desktop area of the browser, excluding taskbars, docked windows, and docked tool bars.
sender
The source of the event.
e
A DataRepeaterItemCloneEventArgs object that contains the event data.
Fired before the DataRepeaterItem and its controls are cloned from the ItemTemplate.
Public Delegate Sub DataRepeaterItemCloneEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterItemCloneEventArgs)public delegate void DataRepeaterItemCloneEventHandler(Object sender, DataRepeaterItemCloneEventArgs e)sender
The source of the event.
e
A DataRepeaterDataErrorEventArgs object that contains the event data.
Fired when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.
Public Delegate Sub DataRepeaterDataErrorEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterDataErrorEventArgs)public delegate void DataRepeaterDataErrorEventHandler(Object sender, DataRepeaterDataErrorEventArgs e)sender
The source of the event.
e
A DataRepeaterItemEventArgs object that contains the event data.
Fired after the DataRepeaterItem and its controls are cloned from the ItemTemplate.
Fired after the DataRepeaterItem becomes the current item.
Fired when an instance of DataRepeaterItem is updated.
Public Delegate Sub DataRepeaterItemEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterItemEventArgs)public delegate void DataRepeaterItemEventHandler(Object sender, DataRepeaterItemEventArgs e)sender
The source of the event.
e
A DesktopTaskBarItemClickEventArgs that contains the event data.
Fired when a DesktopTaskBarItem on the Desktop is clicked.
Fired when a DesktopTaskBarItem on the Desktop is double clicked.
Public Delegate Sub DesktopTaskBarItemClickEventHandler(ByVal sender As [Object], ByVal e As DesktopTaskBarItemClickEventArgs)public delegate void DesktopTaskBarItemClickEventHandler(Object sender, DesktopTaskBarItemClickEventArgs e)sender
The source of the event.
e
A DataRepeaterItemValueEventArgs object that contains the event data.
Fired when the VirtualMode property is set to true and a new value for a child control of a DataRepeaterItem is needed.
Fired when the VirtualMode property is set to true and the value of a child control in the DataRepeaterItem changes.
Public Delegate Sub DataRepeaterItemValueEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterItemValueEventArgs)public delegate void DataRepeaterItemValueEventHandler(Object sender, DataRepeaterItemValueEventArgs e)sender
The source of the event.
e
A TouchEventArgs that contains the event data.
Fired when a touch point is placed on the touch surface.
Fired when a touch point is removed from the touch surface.
Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created).
Fired when a touch point is moved along the touch surface.
Public Delegate Sub TouchEventHandler(ByVal sender As [Object], ByVal e As TouchEventArgs)public delegate void TouchEventHandler(Object sender, TouchEventArgs e)sender
The source of the event.
e
A ResponsiveProfileChangedEventArgs that contains the event data.
Fired when the active responsive profile is changed.
Fired when the active responsive profile is changed.
Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)public delegate void ResponsiveProfileChangedEventHandler(Object sender, ResponsiveProfileChangedEventArgs e)sender
The source of the event.
e
A AccordionEventArgs that contains the event data.
Fired when a panel is selected.
Fired when a panel is deselected.
Public Delegate Sub AccordionEventHandler(ByVal sender As [Object], ByVal e As AccordionEventArgs)public delegate void AccordionEventHandler(Object sender, AccordionEventArgs e)keyData
component
The Wisej component that originated the keyboard event.
Represents the method that will handle the Accelerator event.
Public Class AcceleratorEventArgs
Inherits KeyEventArgspublic class AcceleratorEventArgs : KeyEventArgsitem
The MenuItem that was clicked.
Represents the method that will handle the ItemClicked event of a Button control.
Public Class MenuButtonItemClickedEventArgs
Inherits EventArgspublic class MenuButtonItemClickedEventArgs : EventArgsRepresents the method that will handle the Track event.
Public Class TrackEventArgs
Inherits EventArgspublic class TrackEventArgs : EventArgsRepresents the method that will handle the Swipe event.
Public Class SwipeEventArgs
Inherits EventArgspublic class SwipeEventArgs : EventArgsindex
The index of the DataRepeaterItem that is being deleted.
count
The number of items being deleted.
Represents the method that handles the UserDeletingItems event.
Public Class DataRepeaterAddRemoveItemsCancelEventArgs
Inherits CancelEventArgspublic class DataRepeaterAddRemoveItemsCancelEventArgs : CancelEventArgs
Public Class Screenpublic class ScreenWisej.Web.PreviewKeyDownEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the PreviewKeyDown event.
public class PreviewKeyDownEventArgs : EventArgsPublic Class PreviewKeyDownEventArgs
Inherits EventArgsInitializes a new instance of the PreviewKeyDownEventArgs class with the specified key.
keyData
One of the values.
Boolean: Returns whether the ALT key was pressed.
Boolean: Returns whether the CTRL key was pressed.
Boolean: Returns whether a key is a regular input key.
Keys: Returns the keyboard code.
Keys: Returns the key data.
Int32: Returns the keyboard value.
Keys: Returns the modifier flags indicating which combination of CTRL, SHIFT, and ALT keys was pressed.
Boolean: Returns whether the SHIFT key was pressed.
Represents the method that will handle the event.
Wisej.Web.FolderBrowserDialogUI
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
UI implementation for the FolderDialog class.
public class FolderBrowserDialogUI : FormPublic Class FolderBrowserDialogUI
Inherits FormfolderDialog
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
All wisej top-level windows implement this interface.
Allows an object to serialize itself.
Wisej.Web.AccordionCancelEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the Selecting or Deselecting event of a Accordion control.
public delegate void AccordionCancelEventHandler(Object sender, AccordionCancelEventArgs e)Public Delegate Sub AccordionCancelEventHandler(ByVal sender As [Object], ByVal e As AccordionCancelEventArgs)sender
The source of the event.
e
A that contains the event data.
Occurs before a panel is selected, enabling a handler to cancel the panel change.
Occurs before a panel is deselected, enabling a handler to cancel the panel change.
Wisej.Web.AccordionAction
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Defines values representing Accordion events.
public enum AccordionAction : EnumPublic Enum AccordionAction As [Enum]Deselected
Represents the event.
Deselecting
Represents the event.
Selected
Represents the event.
Selecting
Represents the event.
Returns a value indicating which event is occurring.
Returns a value indicating which event is occurring.
Wisej.Web.DragEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the DragDrop, DragEnter, or DragOver event of a Control.
public delegate void DragEventHandler(Object sender, DragEventArgs e)Public Delegate Sub DragEventHandler(ByVal sender As [Object], ByVal e As DragEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when a drag-and-drop operation is completed.
Fired when an object is dragged into the control's bounds.
Fired when an object is dragged over the control's bounds.
Wisej.Web.LayoutEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the event.
Initializes a new instance of the class with the specified component and property affected.
Initializes a new instance of the class with the specified control and property affected.
: Returns the affected by the layout change.
: Returns the child control affected by the change.
: Returns the property affected by the change.
Wisej.Web.AccordionCancelEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the and events of a control.
Initializes a new instance of the class.
: Returns a value indicating which event is occurring.
: Returns the the event is occurring for.
: Returns the zero-based index of the in the collection.
Wisej.Web.DataRepeaterAddRemoveItemsEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the , , , and events.
Initializes a new instance of the class.
: Return the number of items being added to or deleted from a control.
: Returns the index of the item being added or deleted.
Wisej.Web.DesktopTaskBarItemClickEventArgs
Wisej.Web.OpenFileDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Prompts the user to open a file from the server.
You can:
Override . It's called when the specified file doesn't exist and the property is true.
Override to create your custom when the method is called.
Set the to a class that has a constructor that accepts as the single argument to change the User Interface (UI) of the file dialog.
Override to provide your custom implementation of the actions to execute when the user presses the OK button.
You must add at least one to the collection before showing the dialog.
Initializes a new instance of .
Initializes a new instance of the extender with a specified container.
: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
: Returns or sets a value indicating whether the dialog box allows multiple files to be selected.
: Returns the file name and extension for the file selected in the dialog box. The file name does not include the path.
: Returns an array of file names and extensions for all the selected files in the dialog box. The file names do not include the path.
Opens the file selected by the user, with read-only permission. The file is specified by the property.
Returns: . A that specifies the read-only file selected by the user.
Throws:
is empty or null.
Resets all properties to their default values.
Wisej.Web.FileDialogLoadPathEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the LoadPath event.
Allows an application to filter the files and folders loaded by the and components and to set the icon, creation date and modified date. To skip a file or folder, set e.Cancel = true. To set a file's icon, or date, set the , or properties.
Constructs a new instance of .
: Sets the creation DateTime of the file.
: Sets the file size in bytes.
: Sets the name or path of the icon to display next to the file.
: Returns true when the refers to a directory.
: Sets the last modified DateTime of the file.
: Returns the full path of the file or folder being loaded.
sender
The source of the event.
e
An object that contains the event data.
Fired when the user deletes a DataRepeaterItem.
Public Delegate Sub DataRepeaterAddRemoveItemsCancelEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterAddRemoveItemsCancelEventArgs)public delegate void DataRepeaterAddRemoveItemsCancelEventHandler(Object sender, DataRepeaterAddRemoveItemsCancelEventArgs e)Horizontal
Items are displayed in a horizontal format. A horizontal scroll bar will be displayed as necessary.
Vertical
Items are displayed in a vertical format. A vertical scroll bar will be displayed as necessary.
Return or sets whether the DataRepeater control will be displayed with a vertical or horizontal orientation.
Public Enum DataRepeaterLayoutStyles As [Enum]public enum DataRepeaterLayoutStyles : EnumaffectedComponent
The IComponent affected by the layout change.
affectedProperty
The property affected by the layout change.
affectedControl
The Control affected by the layout change.
affectedProperty
The property affected by the layout change.
Public Class LayoutEventArgs
Inherits EventArgspublic class LayoutEventArgs : EventArgspanel
The AccordionPanel the event is occurring for.
panelIndex
The zero-based index of panel in the Panels collection.
cancel
true to cancel the panel change by default; otherwise, false.
action
One of the AccordionAction values.
Represents the method that will handle the Selecting or Deselecting event of a Accordion control.
Public Class AccordionCancelEventArgs
Inherits CancelEventArgspublic class AccordionCancelEventArgs : CancelEventArgsindex
The index of the DataRepeaterItem that is being added or deleted.
count
The number of items being added or deleted.
Represents the method that will handle the ItemsAdded, ItemsRemoved, UserAddedItems, and UserDeletedItems events.
Public Class DataRepeaterAddRemoveItemsEventArgs
Inherits EventArgspublic class DataRepeaterAddRemoveItemsEventArgs : EventArgsitem
The DesktopTaskBarItem that was clicked.
button
One of the MouseButtons values that indicate which mouse button was pressed.
clicks
The number of times a mouse button was pressed.
Public Class DesktopTaskBarItemClickEventArgs
Inherits MouseEventArgspublic class DesktopTaskBarItemClickEventArgs : MouseEventArgscontainer
An IContainer that represents the container of the OpenFileDialog component.
Public Class OpenFileDialog
Inherits FileDialogpublic class OpenFileDialog : FileDialogpath
Path of the file or directory.
isDirectory
Indicates that the path is for a directory.
Public Class FileDialogLoadPathEventArgs
Inherits CancelEventArgspublic class FileDialogLoadPathEventArgs : CancelEventArgsfileDialog
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
All wisej top-level windows implement this interface.
Allows an object to serialize itself.
Public Class FileDialogUI
Inherits Formpublic class FileDialogUI : FormWisej.Web.DataRepeaterItemValueEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the ItemValueNeeded and ItemValuePushed events.
public class DataRepeaterItemValueEventArgs : EventArgsPublic Class DataRepeaterItemValueEventArgs
Inherits EventArgsInitializes a new instance of the DataRepeaterItemValueEventArgs class.
itemIndex
The index of the that contains the control that is raising the event.
control
The child control that is raising the event.
propertyName
The property of the control that has changed or that needs data.
value
The property value that has changed.
Control: Gets the child control of a DataRepeaterItem that is raising the ItemValueNeeded or ItemValuePushed event.
Int32: Gets the index of the DataRepeaterItem that contains the control that is raising the ItemValueNeeded or ItemValuePushed event.
String: Gets the name of the data-bound property of the control that is raising a ItemValueNeeded or ItemValuePushed event.
Object: Gets the property value that has changed to raise a ItemValueNeeded or ItemValuePushed event.
Represents the method that will handle the and events.
Wisej.Web.SplitButton
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a split button control.
public class SplitButton : ButtonPublic Class SplitButton
Inherits ButtonOrientation: Returns or sets a value indicating the layout of the SplitButton. When the value is set to Vertical the down arrow is places below the text, otherwise it's to the right of the text.
Bindable components implement this interface.
Allows a control to act like a button on a .
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.MouseEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.
public delegate void MouseEventHandler(Object sender, MouseEventArgs e)Public Delegate Sub MouseEventHandler(ByVal sender As [Object], ByVal e As MouseEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when the control is clicked by the mouse.
Fired when the control is double clicked by the mouse.
Fired when the mouse pointer is over the control and a mouse button is pressed.
Fired when the mouse pointer is moved over the control.
Fired when the mouse pointer is over the control and a mouse button is released.
Fired when the mouse wheel moves while the control has focus.
Fired when the user clicks the control with the mouse.
Wisej.Web.HashChangedEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the HashChanged event.
public delegate void HashChangedEventHandler(Object sender, HashChangedEventArgs e)Public Delegate Sub HashChangedEventHandler(ByVal sender As [Object], ByVal e As HashChangedEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when the hash part of the URL changes on the client side.
Wisej.Web.Application FormCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Holds the collection of all top-level application forms.
public class FormCollection : ICollection, IEnumerablePublic Class FormCollection
Inherits ICollection
Implements IEnumerableInt32: Returns the total number of currently open forms.
Form: Returns the form at the specified index.
Form: Returns the first form with the specified name, the search is case insensitive.
Returns an enumerator that iterates through the open forms.
Returns: IEnumerator.
Wisej.Web.RotateEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the Rotate event.
public delegate void RotateEventHandler(Object sender, RotateEventArgs e)Public Delegate Sub RotateEventHandler(ByVal sender As [Object], ByVal e As RotateEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when two finger moved around a single point. It contains the angle of the rotation.
Wisej.Web.AcceleratorEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the Accelerator event.
public delegate void AcceleratorEventHandler(Object sender, AcceleratorEventArgs e)Public Delegate Sub AcceleratorEventHandler(ByVal sender As [Object], ByVal e As AcceleratorEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when one of the key is pressed.
Wisej.Web.KeyPressEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the KeyPress event of a Control.
public delegate void KeyPressEventHandler(Object sender, KeyPressEventArgs e)Public Delegate Sub KeyPressEventHandler(ByVal sender As [Object], ByVal e As KeyPressEventArgs)sender
The source of the event.
e
A that contains the event data.
Fired when a key is pressed while the control has focus.
Wisej.Web.RotateEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for Rotate event.
public class RotateEventArgs : EventArgsPublic Class RotateEventArgs
Inherits EventArgsDouble: Returns a number with the current calculated angle between the primary and secondary active pointers.
Represents the method that will handle the event.
Wisej.Web.DataRepeaterItemEventArgs
Wisej.Web.ColorDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors.
Initializes a new instance of .
Initializes a new instance of the extender with a specified container.
: Returns or sets the color selected by the user.
: Returns or sets the set of custom colors shown in the dialog box.
Resets all properties to their default values.
sender
The source of the event.
e
A SwipeEventArgs that contains the event data.
Fired when a pointer swipes over the screen.
Public Delegate Sub SwipeEventHandler(ByVal sender As [Object], ByVal e As SwipeEventArgs)public delegate void SwipeEventHandler(Object sender, SwipeEventArgs e)sender
The source of the event.
e
A KeyEventArgs that contains the event data.
Fired when a key is pressed while the control has focus.
Fired when a key is released while the control has focus.
Public Delegate Sub KeyEventHandler(ByVal sender As [Object], ByVal e As KeyEventArgs)public delegate void KeyEventHandler(Object sender, KeyEventArgs e)sender
The source of the event.
e
A PaintEventArgs that contains the event data.
Fired when a UserPaint control needs to redraw itself.
Public Delegate Sub PaintEventHandler(ByVal sender As [Object], ByVal e As PaintEventArgs)public delegate void PaintEventHandler(Object sender, PaintEventArgs e)sender
The source of the event.
e
A TrackEventArgs that contains the event data.
Fired when a pointer grabs an item and moves the pointer on it.
Public Delegate Sub TrackEventHandler(ByVal sender As [Object], ByVal e As TrackEventArgs)public delegate void TrackEventHandler(Object sender, TrackEventArgs e)sender
The source of the event.
e
A WidgetEventArgs that contains the event data.
Fired when the control receives a custom event from the client.
Public Delegate Sub WidgetEventHandler(ByVal sender As [Object], ByVal e As WidgetEventArgs)public delegate void WidgetEventHandler(Object sender, WidgetEventArgs e)sender
The source of the event.
e
A LayoutEventArgs that contains the event data.
Fired when a control should reposition its child controls.
Public Delegate Sub LayoutEventHandler(ByVal sender As [Object], ByVal e As LayoutEventArgs)public delegate void LayoutEventHandler(Object sender, LayoutEventArgs e)item
The ItemTemplate cloned from the ItemTemplate object.
Represents the method that will handle the ItemCloned event.
Public Class DataRepeaterItemEventArgs
Inherits EventArgspublic class DataRepeaterItemEventArgs : EventArgscontainer
An IContainer that represents the container of the ColorDialog component.
Public Class ColorDialog
Inherits CommonDialogpublic class ColorDialog : CommonDialogWisej.Web.SaveFileDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Prompts the user to select a location for saving a file on the server.
public class SaveFileDialog : FileDialogPublic Class SaveFileDialog
Inherits FileDialogYou can:
Override PromptFileNotFound. It's called when the specified file doesn't exist and the property CheckFileExists is true.
Override PromptFileCreate. It's called when the specified file doesn't exist and the property CreatePrompt is true.
Override PromptFileOverwrite. It's called when the specified file doesn't exist and the property OverwritePrompt is true.
Override CreateUI to create your custom Form when the method ShowDialog is called.
Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.
Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.
You must add at least one IFileSystemProvider to the Roots collection before showing the dialog.
Initializes a new instance of SaveFileDialog.
Initializes a new instance of the SaveFileDialog extender with a specified container.
container
An that represents the container of the component.
Boolean: Returns or sets a value indicating whether the dialog box prompts the user for permission to create a file, if the file specified file does not exist.
Boolean: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that already exists.
Opens the file with read/write permission selected by the user.
Returns: Stream. A Stream that specifies the read/write file selected by the user.
Throws:
ArgumentNullException FileName is empty or null.
Receives the file names selected by the user and validates them according to the properties set in the FileDialog instance.
fileNames
Array containing the selected file paths.
Returns: Boolean. True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.
Resets all dialog box options to their default values.
Wisej.Web.Button
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a button control.
public class Button : ButtonBase, IButtonControlPublic Class Button
Inherits ButtonBase
Implements IButtonControlInitializes a new instance of the Button class.
AutoSizeMode: Returns or sets the mode by which the Button automatically resizes itself.
BorderStyle: Returns or sets the border style of the button control.
DialogResult: Returns or sets a value that is returned to the parent form when the button is clicked.
Display: Returns or sets the Display mode of the control to determine whether to display the icon, the text or both.
Nullable<Int32>: Returns or sets the distance in pixels between the image and the label inside the button.
MenuItemCollection: Returns the collection of MenuItem objects associated with the button.
Boolean: Enables or disables the auto-repeat feature. When enabled, the button keeps firing click events at an increasing rate while the user keeps the button pressed.
Shortcut: Returns or sets a value indicating the shortcut key associated with the button.
Generates a Click event for a button.
MenuButtonItemClickedEventHandler Fired when the user clicks one of the drop down menu items.
Represents a split button control.
Bindable components implement this interface.
Allows a control to act like a button on a .
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.AccordionPanel
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a panel in a Accordion control.
public class AccordionPanel : PanelPublic Class AccordionPanel
Inherits PanelInitializes a new instance of the AccordionPanel class.
Initializes a new instance of the AccordionPanel class and specifies the text to display as the title of the panel.
text
The text for the tab.
Accordion: Returns the parent Accordion control.
Boolean: Returns whether the AccordionPanel is collapsed.
Boolean: Returns or sets a value indicating that the panel can show the expand button on the title bar.
String: Returns or sets the text to display as the title of the AccordionPanel.
ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.
Retrieves the panel that contains the specified Control.
control
The to look for.
Returns: AccordionPanel. The AccordionPanel that contains the specified Control, or null if it cannot be found.
Overridden to update the parent Accordion when in design mode.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.DataRepeaterAddRemoveItemsEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the ItemsAdded, ItemsRemoved, UserAddedItems, and UserDeletedItems events.
public delegate void DataRepeaterAddRemoveItemsEventHandler(Object sender, DataRepeaterAddRemoveItemsEventArgs e)Public Delegate Sub DataRepeaterAddRemoveItemsEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterAddRemoveItemsEventArgs)sender
The source of the event.
e
An object that contains the event data.
Fired when a new is added to the control.
Fired when a is deleted from the control.
Fired when the user adds a new .
Fired after the user deletes a .
Wisej.Web.QueryContinueDragEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the method that will handle the QueryContinueDrag event of a Control.
public delegate void QueryContinueDragEventHandler(Object sender, QueryContinueDragEventArgs e)Public Delegate Sub QueryContinueDragEventHandler(ByVal sender As [Object], ByVal e As QueryContinueDragEventArgs)sender
The source of an event.
e
A that contains the event data.
Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
Wisej.Web.FileDialogRootCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represent a collection of the IFileSystemProvider root file systems shown by the FileDialog implementation.
public class FileDialogRootCollection : List<>Public Class FileDialogRootCollection
Inherits List(Of )Maps the virtual path to the corresponding physical path on the specific IFileSystemProvider implementation.
filePath
Virtual path to map to the corresponding physical path.
Returns: String. The physical path for the IFileSystemProvider implementation.
Wisej.Web.PinchEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for Pinch event.
public class PinchEventArgs : EventArgsPublic Class PinchEventArgs
Inherits EventArgsDouble: Returns the calculated scale factor.
Represents the method that will handle the event.
Wisej.Web.QueryContinueDragEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the QueryContinueDrag event.
public class QueryContinueDragEventArgs : EventArgsPublic Class QueryContinueDragEventArgs
Inherits EventArgsInitializes a new instance of the QueryContinueDragEventArgs class.
args
The arguments received from the client.
DragAction: Returns or sets the status of a drag-and-drop operation.
Boolean: Returns if the user pressed the ESC key.
Int32: Returns the current state of the SHIFT, CTRL, and ALT keys.
Represents the method that will handle the event of a .
Wisej.Web.Cursor
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents the mouse pointer.
Creates a new cursor using the .
Creates a new cursor using an image source: can use a themed image or URL.
Creates a new cursor using the .
Creates a new cursor using the .
Creates a new cursor using the .
Creates a new cursor using an image source: can use a themed image or URL.
: Returns the name of the cursor.
: Returns or sets the pointer's position.
Wisej.Web.FolderBrowserDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Allows the user to select a folder from one of the .
Initializes a new instance of .
Initializes a new instance of using the initial roots .
Initializes a new instance of the extender with a specified container.
: Returns or sets the description splayed above the tree view control in the dialog box.
: List of root file systems displayed by the FolderBrowserDialog.
The Roots collection and the implementations allow the application to use arbitrary names mapped to a specific path. For example, the app may add a root object named "Documents" to "c:\users[logged-user-id]\files\documents". Each user will see "Documents" as the root, but will also see only the files in the [logged-user-id] directory.
: Returns sets the path selected by the user.
: Returns or sets whether the Help button is displayed in the file dialog box.
: Returns or sets the file dialog box title.
Returns the that contains the specified path .
Returns: . The that contains the specified path or null if not found.
Maps the virtual path to the corresponding physical path on the specific implementation.
Returns: . The physical path for the implementation.
Resets all properties to their default values.
Fired when the file dialog is loading a file or folder.
Wisej.Web.ResponsiveProfileChangedEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the event.
Initializes a new instance of the class.
: The new active profile.
: The previously active profile.
Wisej.Web.TouchEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for event.
: Returns the unique identifiers for the touch items.
: Returns whether more than one touch is associated with the event target element.
: Returns the location of the touch items in screen coordinates.
: Returns the delta of the rotation since the start of the event, in degrees.
: Returns the distance between two fingers since the start of the event.
Wisej.Web.AccordionEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the and events of a control.
Initializes a new instance of the class.
: Returns a value indicating which event is occurring.
: Returns the the event is occurring for.
: Returns the zero-based index of the in the collection.
image
An Image to use for the cursor.
source
The name of a theme image or a URL to an image resource.
stream
A Stream to use for the cursor.
image
An Image to use for the cursor.
x
x-coordinate of the hotspot location.
y
y-coordinate of the hotspot location.
stream
A Stream to use for the cursor.
x
x-coordinate of the hotspot location.
y
y-coordinate of the hotspot location.
source
The name of a theme image or a URL to an image resource.
x
x-coordinate of the hotspot location.
y
y-coordinate of the hotspot location.
Public Class Cursorpublic class Cursorroots
Initial file systems to load in the FolderBrowserDialog.
container
An IContainer that represents the container of the FolderBrowserDialog component.
path
Full path of the file to locate in on of the Roots.
folderPath
Virtual path to map to the corresponding physical path.
Public Class FolderBrowserDialog
Inherits CommonDialogpublic class FolderBrowserDialog : CommonDialogoldValue
Previous ClientProfile.
newValue
New active ClientProfile.
Represents the method that will handle the Application.ResponsiveProfileChanged event.
Public Class ResponsiveProfileChangedEventArgs
Inherits EventArgspublic class ResponsiveProfileChangedEventArgs : EventArgsRepresents the method that will handle the TouchStart, TouchEnd, TouchMove, TouchCancel events.
Public Class TouchEventArgs
Inherits EventArgspublic class TouchEventArgs : EventArgspanel
The AccordionPanel the event is occurring for.
panelIndex
The zero-based index of panel in the Panels collection.
action
One of the AccordionAction values.
Represents the method that will handle the Selected or Deselected event of a Accordion control.
Public Class AccordionEventArgs
Inherits EventArgspublic class AccordionEventArgs : EventArgsWisej.Web.CheckBox
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a check box control.
public class CheckBox : ButtonBasePublic Class CheckBox
Inherits ButtonBaseInitializes a new instance of the CheckBox class.
Appearance: Returns or sets the value that determines the appearance of a CheckBox control.
Boolean: Returns or set a value indicating whether the Checked or CheckState values and the CheckBox's appearance are automatically changed when the CheckBox is clicked.
Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.
ContentAlignment: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control.
Boolean: Returns or set a value indicating whether the CheckBox is in the checked state.
Color: Returns or sets the text color used when the CheckBox is checked.
CheckState: Returns or sets the state of the CheckBox.
Boolean: Returns or sets a value that indicates that the control is invalid.
String: Returns or sets the invalid message that is shown in the invalid tooltip.
Boolean: Returns or sets whether the control is read-only.
ContentAlignment: Returns or sets the alignment of the text on the CheckBox control.
Boolean: Returns or sets whether the CheckBox will allow three check states rather than two.
Generates a Click event for a CheckBox.
EventHandler Fired when the value of the Appearance property changes.
EventHandler Fired when the value of the Checked property changes.
EventHandler Fired when the value of the CheckState property changes.
EventHandler Fired when the value of the ReadOnly property has changed.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.RadioButton
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Enables the user to select a single option from a group of choices when paired with other RadioButton controls.
public class RadioButton : ButtonBasePublic Class RadioButton
Inherits ButtonBaseInitializes a new instance of the RadioButton class.
Appearance: Returns or sets the value that determines the appearance of a CheckBox control.
Boolean: Returns or set a value indicating whether the Checked or CheckState values and the CheckBox's appearance are automatically changed when the CheckBox is clicked.
Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.
ContentAlignment: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control.
Boolean: Gets or sets whether the control is checked.
Color: Returns or sets the text color used when the RadioButton is checked.
Boolean: Returns or sets a value that indicates that the control is invalid.
String: Returns or sets the invalid message that is shown in the invalid tooltip.
Boolean: Returns or sets whether the control is read-only.
Boolean: Returns or sets whether the user can give the focus to this control using the TAB key and the Focusable property is set to true.
ContentAlignment: Returns or sets the alignment of the text on the CheckBox control.
Generates a Click event for a RadioButton.
EventHandler Fired when the value of the Appearance property changes.
EventHandler Fired when the value of the Checked property changes.
EventHandler Fired when the value of the ReadOnly property has changed.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.WidgetEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the WidgetEvent event of the Widget control.
public class WidgetEventArgs : EventArgsPublic Class WidgetEventArgs
Inherits EventArgsInitializes a new instance of the WidgetEventArgs class.
type
The type (name) of event.
data
The data object received with the event.
Object: Returns the data object that was sent by the widget with the event.
String: Returns the type (name) of the event fired by the widget.
Represents the method that handles a event.
Wisej.Web.Control ControlCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a collection of Control objects.
public class ControlCollection : ControlCollection, IList<Control>, ICollection<Control>, IEnumerable<Control>, IWisejSynchronizedPublic Class ControlCollection
Inherits ControlCollection
Implements IList(Of Control), ICollection(Of Control), IEnumerable(Of Control), IWisejSynchronizedInitializes a new instance of the ControlCollection class.
owner
The that owns this collection.
Boolean: Returns whether the owner control has already been disposed.
Control: Returns the Control at the specified indexed location.
Control: Returns the Control with the specified key in the collection.
Control: Returns the control that owns this ControlCollection.
Adds the specified control to the control collection.
child
The to add.
Adds an array of control objects to the collection.
controls
An array of objects to add to the collection.
Removes all controls from the collection.
Removes and disposes all controls from the collection.
dispose
Indicates whether the controls removed from the collection should be disposed.
Determines whether the specified control is a member of the collection.
control
The to locate in the collection.
Returns: Boolean. true if the Control is a member of the collection; otherwise, false.
Determines whether the ControlCollection contains an item with the specified key.
key
The key to locate in the .
Returns: Boolean. true if the ControlCollection contains an item with the specified key; otherwise, false.
Searches for controls by their type and builds an array of all the controls that match.
type
The type of the controls to locate in the .
searchAllChildren
true to search all child controls; otherwise, false.
Returns: Control[]. Array of controls that are derived from the specified type .
Throws:
ArgumentNullException type is null.
Searches for controls by their name and builds an array of all the controls that match.
key
The key to located in the .
searchAllChildren
true to search all child controls; otherwise, false.
Returns: Control[]. Array of controls with the specified name.
Throws:
ArgumentNullException The key parameter is null or an empty string ("").
Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.
child
The to search for in the control collection.
throwException
true to throw an exception if the specified in the child parameter is not a control in the ; otherwise, false.
Returns: Int32. A zero-based index value that represents the location of the specified child control within the control collection; otherwise -1 if the specified Control is not found in the ControlCollection.
Throws:
ArgumentException The child Control is not in the ControlCollection, and the throwException parameter value is true.
Retrieves a reference to an enumerator object that is used to iterate over a ControlCollection.
Returns: IEnumerator. An IEnumerator.
Retrieves the index of the specified control in the control collection.
control
The to locate in the collection.
Returns: Int32. A zero-based index value that represents the position of the specified Control in the ControlCollection.
Retrieves the index of the first occurrence of the specified item within the collection.
key
The name of the control to search for.
Returns: Int32. The zero-based index of the first occurrence of the control with the specified name in the collection.
Removes the specified control from the control collection.
child
The to remove.
Removes the child control with the specified key.
key
The name of the child control to remove.
Sets the index of the specified child control in the collection.
child
The child control to search for.
newIndex
The new index value of the control.
Wisej.Web.Desktop
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a desktop container that can host floating windows.
public class Desktop : ContainerControl, IWisejWindow, IWisejDesignTargetPublic Class Desktop
Inherits ContainerControl
Implements IWisejWindow, IWisejDesignTargetInitializes a new instance of the Desktop class.
Boolean: Returns true if this desktop instance is the currently active desktop. It is the same as comparing the instance with Desktop.
Boolean: Returns or sets whether the taskbar is hidden automatically when there are no opened windows or no windows with the property ShowInTaskbar set to true.
Rectangle: Returns a rectangle that represents the inner dimensions of the Desktop control.
DockStyle: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
Int32: Returns or sets the height of the page.
Boolean: Returns whether the taskbar is currently visible.
DesktopTaskBarItemCollection: Returns the collection of DesktopTaskBarItem controls displayed in the taskbar of the desktop control.
Point: Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
Size: Returns the height and width of the page.
Position: Return or sets the position of the taskbar to one of the four sides indicated by the Position values.
Int32: Returns the height or width of the taskbar in the current theme, depending on the value of TaskbarPosition.
String: Returns or sets the title of the Desktop. If the desktop is the main desktop, setting the text also changes the title in the browser.
String: Returns or sets the wallpaper image.
Int32: Returns or sets the width of the page.
EventHandler Fired when the desktop becomes active, and it's the new Desktop.
EventHandler Fired when the desktop is deactivated and it's no longer the Desktop.
DesktopTaskBarItemClickEventHandler Fired when a DesktopTaskBarItem on the Desktop is clicked.
DesktopTaskBarItemClickEventHandler Fired when a DesktopTaskBarItem on the Desktop is double clicked.
EventHandler Fired before the desktop becomes visible for the first time.
EventHandler Occurs when the property TaskbarPosition changes value.
EventHandler Occurs when the property AutoHideTaskbar is set to true and the TaskBar is either hidden or shown.
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
All wisej top-level windows implement this interface.
Allows an object to serialize itself.
Wisej.Web.DataRepeaterItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Used by the DataRepeater control to display data at run time.
public class DataRepeaterItem : PanelPublic Class DataRepeaterItem
Inherits PanelInitializes a new instance of the DataRepeaterItem object.
Boolean: Return a value that determines whether a DataRepeaterItem is the currently selected item in a DataRepeater control.
Int32: Returns the index of a DataRepeaterItem in a DataRepeater control.
Boolean: Returns value that determines whether the data for a DataRepeaterItem in a DataRepeater control has been changed by the user.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.Padding
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents padding or margin information associated with a user interface (UI) element.
public struct Padding : ValueType, IWisejSerializablePublic Structure Padding
Implements ValueType, IWisejSerializableInitializes a new instance of the Padding class using a separate padding size for each edge.
left
The padding size, in pixels, for the left edge.
top
The padding size, in pixels, for the top edge.
right
The padding size, in pixels, for the right edge.
bottom
The padding size, in pixels, for the bottom edge.
Initializes a new instance of the Padding class using the supplied padding size for all edges.
all
The number of pixels to be used for padding for all edges.
Int32: Returns or sets the padding value for all the edges.
Int32: Returns or sets the padding value for the bottom edge.
Int32: Returns the combined padding for the right and left edges.
Boolean: Returns if the padding is empty.
Int32: Returns or sets the padding value for the left edge.
Int32: Returns or sets the padding value for the right edge.
Size: Returns the padding information in the form of a Size.
Int32: Returns or sets the padding value for the top edge.
Int32: Returns the combined padding for the top and bottom edges.
Computes the sum of the two specified Padding values.
p1
A .
p2
A .
Returns: Padding. A Padding that contains the sum of the two specified Padding values.
Subtracts one specified Padding value from another.
p1
A .
p2
A .
Returns: Padding. A Padding that contains the result of the subtraction of one specified Padding value from another.
Returns or sets padding within the control.
Returns or sets the space between controls.
Returns or sets the additional padding around the label. This property can be defined in the theme.
Returns or sets the space between the edge of a and its content.
Returns or sets the offset in pixels from the calculated position of the popup.
Returns or sets the padding inside objects in any mode.
Returns or sets padding within the toolbar button.
Returns or sets the space between toolbar buttons.
Computes the sum of the two specified values.
Returns the size of the inset border and padding.
Wisej.Web.ContainerControl
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides focus-management functionality for controls that can function as a container for other controls.
public class ContainerControl : ScrollableControl, IContainerControl, IContainerControlPublic Class ContainerControl
Inherits ScrollableControl
Implements IContainerControl, IContainerControlInitializes a new instance of the ContainerControl class.
Keys[]: Returns or sets a collection of keys that fire the Accelerator event when the user presses the accelerator key while the focus is on any child control.
Control: Returns or sets the active control on the container control.
Throws:
ArgumentException The Control assigned could not be activated.
BindingContext: Returns or sets the BindingContext for the control.
Boolean: Returns or sets whether the container will receive key events before the event is passed to the control that has focus.
Form: Returns the Form that the container control is assigned to.
Page: Returns the Page that the container control is assigned to.
Boolean: Enables or disables right-to-left layout when the value of RightToLeft is Yes
Validates the last unvalidated control and its ancestors up through, but not including the current control.
Returns: Boolean.
Validates the last unvalidated control and its ancestors up through, but not including the current control.
checkAutoValidate
If true, the value of the property is used to determine if validation should be performed; if false, validation is unconditionally performed.
Returns: Boolean.
AcceleratorEventHandler Fired when one of the Accelerators key is pressed.
EventHandler Fired when the value of the RightToLeftLayout property changes.
UI implementation for the FileDialog class.
UI implementation for the FolderDialog class.
Displays data in a customizable list format.
Represents a window or dialog box that makes up an application's user interface.
Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.
Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
Provides an empty control that can be used to create other controls.
Represents a desktop container that can host floating windows.
Provides an popup container that can be attached to other controls.
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.DragEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the DragDrop, DragEnter, or DragOver event.
public class DragEventArgs : EventArgsPublic Class DragEventArgs
Inherits EventArgsInitializes a new instance of the DragEventArgs class.
allowedEffect
One of the values.
effect
One of the values.
data
The data associated with this event.
location
The that indicates the location of the drag event.
DragDropEffects: Returns which drag-and-drop operations are allowed by the originator (or source) of the drag event.
String: Specify the types of files that the server accepts (that can be submitted through a file upload).
The allowed files string follows the HTML 4.01 and HTML5 specifications. You can configure only one entry in the browser's file dialog. The syntax is "file_extension|audio/|video/|image/*|media_type". Look at IANA Media Types for a complete list of standard media types.
IDataObject: Returns the IDataObject that contains the data associated with this event.
Object: Returns the original target of the drag operation.
DragDropEffects: Returns or sets the target drop effect in a drag-and-drop operation.
Image: Returns or sets the custom image displayed on the client to represent the drag action.
Size: Returns or sets the size in pixels of the custom image displayed on the client to represent the drag action.
String: Returns or sets the custom image source displayed on the client to represent the drag action.
Int32: Returns the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.
Point: Returns the location of the mouse or pointer event, in screen coordinates.
Int32: Returns the x-coordinate of the mouse or pointer, in screen coordinates.
Int32: Returns the y-coordinate of the mouse or pointer, in screen coordinates.
Represents the method that will handle the , , or event of a .
Wisej.Web.DesktopTaskBarItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represents a component in the control's taskbar.
Initializes a new instance of the class.
Initializes a new instance of the class and displays the specified text on the item.
: Returns or sets a value indicating that the control can display html in the Text property.
: Returns or sets whether the button is enabled.
: Returns or sets the image that is displayed in a .
: Returns or sets the position of the within this taskbar item.
: Returns or sets the theme name or URL for the image to display in the .
: Returns or sets the name of the .
: Returns the control that the taskbar item button is assigned to.
: Returns or sets the position of this within the taskbar in the parent .
: Returns or sets the object that contains user data.
: Returns or sets the text displayed on the taskbar item.
When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with " ".
: Returns or sets the text that appears as a ToolTip for the taskbar item.
: Returns or sets whether the taskbar item is visible or hidden.
Updates the component on the client. Overridden to repaint the taskbar in design mode.
Wisej.Web.Cursors
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Defines a collection of predefined objects.
: Returns the "shortcut" cursor.
: Returns the "arrow" cursor.
: Returns "cell" cursor.
: Returns the clipboard "copy" cursor.
: Returns the "crosshair" cursor.
: Returns the "default" cursor, which is usually an arrow cursor.
: Returns the "grab" cursor.
: Returns the "hand" cursor, typically used when hovering over a Web link.
: Returns the "help" cursor, which is a combination of an arrow and a question mark.
: Returns the "row-resize" cursor that appears when the mouse is positioned over a horizontal splitter bar.
: Returns the "text" cursor, which is used to show where the text cursor appears when the mouse is clicked.
: Returns the "move" cursor, typically an cross shape.
: Returns the "not-allowed" cursor that indicates that a particular region is invalid for the current operation.
: Returns the "none" cursor.
: Returns the "not-allowed" cursor.
: Returns the "move" sizing cursor, which consists of four joined arrows that point north, south, east, and west.
: Returns the "ne-resize" diagonal (north/east) sizing cursor.
: Returns the "nesw-resize" diagonal (northeast/southwest) sizing cursor.
: Returns the "n-resize" vertical (north/south) sizing cursor.
: Returns the "nw-resize" diagonal (north/west) sizing cursor.
: Returns the "nwse-resize" diagonal (northwest/southeast) sizing cursor.
: Returns the "se-resize" diagonal (south/east) sizing cursor.
: Returns the "sw-resize" diagonal (south/west) sizing cursor.
: Returns the "w-resize" horizontal (west/east) sizing cursor.
: Returns the "text" cursor.
: Returns the "col-resize" cursor that appears when the mouse is positioned over a vertical splitter bar.
: Returns the "wait" cursor, typically an hourglass shape.
: Returns the "zoom-in" cursor.
: Returns the "zoom-out" cursor.
Wisej.Web.ButtonBase
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Implements the basic functionality common to button controls.
Initializes a new instance of the class.
: Returns or sets a value indicating that the control can display HTML in the Text property.
Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.
: Returns or sets whether the ellipsis character (...) appears at the right edge of the control, denoting that the text extends beyond the size of the control.
: Returns or sets whether the application blocks the browser with a modal mask when this button is clicked and until the server is done processing the execution request.
blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while blocks the specific widget when returning from the request.
: Returns or sets a value that indicates whether the control resizes based on its contents.
: Returns or sets the image that is displayed in a button control.
: Returns or sets the alignment of the image in the button control.
: Returns or sets the image list index value of the image in the displayed in the button control.
Throws:
The specified index is less than -1.
: Returns or sets the key accessor for the image in the displayed in the button control.
: Returns or sets the that contains the displayed in a button control.
: Returns or sets the theme name or URL for the image to display in the button control.
: Returns or sets the text associated with this control.
Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.
: Returns or sets the alignment of the text in the button control.
: Returns or sets the position of text and image relative to each other.
: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control.
Generates a event for a button.
text
The text to display on the new DesktopTaskBarItem.
Represents a DateTime component in the Desktop control's taskbar.
All wisej components implement this interface.
Allows an object to serialize itself.
Public Class DesktopTaskBarItem
Inherits Componentpublic class DesktopTaskBarItem : ComponentRepresents a button control.
Represents a check box control.
Enables the user to select a single option from a group of choices when paired with other RadioButton controls.
Represents a split button control.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
Public Class ButtonBase
Inherits Controlpublic class ButtonBase : ControlPublic Class Cursorspublic class CursorsWisej.Web.MouseEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides data for the MouseUp, MouseDown, and MouseMove events.
public class MouseEventArgs : EventArgsPublic Class MouseEventArgs
Inherits EventArgsInitializes a new instance of the MouseEventArgs class.
button
One of the values that indicate which mouse button was pressed.
clicks
The number of times a mouse button was pressed.
x
The x-coordinate of a pointer click, in pixels.
y
The y-coordinate of a pointer click, in pixels.
delta
A signed count of the number of dents the wheel has rotated.
Initializes a new instance of the MouseEventArgs class.
button
One of the values that indicate which mouse button was pressed.
clicks
The number of times a mouse button was pressed.
x
The x-coordinate of a pointer click, in pixels.
y
The y-coordinate of a pointer click, in pixels.
delta
A signed count of the number of dents the wheel has rotated.
role
The internal role assigned to the element that generated the pointer event.
MouseButtons: Returns which mouse button was pressed.
Int32: Returns the number of clicks or taps.
Int32: Returns the number of times the mouse wheel has rotated.
Point: Returns the location of the mouse or pointer event.
Control: Returns the original target Control when the pointer event has bubbled up because the original target was either not Enabled or Anonymous.
String: Returns the internal role assigned to the element that generated the pointer event: checkbox, button, ...
The value in the Role property is taken from the "role" attribute of the clicked element inside the widget. You can detect clicks on custom HTML content by adding the role attribute to the custom element.
Int32: Returns the x-coordinate of the mouse or touch event.
Int32: Returns the y-coordinate of the mouse or touch event.
Represents the method that will handle the MouseDown, MouseUp, or MouseMove event of a form, control, or other component.
Wisej.Web.Component
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Extends Component and enabled the components to appear on the designer surface.
public class Component : Component, IComponentPublic Class Component
Inherits Component
Implements IComponentDefault constructor
Updates the component on the client.
Represents a panel in a control. Although the control replaces and adds functionality to the control of previous versions, is retained for both backward compatibility and future use if you choose.
Implements a timer that raises an event at user-defined intervals.
Represents a component in the control's taskbar.
Represents a component in the control's taskbar that can host any .
Represents a DateTime component in the control's taskbar.
Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.
Provides a user interface for indicating that a control on a form has an error associated with it.
Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).
Allows controls to execute javascript code.
Add rotation capabilities along the X,Y,Z axis to controls.
Adds CSS styling to controls.
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.
Provides methods to manage a collection of objects. This class cannot be inherited.
Displays a standard column header in a control.
Displays an image column header in a control.
Represents a context menu associated to a .
Represents an individual menu item that is displayed within a or rendered using the link element to let the browser process the specified URL.
Represents the main menu in a .
Represents the base functionality for all menus.
Represents an individual item that is displayed within a or .
Represents a button in the .
All wisej components implement this interface.
Allows an object to serialize itself.
Wisej.Web.Accordion
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Displays collapsible set of AccordionPanel panels for presenting information in a limited amount of space.
public class Accordion : Control, ISupportInitializePublic Class Accordion
Inherits Control
Implements ISupportInitializeInitializes a new instance of the Accordion class.
BorderStyle: Returns or sets the type of border that is drawn around the Accordion panel.
Boolean: Returns or sets a value indicating whether the Accordion control collapses when all the AccordionPanel children are collapsed.
When this property is set to false (default) one panel is always expanded.
Rectangle: Returns the rectangle that represents the virtual display area of the control.
ImageList: Returns or sets the images to display on the panel's title bar.
Int32: Returns the number of panels in the container.
PanelCollection: Returns the collection of panels in the container.
Int32: Returns or sets the index of the currently selected panel.
Throws:
ArgumentOutOfRangeException The value is less than -1.
Boolean: Returns or sets a value indicating whether the selected panel is moved to the top of the Accordion container.
AccordionPanel: Returns or sets the currently selected panel.
Boolean: Returns or sets whether a panel's ToolTip is shown when the mouse passes over the panel's title.
Makes the AccordionPanel following the AccordionPanel with the specified index the current panel.
index
The index in the collection of the to deselect.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.
Makes the AccordionPanel following the specified AccordionPanel the current panel.
panel
The to deselect.
Throws:
ArgumentNullException panel is null.
Makes the AccordionPanel following the AccordionPanel the specified name the current panel.
panelName
The of the panel to deselect.
Throws:
ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.
Returns the AccordionPanel panel at the specified location.
index
The index of the to get.
Returns: Control. The AccordionPanel at the specified location.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.
Makes the AccordionPanel with the specified index the current AccordionPanel.
index
The index in the collection of the tab to select.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.
Makes the specified AccordionPanel the current AccordionPanel.
panel
The to select.
Throws:
ArgumentNullException panel is null.
Makes AccordionPanel with the specified name the current AccordionPanel.
panelName
The of the tab to select.
Throws:
ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.
AccordionEventHandler Fired when a panel is deselected.
AccordionCancelEventHandler Occurs before a panel is deselected, enabling a handler to cancel the panel change.
AccordionEventHandler Fired when a panel is selected.
EventHandler Fired when the SelectedIndex property has changed.
AccordionCancelEventHandler Occurs before a panel is selected, enabling a handler to cancel the panel change.
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.FileDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Displays a dialog box from which the user can select a file.
public class FileDialog : CommonDialogPublic Class FileDialog
Inherits CommonDialogThis class is abstract. The current implementations in Wisej are OpenFileDialog and SaveFileDialog. You can override this class or OpenFileDialog and SaveFileDialog to add your own custom behavior and localization. You can:
Override PromptFileNotFound. It's called when the specified file doesn't exist and the property CheckFileExists is true.
Override CreateUI to create your custom Form when the method ShowDialog is called.
Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.
Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.
You must add at least one FileSystemProvider to the Roots collection before showing the dialog.
Initializes a new instance of FileDialog.
Initializes a new instance of FileDialog using the initial roots .
roots
Initial file systems to load in the .
Initializes a new instance of the FileDialog extender with a specified container.
container
An that represents the container of the component.
Boolean: Returns or sets whether the dialog box automatically adds an extension to a file name if the user omits the extension.
Boolean: Returns or sets whether the dialog box displays a warning if the user specifies a file name that does not exist.
String: Returns or sets the default file name extension.
String: Returns or sets a string containing the file name selected in the file dialog box.
String[]: Returns the file names of all selected files in the dialog box.
IFileSystemProvider: Returns the IFileSystemProvider that contains the selected FileName.
String: Returns or sets the current file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box.
Int32: Returns or sets the index of the filter currently selected in the file dialog box.
String: Returns or sets the initial directory displayed by the file dialog box.
FileDialogRootCollection: List of root IFileSystemProvider file systems displayed by the FileDialog.
The Roots collection and the IFileSystemProvider implementations allow the application to use arbitrary names mapped to a specific path. For example, the app may add a root object named "Documents" to "c:\users[logged-user-id]\files\documents". Each user will see "Documents" as the root, but will also see only the files in the [logged-user-id] directory.
Boolean: Returns or sets whether the Help button is displayed in the file dialog box.
String: Returns or sets the file dialog box title.
Returns the IFileSystemProvider that contains the specified path .
path
Full path of the file to locate in on of the .
Returns: IFileSystemProvider. The IFileSystemProvider that contains the specified path or null if not found.
Maps the virtual path to the corresponding physical path on the specific IFileSystemProvider implementation.
filePath
Virtual path to map to the corresponding physical path.
Returns: String. The physical path for the IFileSystemProvider implementation.
Receives the file names selected by the user and validates them according to the properties set in the FileDialog instance.
fileNames
Array containing the selected file paths.
Returns: Boolean. True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.
Resets all properties to their default values.
CancelEventHandler Fired when the user clicks on the Open or Save button on a file dialog box.
FileDialogLoadPathEventHandler Fired when the file dialog is loading a file or folder.
Prompts the user to open a file from the server.
Prompts the user to select a location for saving a file on the server.
Wisej.Web.Clipboard
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Provides methods to place data on and retrieve data from the system Clipboard. This class cannot be inherited.
public class ClipboardPublic Class ClipboardRemoves all data from the Clipboard.
Indicates whether there is data on the Clipboard in the WaveAudio format.
Returns: Boolean. true if there is audio data on the Clipboard; otherwise, false.
Indicates whether there is data on the Clipboard that is in the specified format or can be converted to that format.
format
The format of the data to look for. See for predefined formats.
Returns: Boolean. true if there is data on the Clipboard that is in the specified format or can be converted to that format; otherwise, false.
Indicates whether there is data on the Clipboard that is in the FileDrop format or can be converted to that format.
Returns: Boolean. true if there is a file drop list on the Clipboard; otherwise, false.
Indicates whether there is data on the Clipboard that is in the Bitmap format or can be converted to that format.
Returns: Boolean. true if there is image data on the Clipboard; otherwise, false.
Indicates whether there is data on the Clipboard in the Text or UnicodeText format, depending on the operating system.
Returns: Boolean. true if there is text data on the Clipboard; otherwise, false.
Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: Boolean. true if there is text data on the Clipboard in the value specified for format ; otherwise, false.
Retrieves an audio stream from the Clipboard.
Returns: Stream. A Stream containing audio data or null if the Clipboard does not contain any data in the WaveAudio format.
Retrieves data from the Clipboard in the specified format.
format
The format of the data to retrieve. See for predefined formats.
Returns: Object. An Object representing the Clipboard data or null if the Clipboard does not contain any data that is in the specified format or can be converted to that format.
Retrieves the data that is currently on the system Clipboard.
Returns: IDataObject. An IDataObject that represents the data currently on the Clipboard, or null if there is no data on the Clipboard.
Retrieves a collection of file names from the Clipboard.
Returns: StringCollection. A StringCollection containing file names or null if the Clipboard does not contain any data that is in the FileDrop format or can be converted to that format.
Retrieves an image from the Clipboard.
Returns: Image. An Image representing the Clipboard image data or null if the Clipboard does not contain any data that is in the Bitmap format or can be converted to that format.
Retrieves text data from the Clipboard in the Text or UnicodeText format, depending on the operating system.
Returns: String. The Clipboard text data or Empty if the Clipboard does not contain data in the Text or UnicodeText format, depending on the operating system.
Retrieves text data from the Clipboard in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: String. The Clipboard text data or Empty if the Clipboard does not contain data in the specified format.
Saves the Byte array in the WaveAudio format after converting it to a Stream to the clipboard.
audioBytes
A array containing the audio data.
Throws:
ArgumentNullException audioBytes is null.
Saves the Stream in the WaveAudio format to the clipboard.
audioStream
A containing the audio data.
Throws:
ArgumentNullException audioStream is null.
Saves the text data to the client's temporary clipboard. Client side javascript code can copy the clipboard's content to the browser's clipboard calling Wisej.Core.copy();
text
The text to save to the client's temporary clipboard.
Throws:
ArgumentNullException text is null.
Saves the specified data to the clipboard in the specified format.
format
The format of the data to set. See for predefined formats.
data
An representing the data to add.
Throws:
ArgumentNullException data is null.
Saves the specified data to the clipboard.
data
The data to place on the Clipboard.
Throws:
ArgumentNullException The value of data is null.
Saves the collection of file names in the FileDrop format to the clipboard.
filePaths
A containing the file names.
Throws:
ArgumentNullException filePaths is null.
ArgumentException filePaths does not contain any strings, or at least one of the strings in filePaths is empty, contains only white space, contains one or more invalid characters as defined by InvalidPathChars, is null, contains a colon (:), or exceeds the system-defined maximum length. See the InnerException property of the ArgumentException for more information.
Saves the Image in the Bitmap format to the clipboard
image
The to add to the Clipboard.
Throws:
ArgumentNullException image is null.
Saves the text data in the UnicodeText format to the clipboard.
text
The text to add to the Clipboard.
Throws:
ArgumentNullException text is null or Empty.
Saves the text data in the format indicated by the specified TextDataFormat value to the clipboard.
text
The text to add to the Clipboard.
format
One of the values.
Throws:
ArgumentNullException text is null.
Wisej.Web.DataRepeater
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Displays data in a customizable list format.
public class DataRepeater : ContainerControl, ISupportInitializePublic Class DataRepeater
Inherits ContainerControl
Implements ISupportInitializeInitializes a new instance of the DataRepeater class.
Boolean: Returns or sets whether users can add a new row to the DataRepeater at run time.
Boolean: Returns or sets whether users can delete a row from the DataRepeater at run time.
BorderStyle: Returns or sets the border style for the DataRepeater control.
DataRepeaterItem: Returns the current DataRepeaterItem in the DataRepeater control.
Int32: Returns or sets the index of the current DataRepeaterItem in a DataRepeater control.
String: Return or sets the name of the list or table in the data source for which the DataRepeater is displaying data.
Object: Returns or sets the data source for which the DataRepeater is displaying data.
DataRepeaterItem[]: Returns the list of DataRepeaterItem items currently displayed on the client.
Int32: Return the index of the first currently displayed DataRepeaterItem in a DataRepeater control.
Boolean: Return whether the data for a DataRepeaterItem in the DataRepeater control has been changed by a user.
BorderStyle: Returns or sets the border style for the items in a DataRepeater control.
Int32: Returns or sets the number of DataRepeaterItem items that are in the DataRepeater control.
Int32: Return sets the size of the item header in a DataRepeater control.
Boolean: Returns or sets whether item headers are displayed in a DataRepeater control.
Color: Returns or sets the background color for the DataRepeaterItem panel when it's the CurrentItem.
Size: Returns or sets the size of the DataRepeaterItem child panels.
DataRepeaterItem: Returns the template that represents the DataRepeaterItem for the DataRepeater control.
DataRepeaterLayoutStyles: Return or sets whether the DataRepeater control will be displayed with a vertical or horizontal orientation.
Int32: Returns or sets the number of items to prefetch outside of the visible area. The default is 0 (disabled).
Boolean: Enables or disables right-to-left layout when the value of RightToLeft is Yes
Boolean: Returns or sets whether the scrollbar is visible. When the scrollbar is hidden, the user can still scroll using touch events, the keyboard, or the wheel.
Boolean: Returns or sets a value that indicates whether you have provided your own data-management operations for the DataRepeater control.
Adds a new DataRepeaterItem to the DataRepeater control.
Throws:
ReadOnlyException The AllowUserToAddItems property is set to False.
Allows users to cancel an edit to the current child control in the current DataRepeaterItem.
Forces a full reload of the data displayed by this DataRepeater.
Forces a full reload of the data displayed by this DataRepeater.
refreshChildren
True to also refresh all the children of this control.
Removes a DataRepeaterItem at the specified position from a DataRepeater control.
index
The index of the .
Throws:
ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.
Resets the value of ItemBorderStyle to the original value.
Resets the value of ItemHeaderSize to the original value.
Resets the value of ItemHeaderVisible to the original value.
Scrolls the specified DataRepeaterItem into view.
index
The index of the .
Throws:
ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.
Scrolls a specified DataRepeaterItem into view, optionally aligning it with the top of the control.
index
The index of the .
alignWithTop
true to align the top of the with the top of the control; otherwise, false.
Throws:
ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.
EventHandler Fired when the AllowUserToAddItems property changes.
EventHandler Fired when the AllowUserToDeleteItems property changes.
EventHandler Fired when the property CurrentItemIndex changes.
DataRepeaterDataErrorEventHandler Fired when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.
EventHandler Fired when the DataMember property changes.
EventHandler Fired when the DataSource property changes.
DataRepeaterItemEventHandler Fired after the DataRepeaterItem and its controls are cloned from the ItemTemplate.
DataRepeaterItemCloneEventHandler Fired before the DataRepeaterItem and its controls are cloned from the ItemTemplate.
DataRepeaterAddRemoveItemsEventHandler Fired when a new DataRepeaterItem is added to the DataRepeater control.
DataRepeaterItemEventHandler Fired after the DataRepeaterItem becomes the current item.
DataRepeaterAddRemoveItemsEventHandler Fired when a DataRepeaterItem is deleted from the DataRepeater control.
DataRepeaterItemEventHandler Fired when an instance of DataRepeaterItem is updated.
DataRepeaterItemValueEventHandler Fired when the VirtualMode property is set to true and a new value for a child control of a DataRepeaterItem is needed.
DataRepeaterItemValueEventHandler Fired when the VirtualMode property is set to true and the value of a child control in the DataRepeaterItem changes.
EventHandler Fired when the LayoutStyle property changes.
EventHandler Fired when the VirtualMode property is set to true and the user creates a new DataRepeaterItem.
DataRepeaterAddRemoveItemsEventHandler Fired when the user adds a new DataRepeaterItem.
DataRepeaterAddRemoveItemsEventHandler Fired after the user deletes a DataRepeaterItem.
DataRepeaterAddRemoveItemsCancelEventHandler Fired when the user deletes a DataRepeaterItem.
EventHandler Fired when the VirtualMode property changes.
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.DataObject
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Implements a basic data transfer mechanism.
public class DataObject : IDataObjectPublic Class DataObject
Inherits IDataObjectInitializes a new instance of the DataObject class.
Initializes a new instance of the DataObject class and adds the specified object to it.
data
The data to store.
Initializes a new instance of the DataObject class and adds the specified object in the specified format.
format
The format of the specified data. See for predefined formats.
data
The data to store.
Indicates whether the data object contains data in the WaveAudio format.
Returns: Boolean. true if the data object contains audio data; otherwise, false.
Indicates whether the data object contains data that is in the FileDrop format or can be converted to that format.
Returns: Boolean. true if the data object contains a file drop list; otherwise, false.
Indicates whether the data object contains data that is in the Bitmap format or can be converted to that format.
Returns: Boolean. true if the data object contains image data; otherwise, false.
Indicates whether the data object contains data in the UnicodeText format.
Returns: Boolean. true if the data object contains text data; otherwise, false.
Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: Boolean. true if the data object contains text data in the specified format; otherwise, false.
Retrieves an audio stream from the data object.
Returns: Stream. A Stream containing audio data or null if the data object does not contain any data in the WaveAudio format.
Returns the data associated with the specified class type format.
format
A representing the format of the data to retrieve.
Returns: Object. The data associated with the specified format, or null.
Returns the data associated with the specified data format.
format
The format of the data to retrieve. See for predefined formats.
Returns: Object. The data associated with the specified format, or null.
Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format.
format
The format of the data to retrieve. See for predefined formats.
autoConvert
true to the convert data to the specified format; otherwise, false.
Returns: Object. The data associated with the specified format, or null.
Determines whether data stored in this DataObject is associated with, or can be converted to, the specified format.
format
A representing the format to check for.
Returns: Boolean. true if data stored in this DataObject is associated with, or can be converted to, the specified format; otherwise, false.
Returns the data associated with the specified class type format.
format
A representing the format of the data to retrieve.
Returns: Boolean. The data associated with the specified format, or null.
Determines whether this DataObject contains data in the specified format or, optionally, contains data that can be converted to the specified format.
format
The format to check for. See for predefined formats.
autoConvert
true to determine whether data stored in this can be converted to the specified format; false to check whether the data is in the specified format.
Returns: Boolean. true if the data is in, or can be converted to, the specified format; otherwise, false.
Returns a list of all formats that data stored in this DataObject is associated with or can be converted to.
Returns: String[]. An array of type String, containing a list of all formats that are supported by the data stored in this object.
Returns a list of all formats that data stored in this DataObject is associated with or can be converted to, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to.
autoConvert
true to retrieve all formats that data stored in this is associated with, or can be converted to; false to retrieve only native data formats.
Returns: String[]. An array of type String, containing a list of all formats that are supported by the data stored in this object.
Retrieves an image from the data object.
Returns: Image. An Image representing the image data in the data object or null if the data object does not contain any data that is in the Bitmap format or can be converted to that format.
Retrieves text data from the data object in the UnicodeText format.
Returns: String. The text data in the data object or Empty if the data object does not contain data in the UnicodeText format.
Retrieves text data from the data object in the format indicated by the specified TextDataFormat value.
format
One of the values.
Returns: String. The text data in the data object or Empty if the data object does not contain data in the specified format.
Adds a Byte array to the data object in the WaveAudio format after converting it to a Stream.
audioBytes
A array containing the audio data.
Throws:
ArgumentNullException audioBytes is null.
Adds a Stream to the data object in the WaveAudio format.
audioStream
A containing the audio data.
Throws:
ArgumentNullException audioStream is null.
Adds the specified object to the DataObject using the object type as the data format.
data
The data to store.
Adds the specified object to the DataObject using the specified type as the format.
format
A representing the format associated with the data.
data
The data to store.
Adds the specified object to the DataObject using the specified format.
format
The format associated with the data. See for predefined formats.
data
The data to store.
Adds the specified object to the DataObject using the specified format and indicating whether the data can be converted to another format.
format
The format associated with the data. See for predefined formats.
autoConvert
true to allow the data to be converted to another format; otherwise, false.
data
The data to store.
Adds a url using DownloadURL format. The specified url is parsed to compose the DownloadURL as: "mime-type:file-name:url".
url
The url to the file to download.
fileName
The name of the file to download from the url.
Adds a collection of file names to the data object in the FileDrop format.
filePaths
A containing the file names.
Throws:
ArgumentNullException filePaths is null.
Adds an Image to the data object in the Bitmap format.
image
The to add to the data object.
Throws:
ArgumentNullException image is null.
Adds text data to the data object in the UnicodeText format.
textData
The text to add to the data object.
Throws:
ArgumentNullException textData is null or Empty.
Adds text data to the data object in the format indicated by the specified TextDataFormat value.
textData
The text to add to the data object.
format
One of the values.
Throws:
ArgumentNullException textData is null or Empty.
Provides a format-independent mechanism for transferring data.
Wisej.Web.Application
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Represent a Wisej application session. Provides methods and events to manage the application in the context of the current session.
public class Application : IWisejComponent, IDisposable, IWisejSynchronizedPublic Class Application
Inherits IWisejComponent
Implements IDisposable, IWisejSynchronizedThis class provides several static methods, properties and events that allow the application to manage all sorts of features related to the current session:
Save and retrieve session variable. Use Session to store and retrieve session variable. The property is a dynamic object and a Dictionary, therefore you can access its properties directly or through the indexer.
Application.Session.myValue = 12;
Application.Session["myValue"] = 12;
Manage cookies. Use Cookies to manage browser's cookies.
Read server variables. Use ServerVariables to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: ServerPort, ServerName, UserAgent, etc.
Read the application's URL. Use Uri, Url, StartupUri, and StartupUrl.
Read the applications's system information. Use StartupPath, ProductName, ProductVersion, etc.
Listen to the application's global events. See SessionTimeout , BeginRequest, ApplicationStart, ApplicationExitApplicationRefresh, BrowserSizeChangedResponsiveProfileChanged, CultureChanged, and many more.
Manage all live components in the session. Through the Application class you can find, iterate, inspect all live components of any type. See OpenForms for all the currently created (visible or invisible) instances of Form. OpenPages returns all the created Page objects. FindComponent and FindComponents provide an easy way to find any component in the session or to iterate the list of components that match a custom expression.
Start background tasks in context. StartTask provides a powerful way to start a background task on the server that can keep interacting with the client browser while running independently.
Manage the application's theme. Use LoadTheme to load a Wisej theme into the application. Or use the Theme object to read all sorts of information from the current ClientTheme.
Terminate the application without waiting for the session to timeout. Use Exit to terminate the current session and free all the related memory.
There is a lot more exposed by the Application class. You can inspect all the properties and methods in Visual Studio through IntelliSense or online at docs.
ClientProfile: Returns or sets the current client responsive profile.
This is the profile that best matches the current browser on the client. It is updated automatically on every request.
ClientBrowser: Returns or sets the client browser information.
UInt32: Returns the unique client "fingerprint" ID. It can be used to distinguish client devices.
The client fingerprint is generated by hashing all the available information returned by the browser (OS, user agent, version, etc.) and it's not guaranteed to be unique.
String: Returns the path for the application data that is shared among all users.
RegistryKey: Returns the registry key for the application data that is shared among all users.
String: Returns the company name associated with the application stored in the AssemblyCompanyAttribute.
Configuration: Returns the current Configuration.
CookieCollection: Collection of cookies.
IWisejComponent: Returns the application component instance that an application can store and use later to restore the context when updating client widgets during an out-of-bound call using Update
Threads that are not started using StartTask don't have any knowledge of the current session and don't have a way to communicate with the client The Current property returns the instance of the Application class that is bound to the current session. It can be used just like any other component with Update or RunInContext to restore the session for the current thread. The advantage of using Current instead of the instance of a control or a page is to avoid to keep a reference to a component that may be disposed by the application.
var current = Application.Current;
var thread = new Thread(() => {
Application.Update(current, () => {
// code here is running in context.
});
});CultureInfo: Returns or sets the current CultureInfo for the session.
Desktop: Returns or sets the current Desktop.
Boolean: Returns or sets whether the browser will ask the user to confirm unloading the current page.
This property attaches the window.onbeforeunload event. See https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeunload. It's not possible to determine whether the page is being unloaded because the user is trying to close the tab, close the browser, or is refreshing the page, or is taking any other action that may reload the page.
String: Returns the path for the application's main assembly.
Image: Returns or sets the favicon to display in the browser.
String: Returns or sets the URL to the favicon to display in the browser.
String: Returns or sets the hash part of the URL on the client.
Boolean: Returns a value indicating whether the session has been authenticated.
Boolean: Indicates that the current application instance, which corresponds to the session, has been terminated and disposed.
Boolean: Returns true when the current session has expired.
Boolean: Returns true if this session is running in secure mode (https:// and wss://)
Boolean: Returns true when the current session has been terminated.
Boolean: Returns true if the current session is connected using WebSocket.
String: Returns or sets the runtime server license key.
Setting the LicenseKey programmatically has to be done before the application is loaded. The best place is the static constructor for the Program static class, or the static constructor of the main window (if defined in Default.js).
static class Program
{
static Program()
{
Application.LicenseKey = "...";
}
}Page: Returns or sets the current full page window.
FormCollection: Returns a collection of open forms owned by the application.
PageCollection: Returns a collection of open pages owned by the application.
ClientPlatform: The name of the currently loaded platform.
String: Returns the product name associated with this application.
String: Returns the product version associated with this application stored either in AssemblyInformationalVersionAttribute or AssemblyFileVersionAttribute.
NameValueCollection: Returns the parameters used to launch the application.
Boolean: Returns or sets whether all the controls in the applications should operate using the right-to-left mode.
The value of this property is updated automatically when the current language changes if the value of "rightToLeft" in the application configuration file is set to "auto".
Boolean: Returns true when the application is running in not in design, debug or test mode.
String: Returns the server's host name, DNS alias, or IP address as it would appear in self-referencing URLs.
Int32: Returns the port number to which the request was sent.
NameValueCollection: Returns the server variables.
Object: Provides a generic storage for session-based objects.
Int32: Returns the total number of currently active sessions.
String: Returns the unique current session ID.
Boolean: Shows or hides the debug console on the browser.
Displays a simple HTMl only debug console. Works with any browser also when the developer tools are not available.
Boolean: Returns or sets whether the browser is blocked by the Ajax loader.
String: Returns the root path of the web application.
Uri: Returns the URI used to start the application.
String: Returns the URL used to start the application.
ClientTheme: Returns or sets the current ClientTheme.
You can create and modify a new custom theme using the ClientTheme class. The new theme can be based on an existing theme, can be empty, or can be initialized from a JSON string.
// create a new custom theme cloned from the current theme.
var myTheme = new ClientTheme("MyTheme", Application.Theme);
// alter the buttonFace color.
myTheme.Colors.buttonFace = "red";
// update the current session using the new custom theme.
Application.Theme = myTheme;You may also alter a global theme shared by all sessions.
// change the buttonFace color in the current theme.
// if the theme is one of the global themes, i.e. it was loaded
// using Application.LoadTheme(name), then the change is also global.
Application.Theme.Colors.buttonFace = "red";
// since the theme objects are all dynamic and use a special DynamicObject
// class part of the Wisej Framework, you can also use a string indexer
// to address any field.
Application.Theme.Colors["buttonFace"] = "red";
String: Returns or sets the page title in the browser.
Uri: Returns the current Uri used either to launch or reload the application. It may be different from StartupUri.
String: Returns the current URL used either to launch or reload the application. It may be different from StartupUrl.
IPrincipal: Returns the security information for the current request.
String: Returns the raw user agent string of the client browser.
String: Returns the IP host address of the remote client.
String: Gets the DNS name of the remote client.
WindowsIdentity: Returns the WindowsIdentity type for the current user.
String[]: Gets a sorted string array of client language preferences.
Adds an event filter to monitor all the incoming events before they are routed to their respective component.
filter
An object that implements the interface to add to the filter list.
Adds the text and corresponding translation to the default locale on the client.
text
The text to translate.
translation
The translation override.
Executes the JavaScript function on the client.
function
The name of the function to execute.
args
The arguments to pass to the function.
Executes the JavaScript function on the client and receives the return value (or null) in the callback method.
function
The name of the function to execute.
callback
Asynchronous callback method that receives the return value.
args
The arguments to pass to the function.
Asynchronously executes the JavaScript function on the client and returns an awaitable Task with the result of the remote call.
function
The name of the function to execute.
args
The arguments to pass to the function.
Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.
Cancels the fullscreen mode.
Downloads the specified file on the client.
filePath
The file to download.
fileName
The name of the file to save on the client.
Downloads the specified image to the client.
image
The image to download.
fileName
The name of the file to save on the client.
Downloads the bytes in the stream to the client.
stream
The stream to send to the client.
fileName
The file name the client will use to save the stream.
Downloads the specified file on the client.
target
Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.
filePath
The file to download.
fileName
The name of the file to save on the client.
Downloads the specified image to the client.
target
Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.
image
The image to download.
fileName
The name of the file to save on the client.
Downloads the bytes in the stream to the client.
target
Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.
stream
The stream to send to the client.
fileName
The file name the client will use to save the stream.
Stops the polling requests from the client.
Executes the JavaScript script on the client.
script
The script to evaluate.
Executes the JavaScript script on the client and receives the return value (or null) in the callback method.
script
The script to evaluate.
callback
Asynchronous callback method that receives the return value.
Asynchronously executes the JavaScript script on the client and returns an awaitable Task with the result of the remote call.
script
The script to evaluate.
Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.
Terminates the application and the corresponding session.
Find the first component that matches the conditions defined in the predicate function.
match
A custom expression used to match the to find.
Returns: IWisejComponent. The first IWisejComponent qualified by the match expression.
This method lets an application find any live component in the current session.
// Find the first component that is a Button with Text = "OK"
var button = Application.FindComponent(c => c is Button && ((Button)c).Text == "OK");Finds all the components that match the conditions in the predicate function.
match
A custom expression used to match the list of objects to find.
Returns: IList<IWisejComponent>. The list of IWisejComponent instances qualified by the match expression.
This method lets an application iterate through all the live components in the current session.
// List all text boxes that are read only in all forms.
var list = Application.FindComponents(c => c is TextBox && ((TextBox)c).ReadOnly);Loads an assembly given the file name or path.
filePath
The file name or full path for the assembly to load.
Returns: Assembly. The loaded Assembly.
This method loads the assembly and, if the assembly contains Wisej components that need embedded resources - like JavaScript classes or CSS styles - that are embedded in the assembly, notifies the client with the URL to load the additional resources dynamically.
Creates an instance of the specified component from the assembly.
filePath
The file name or full path for the assembly to load.
className
Returns: IWisejComponent. An instance of a Wisej component implementing the IWisejComponent interface.
packages
callback
packages
Returns: Task<Boolean>.
Changes the current theme.
name
Name of the theme resource. Use only the name without the path and without the extension.
mixins
Optional list of theme mixins. If null, the default theme mixins are always applied.
Returns the full file path in relation to the application's project directory.
path
Returns: String. The full path relative to the current application's root directory.
Navigate to the specified URL.
url
URL to navigate to.
target
The target browser window: _self, _blank, etc.
Plays one of the built-in sounds
type
One of value that identifies the sound to play.
Plays a sound.
soundUrl
A string representing either a sound file URL or a base64 data URL.
Executes the callback method after all processing is completed and before updating the client.
callback
Method to invoke after the request has completed but before sending the response to the server.
The Post() method is similar to the BeginInvoke() method used by desktop applications. It allows you to execute a block of code out of sync with the current execution flow.
void Test() {
Application.Post(() => {
this.listBox.Items.Add("1");
});
this.listBox.Items.Add("2");
// The items will be added in this order: "2", "1".
}
Prints the specified window.
window
The window to print
The window is printed without the caption or the borders, if present.
Prints the entire browser window.
Causes the application to reload on the browser.
Removes the filter from the list of registered event filters.
filter
An object that implements the interface to remove from the filter list.
Requests the browser to enable fullscreen mode if supported.
Executes the callback in context.
context
The application context to update. It can be any Wisej component or the returned by the property .
action
Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.
Instructs the client to start polling the server for UI changes at the specified interval when a WebSocket connection is not available.
interval
Polling interval in milliseconds. The minimum is 1000ms.
Calling this method when IsWebSocket is true has no effect. Use client side polling when you know that your code will start a background task that needs to update the client asynchronously (push updates) and your server or clients don't support WebSocket connections. Once the background tasks are completed call EndPolling to reduce the incoming requests from the client.
// this has not effect when the client and server are connected using WebSocket.
Application.StartPolling(1000);
Application.StartTask(() => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
Thread.Sleep(1000);
}
// this has not effect when the client and server are NOT connected using WebSocket.
Application.Update(this);
// this has not effect when the client and server are connected using WebSocket.
Application.EndPolling();
});Throws:
ArgumentOutOfRangeException The interval specified is less than 1.
Starts a new task within the current application context and returns immediately. See also BackgroundTasks.
action
Start method invoked by the new task when it starts up.
Returns: Task. An awaitable Task.
The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the Update method to push the UI updates to the client browser. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a Timer component to the parent container to force period requests to the server, or you can use the StartPolling and EndPolling methods.
Application.StartTask(() => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
// just wait a bit or it's too fast.
Thread.Sleep(1000);
Application.Update(this);
}
});Starts a new task with a return value within the current application context and returns immediately. See also BackgroundTasks.
T
action
Start method invoked by the new task when it starts up.
Returns: Task<T>.
The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the Update method to push the UI updates to the client browser. The generics overload of StartTask allows the task to return a value. You can use this with the async/await pattern and asynchronously wait for the task to complete. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a Timer component to the parent container to force period requests to the server, or you can use the StartPolling and EndPolling methods.
string text = await Application.StartTask(() => {
string value = "";
for (int i = 0; i < 100; i++) {
value += i.ToString();
// just wait a bit or it's too fast.
Thread.Sleep(100);
}
return value;
});
this.label.Text = text;
Application.Update(this);
Note that you don't have to specify the type in the angular brackets, the compiler will automatically detect the type from the return value of the asynchronous function.
Starts a Timer bound to the current session context.
dueTime
The amount of time, in milliseconds, to delay before invoking the callback .
period
The time interval between invocations, in milliseconds.
callback
A callback method to invoke at the specified intervals.
Returns: Timer. An instance of Timer.
You must save a reference to the returned Timer or the Garbage Collector will stop and dispose the timer. To alter the invocation period user Timer.Changer(), or stop the timer simply use Timer.Dispose(). See system.threading.
Executes the optional callback in context and pushes all the pending updates to the client when in WebSocket mode.
context
The application context to update. It can be any Wisej component or the returned by the property .
action
Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.
Use this method when you need to update the client asynchronously from an out-of-bound thread (different thread, not originating from a client request). You can call this method at the end of the code that updates the UI:
Application.StartTask(() => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
// just wait a bit or it's too fast.
Thread.Sleep(1000);
}
Application.Update(this);
});Or you can use the optional action function to enclose the code that updates the UI in a block and ensure that the client is updated when the code block exits:
Application.StartTask(() => {
Application.Update(this, () => {
for (int i = 0; i < 100; i++) {
this.label1.Text = "Counting..." + i;
// just wait a bit or it's too fast.
Thread.Sleep(1000);
}
});
});EventHandler Fired when the active window changes.
EventHandler Fired when the application is about to shut down.
EventHandler Fired when the application is reloaded in the browser because the user hit refresh or changed the URL.
EventHandler Fired when the application is started, after the Main method is called.
EventHandler Fired when the browser fires the "beforeinstallprompt" event. Corresponds to BeforeInstallPromptEvent.
EventHandler Fired at the beginning of every request.
EventHandler Fired when the user resizes the browser.
EventHandler Fired when the user activates the browser tab.
EventHandler Fired when the user deactivates the browser tab.
EventHandler Fired when the CurrentCulture changes.
EventHandler Fired at the end of every request.
EventHandler Fired when the focused control changes.
HashChangedEventHandler Fired when the hash part of the URL changes on the client side.
EventHandler Fired when the current thread has completed processing all the events and before the response is sent back to the client.
ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.
EventHandler Fired when the RightToLeft value changes.
HandledEventHandler Fired when the session is about to time out.
The default behavior built-in Wisej is to display a dialog asking the user to prolong the session. Set Handled to true to stop the default behavior.
EventHandler Fired when the current theme is changed.
ThreadExceptionEventHandler Fired when a thread exception is thrown.
All wisej components implement this interface.
Wisej.Web.Control
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.2.0.0)
Base class for all Wisej controls.
public class Control : IWisejControl, IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfilesPublic Class Control
Inherits IWisejControl
Implements IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfilesInitializes a new instance of the Control class.
String: Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element.
String: Returns or sets the name of the control for use by accessibility client applications. It is assigned to the "name" attribute of the browser element.
AccessibleRole: Returns or sets the accessible role of the control that will be reported to accessibility client applications. It is assigned to the "role" attribute of the browser element.
Boolean: Returns or sets whether the control can initiate a drag-drop operation.
Boolean: Returns or sets whether the control can accept data that the user drags onto it.
AnchorStyles: Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.
Boolean: Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents.
Color: Returns or sets the background color for the control.
Image: Returns or sets the background image displayed in the control.
ImageLayout: Returns or sets the background image layout as defined in the ImageLayout enumeration.
String: Returns or sets the background image displayed in the control.
Boolean: Returns a flag indicating that the control is becoming the active control.
Boolean: Determines whether the control can execute a command.
Boolean: Returns whether the control can receive focus.
Boolean: Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus.
ClientEventCollection: Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event.
You can use this collection at design time or in code or through the listener methods:
Boolean: Indicates whether the control, or one of its child controls, has the input focus.
ContextMenu: Returns or sets the shortcut menu associated with the control.
ControlCollection: Returns the collection of controls contained within the control.
String: Returns or sets additional CSS class names to add to the widget.
Use this property to add or remove custom CSS classes that you may add to your application as standard css files or through the StyleSheet extender. You can assign multiple class names separated by a space and you can manage this property using the related methods:
String: Returns or sets the custom CSS styles to add to the widget.
You can use any CSS style string.
// set the border radius to 100% and make the control round.
this.button1.CssStyle = "border-radius:100%";
Cursor: Returns or sets the cursor that is displayed when the mouse pointer is over the control.
ControlBindingsCollection: Returns the data bindings for the control.
Color: Returns the default background color of the control.
Font: Returns the default font of the control.
Color: Returns the default background color of the control.
Rectangle: Returns the rectangle that represents the virtual display area of the control.
DockStyle: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
Boolean: Returns or sets whether the control can respond to user interaction.
Boolean: Enables or disables the browser's context menu.
Boolean: Returns or sets whether the control can gain the focus.
Boolean: Returns a value indicating whether the control has input focus.
Font: Gets or sets the font of the text displayed by the control.
Color: Returns or sets the text color of the control.
IntPtr: Returns the unique server-side id (handle) for this component.
Boolean: Returns whether the control specifies data bindings.
Boolean: Check if the control defines any responsive profile without forcing the creation of the collection.
Boolean: Checks if the UserData dynamic object was created and has any value.
Int32: Returns or sets the height of the control.
String: Returns or sets an initialization script to execute when the widget is created (or reloaded) in the browser.
Use this property to add custom initialization JavaScript that is always executed when the client widget is created. The context (this) of the script is the instance of the widget. You can use the entire qooxdoo and wisej.js api. See #qx and wisej-js.
// change the background color of the internal label of the button widget.
this.button1.InitScript = "this.getChildControl('label').setBackgroundColor('red')";
// attach a JavaScript event handler.
this.textBox1.InitScript = @"this.addListener('keydown', function(e) {
if (e.getKeyIdentifier() == "PageDown") {
alert('You pressed PageDown.');
}
});
You may also use the init script to attach events to the widget or to its internal children. Event handlers can also be attached using the ClientEvents collection and the client events methods:
Boolean: Returns if the control has a server-side component id (handle) associated with it.
Boolean: Returns whether the control is mirrored.
LayoutEngine: Returns the control's layout engine.
Int32: Returns or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
Point: Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
Padding: Returns or sets the space between controls.
Size: Returns or sets the maximum size for the control.
Size: Returns or sets the minimum size for the control.
Keys: Returns a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
MouseButtons: Returns a value indicating which of the mouse buttons is in a pressed state.
Point: Returns the position of the mouse cursor in screen coordinates.
Boolean: Returns or sets whether the control can be moved by dragging.
String: Gets or sets the name of the control.
Padding: Returns or sets padding within the control.
Control: Returns or sets the parent container of the control.
Size: Returns the preferred size in which the control can fit.
AnchorStyles: Returns or sets the edges of the control that can be dragged to resize the control.
ResponsiveProfileCollection: Returns the collection of responsive properties that have been set for this control.
RightToLeft: Returns or sets whether the control's elements are aligned right-to-left to support RTL languages.
When set to Inherit, the control inherits the value of this property from its parent. However, when the control is a top-level control (i.e. Window, Page, Desktop), and the value is set to Inherit, the right-to-left mode is automatically retrieved from the current language.
Boolean: Returns or sets whether the control is blocked by the ajax loader.
Size: Returns or sets the height and width of the control.
String[]: Returns or sets additional theme states to the client widget.
Use this property to manage additional custom states that you may want to add to a widget. The state will update the visualization of the widget using the styles and properties set in the current theme and loaded theme mixins. You can also force the usage of built-in states. However, this property will not return the current states of the widget as updated by the client browser. It only returns the states set by the application.
// force the widget to update the UI as if it was hovered and focused.
this.button1.States = new [] { "hovered", "focused" };
// apply a custom state defined in a custom theme or theme mixing.
this.panel1.States = new [] { "alert" };In addition to setting this property directly, you can also manage it using the related methods:
Int32: Returns or sets the tab order of the control within its container.
Boolean: Returns or sets whether the user can give the focus to this control using the TAB key and the Focusable property is set to true.
Object: Returns or sets the object that contains data about the control.
String: Returns or sets the text associated with this control.
When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with " ".
String: Returns or sets the tooltip text to show for this control.
When using ToolTipText property you can only set the ToolTip text and cannot change the default ToolTip icon set in the theme. To change the ToolTip icon you can either create a custom theme, or a theme mixin, or use the ToolTip extender and the ToolTip property added by the extender. You can change the default ForeColor, AutomaticDelay, InitialDelay, AutoPopDelay, or enable HTML in ToolTipText by using a ToolTip extender also without setting the ToolTip property added by the extender.
Int32: Returns or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
Object: Returns a dynamic object that can be used to store custom data in relation to this control.
Boolean: Returns or sets whether to use the wait cursor for the current control and all child controls.
Boolean: Returns a flag indicating that the validation has been canceled.
Boolean: Returns or sets whether the control and all its child controls are displayed.
Int32: Returns a value indicating the wheel delta from the last wheel event.
Int32: Returns or sets the width of the control.
Adds a new listener script to the event name to the client widget.
name
Name of the client event to attach the listener to.
script
JavaScript code to execute when the event occurs.
Returns: Int32. An integer id that you can use to remove the listener from the event using RemoveClientEventListener or to retrieve the listener script code using GetClientEventListener.
The script will execute in the browser when the event name occurs. You can attach multiple listeners to the same event.
Adds the CSS class name to the widget element. If the class already exists in the CssClass it's not added.
name
Name of the css class to add.
Returns: String. The new value of the CssClass property.
Adds the specified theme state to the widget.
state
Name of the custom state to add to the widget.
Returns: String[]. The new list of states stored in the States property.
You can also assign a new array of states to the States property.
Executes the specified delegate asynchronously.
method
A delegate to a method that takes no parameters.
args
An optional array of objects to pass as arguments to the specified method.
Returns: IAsyncResult. An IAsyncResult that represents the result of the asynchronous call.
Brings the control to the front of the z-order.
Runs the JavaScript function within the component's context in the browser.
function
The name of the JavaScript function to execute.
args
The arguments to pass to the function.
Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.
function
The name of the JavaScript function to execute.
callback
Asynchronous callback method that receives the return value.
args
The arguments to pass to the function.
Asynchronously runs the JavaScript function within the component's context in the browser and returns an awaitable Task containing the value returned by the remote call.
function
The name of the JavaScript function to execute.
args
The arguments to pass to the function.
Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.
Centers the position of the control within the bounds of the parent.
Centers the position of the control within the bounds of the parent either horizontally, vertically or both.
horizontal
Center horizontally.
vertical
Center vertically.
Indicates whether the specified control is a child of this control.
control
The child to find.
Returns: Boolean. true if the specified control is a child of the control; otherwise, false.
Creates and register this control and all its children.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
One of the values.
Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
One of the values.
imageSource
The name or URL for an image to use as the drag cursor.
Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
One of the values.
imageSource
The name or URL for an image to use as the drag cursor.
imageSize
The size of the drag image specified in imageSource.
Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
One of the values.
image
An to use as the drag cursor.
Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.
Begins a drag-and-drop operation.
data
The data to drag.
allowedEffects
One of the values.
image
An to use as the drag cursor.
imageSize
The size of the drag image specified in image.
Returns: DragDropEffects. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.
Runs the javaScript code within the component's context in the browser.
javaScript
The JavaScript code to run on the client.
Runs the javaScript code within the component's context in the browser and returns the value to the callback method.
javaScript
The JavaScript code to evaluate on the client.
callback
Asynchronous callback method that receives the return value.
Asynchronously runs the javaScript code within the component's context in the browser and returns an awaitable Task that contains the value returned by the remote call.
javaScript
The JavaScript code to evaluate on the client.
Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.
Retrieves the form that the control is on.
Returns: Form.
Retrieves the page that the control is on.
Returns: Page.
Sets input focus to the control.
Returns: Boolean. true if the input focus request was successful; otherwise, false.
Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
pt
A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
skipValue
One of the values of , determining whether to ignore child controls of a certain type.
Returns: Control. The child Control at the specified coordinates.
Retrieves the child control that is located at the specified coordinates.
pt
A that contains the coordinates where you want to look for a control. Coordinates are expressed relative to the upper-left corner of the control's client area.
Returns: Control. A Control that represents the control that is located at the specified point.
Returns the script associated to the listener identified by id .
id
Id of the listener to retrieve the script for.
Returns: String. JavaScript associated with the listener.
Returns the scripts for all the listeners attached to the event name .
name
Name of the event.
Returns: String[]. String array containing the scripts for the listeners attached to the event.
Returns the next IContainerControl up the control's chain of parents.
Returns: IContainerControl. The parent IContainerControl.
Retrieves the next control forward or back in the tab order of child controls.
control
The to start the search with.
forward
true to search forward in the tab order; false to search backward.
Returns: Control. The next Control in the tab order.
Retrieves the value of the specified control style bit for the control.
flag
The bit to return the value from.
Returns: Boolean. true if the specified control style bit is set to true; otherwise, false.
Checks whether the specified event name has any listener attached.
name
Name of the client event to verify.
Returns: Boolean. True if the event name has any listener attached.
Returns true if the property CssClass contains the specified class name .
name
Css class name to verify.
Returns: Boolean. True of the css class name is already included in CssClass.
Checks whether the specified theme state is present in the States property.
state
Name of the state to check.
Returns: Boolean. True if the widget already has the state .
Conceals the control from the user.
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
invalidateChildren
When true, invalidates all the children of the control.
Executes the specified delegate.
method
A delegate that contains a method to be called in the control's thread context.
Returns: Object. The return value from the delegate being invoked, or null if the delegate has no return value.
Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
method
A delegate to a method that takes parameters of the same number and type that are contained in the args parameter.
args
An array of objects to pass as arguments to the specified method. This parameter can be null if the method takes no arguments.
Returns: Object. An Object that contains the return value from the delegate being invoked, or null if the delegate has no return value.
Determines whether the specified character is the mnemonic character.
charCode
The character to test.
text
The string to search.
Returns: Boolean. true if the charCode character is the mnemonic character; otherwise, false.
Computes the location of the specified screen point into client coordinates.
point
The screen coordinate to convert.
Returns: Point. A Point that represents the converted Point, point , in client coordinates.
Computes the location of the specified client point into screen coordinates.
point
The client coordinate to convert.
Returns: Point. A Point that represents the converted Point, point , in screen coordinates.
Computes the size and location of the specified screen rectangle in client coordinates.
rect
The screen coordinate to convert.
Returns: Rectangle. A Rectangle that represents the converted Rectangle, rect , in client coordinates.
Computes the size and location of the specified client rectangle in screen coordinates.
rect
The client coordinate to convert.
Returns: Rectangle. A Rectangle that represents the converted Rectangle, rect , in screen coordinates.
Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control, including the non-client areas such as the caption of forms or panels.
Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.
refreshChildren
True to also refresh all the children of this control.
Detaches and removes the listener identified by id .
id
Id of the listener to remove.
Returns: Boolean. True if the id specified a valid lister and it was removed; otherwise false if id is invalid.
Removes all the listeners attached to the event name .
name
Name of the event.
Returns: Boolean. True if the event name has any listener that was removed.
Removes the specified css class name from the control's CssClass property.
name
The css class name to remove.
Returns: String. The new value of the CssClass property.
Removes the specified theme state from the widget.
state
Name of the state to remove.
Returns: String[]. The new list of states stored in the States property.
You can also assign a new array of states to the States property.
Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.
Resumes layout logic.
Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.
performLayout
true to apply all pending layout requests; otherwise, false.
Scrolls the control into view in the container using the specified alignX and alignY preferences.
alignX
Indicates the preference. The final location of the control depends on the scrollable range and the available space. Note that will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.
alignY
Indicates the preference. The final location of the control depends on the scrollable range and the available space. Note that will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.
Scrolls the child control into view.
Activates a control.
Activates the next control in the list according to the specified selection rules.
control
The at which to start the search.
forward
true to move forward in the tab order; false to move backward in the tab order.
tabStopOnly
true to ignore the controls with the property set to false; otherwise, false.
nested
true to include nested (children of child controls) child controls; otherwise, false.
wrap
true to continue searching from the first control in the tab order after the last control has been reached; otherwise, false.
Returns: Boolean. true if a control was activated; otherwise, false.
Sends the control to the back of the z-order.
Sets the bounds of the control to the specified location and size.
x
The new property value of the control.
y
The new property value of the control.
width
The new property value of the control.
height
The new property value of the control.
Sets the specified bounds of the control to the specified location and size.
x
The new property value of the control.
y
The new property value of the control.
width
The new property value of the control.
height
The new property value of the control.
specified
A bitwise combination of the values. For any parameter not specified, the current value will be used.
Displays the control to the user.
Suspends the layout logic for the control.
Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Validates all selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See Selectable for details of exactly which child controls will be validated.
Returns: Boolean.
Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .
flags
Returns: Boolean.
EventHandler Fired after the control has been fully rendered on the client.
This is a "lazy" event. It fires only when there is an handler attached to it, otherwise the companion On{Name} protected method is not invoked. It's enough to attach to either one of Appear or Disappear to enable both events.
EventHandler Fired when the AutoSize property value changes.
EventHandler Fired when the value of the BackColor property changes.
EventHandler Fired when the value of the BackgroundImage property changes.
EventHandler Fired when the BackgroundImageLayout property changes.
EventHandler Occurs when the value of the BindingContext property changes.
EventHandler Fired when the value of the CausesValidation property changes.
EventHandler Fired when the control is clicked.
EventHandler Fired when the ClientSize property value changes.
EventHandler Fired when the value of the ContextMenu property changes.
EventHandler Fired when a control is made visible the first time, fully created and sent to the client.
EventHandler Fired when the value of the Cursor property changes.
EventHandler Fired after the control is no longer visible on the client.
This is a "lazy" event. It fires only when there is an handler attached to it, otherwise the companion On{Name} protected method is not invoked. It's enough to attach to either one of Appear or Disappear to enable both events.
EventHandler Fired when the component is disposed.
EventHandler Fired when the value of the Dock property changes.
EventHandler Fired when the control is double-clicked.
DragEventHandler Fired when a drag-and-drop operation is completed.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when a drag-drop operation is terminated either by a drop or canceled.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
DragEventHandler Fired when an object is dragged into the control's bounds.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when an object is dragged out of the control's bounds.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
DragEventHandler Fired when an object is dragged over the control's bounds.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when a drag-drop operation is started by the user.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the Enabled property value has changed.
EventHandler Fired when a control is Movable and the user ends the move operation.
This event fires only when Movable is true and the user moves the widget on the client. It doesn't fire when the Location property changes.
EventHandler Fired when a control has ResizableEdges and the user ends the resize operation.
This event fires only when the ResizableEdges has a value different than None and the user resizes the widget on the client. It doesn't fire when the Size of the control changes.
EventHandler Fired when the control gains the input focus.
EventHandler Fired when the Font property value changes.
EventHandler Fired when the ForeColor property value changes.
HelpEventHandler Fired when the user requests help for a control by pressing F1.
EventHandler Fired when the ImeMode property has changed.
KeyEventHandler Fired when a key is pressed while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
KeyPressEventHandler Fired when a key is pressed while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
KeyEventHandler Fired when a key is released while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
LayoutEventHandler Fired when a control should reposition its child controls.
EventHandler Fired when the control loses the input focus.
EventHandler Fired when the Location property value has changed.
EventHandler Fired when a pointer holds on the screen.
EventHandler Fired when the control's margin changes.
EventHandler Fired when the control loses mouse capture.
MouseEventHandler Fired when the control is clicked by the mouse.
MouseEventHandler Fired when the control is double clicked by the mouse.
MouseEventHandler Fired when the mouse pointer is over the control and a mouse button is pressed.
EventHandler Fired when the mouse pointer enters the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the mouse pointer rests on the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the mouse pointer leaves the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
MouseEventHandler Fired when the mouse pointer is moved over the control.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
MouseEventHandler Fired when the mouse pointer is over the control and a mouse button is released.
MouseEventHandler Fired when the mouse wheel moves while the control has focus.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the control's padding changes.
PaintEventHandler Fired when a UserPaint control needs to redraw itself.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the Parent property value changes.
PinchEventHandler Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
PreviewKeyDownEventHandler Fired before the KeyDown event when a key is pressed while focus is on this control.
QueryContinueDragEventHandler Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the control is resized.
ResponsiveProfileChangedEventHandler Fired when the active responsive profile is changed.
EventHandler Fired when the RightToLeft property value changes.
RotateEventHandler Fired when two finger moved around a single point. It contains the angle of the rotation.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the Size property value changes.
EventHandler Fired when a control is Movable and the user begins the move operation.
This event fires only when Movable is true and the user begins moving the widget on the client.
EventHandler Fired when a control has ResizableEdges and the user begins the resize operation.
This event fires only when the ResizableEdges has a value different than None and the user begins resizing the widget on the client.
EventHandler Fired when the control style changed.
SwipeEventHandler Fired when a pointer swipes over the screen.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the TabIndex property value has changed.
EventHandler Fired when the value of the TabStop property changes.
EventHandler Fired when a pointer taps on the screen.
EventHandler Fired when the Text property value changes.
TouchEventHandler Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created).
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TouchEventHandler Fired when a touch point is removed from the touch surface.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TouchEventHandler Fired when a touch point is moved along the touch surface.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TouchEventHandler Fired when a touch point is placed on the touch surface.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
TrackEventHandler Fired when a pointer grabs an item and moves the pointer on it.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the control is finished validating.
CancelEventHandler Fired when the control is validating.
EventHandler Fired when the Visible property value changes.
WidgetEventHandler Fired when the control receives a custom event from the client.
JavaScript code can fire any event back to a control, including custom data, using:
this.fireWidgetEvent("myevent", {x:1, y:2, name:'test'});On the server side, the event name and event data are available in the WidgetEvent handler:
private void control_WidgetEvent(object sender, WidgetEventArgs e) {
switch (e.Type) {
case "myevent":
var data = e.Data;
Alert.Show($"x={data.x}, y={data.y}, name={data.name}");
break;
}
}UI implementation for the FileDialog class.
UI implementation for the FolderDialog class.
Displays data in a customizable list format.
Used by the control to display data at run time.
Represents a shape control. Displays an element a border in any of the four sides.
Represents a panel that dynamically arranges its child controls.
Represents a spinner control that displays values.
Represents a spacer control. It can be used to add a space between controls in a layout panel. It is not rendered on the client.
Represents a data field that displays a list of selectable and removable tags. The control recognizes tags as the user types and adds in front of the editable field.
Displays child controls vertically or horizontally in a scrollable container.
Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
Represents a button control.
Implements the basic functionality common to button controls.
Represents a check box control.
Displays a in which a check box is displayed to the left of each item.
Represents a combo box control.
Provides focus-management functionality for controls that can function as a container for other controls.
Represents a control that allows the user to select or type a date and a time.
Represents a spinner control that displays string values.
Represents a panel that dynamically arranges its children horizontally or vertically in automatic rows or columns.
Represents a window or dialog box that makes up an application's user interface.
Represents a Wisej control that displays a frame around a group of controls with an optional caption.
Represents a label control.
Represents an hyper-link control.
Represents a control to display a list of items.
Provides a common implementation of members for the and classes.
Uses a mask to distinguish between proper and improper user input.
Represents the container for multiple-document interface (MDI) child forms.
Represents a control that enables the user to select a date using a visual monthly calendar display.
Represents a spinner control that displays numeric values.
Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.
Represents a collapsible panel with an optional header that contains a group of controls.
Represents an image control.
Represents a progress control that displays a value visually as a filled bar.
Enables the user to select a single option from a group of choices when paired with other controls.
Defines a base class for controls that support auto-scrolling behavior.
Represents an horizontal scroll bar.
Represents a vertical scroll bar.
Implements the basic functionality of a scroll bar control.
Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
Creates a panel that is associated with a .
Displays information to the user in a about the object being viewed, the object's components, or the object's operation.
Manages a related set of pages.
Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.
Represents a single tab page in a .
Represents a text box control that allows the user to enter any value.
Implements the basic functionality required by text controls.
Enables the user to choose between a range of values by sliding a small bar along another bar.
Implements the basic functionality required by a spin box (also known as an up-down control).
Provides an empty control that can be used to create other controls.
Represents a web browser control that enables the user to navigate web pages inside a form or a page.
Represents a control that can be hosted in a .
Represents a control that can be hosted in a .
Represents a control that can be hosted in a cell.
Represents a control that can be hosted in a .
Represents a control that can be hosted in a cell when the cell's is set to .
Represents a data grid control.
Represents a desktop container that can host floating windows.
Displays collapsible set of panels for presenting information in a limited amount of space.
Represents a panel in a control.
Represents a control that can host ASP.NET or MVC pages within a Wisej application.
Represents the HTML5 canvas element.
Represents a control that can display flash applications.
Represents a control that displays any HTML file and a corresponding CSS style sheet as embedded HTML.
Represents a control that displays any HTML file in an IFrame element.
Represents a line control.
The TreeViewComboBox control represents a control with a as the drop down panel.
Base implementation for media controls.
Represents a control that displays a video file.
Represents a control that plays an audio file.
Represents a control that can display a pdf document in the browser either using the native pdf viewer, the pdf.js viewer, Google docs, or a custom viewer.
Represents a split button control.
The TreeViewComboBox control represents a control with a as the drop down panel.
Represent an upload widget. Allows users to selected one or more files and upload them to the server.
The UserComboBox control represents a control with a custom panel that drops down when the user clicks the down arrow.
Provides an popup container that can be attached to other controls.
Provides a generic widget that can use most third party javascript widgets.
Represents a list view control, which displays a collection of items that can be displayed using one of four different views.
Represents a menu bar component.
Provides a user interface for browsing the properties of an object.
Represents a toolbar component.
Displays a hierarchical collection of labeled items, each represented by a .
Bindable components implement this interface.
All wisej components implement this interface.
All wisej controls derived from the class must implement this interface.
Allows an object to serialize itself.