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, IWisejSynchronized

Public Class Application
    Inherits IWisejComponent
    Implements IDisposable, IWisejSynchronized

This 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.

• Retrieve browser related information. Use the Browser to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The Browser object is updated automatically when the user resizes the browser or the page is reloaded.

• Control the client browser. Start a Download, execute JavaScript functions or scriptlets using Call or Eval. Make the browser navigate to a different URL using Navigate or simply Reload the page.

• Manage the main page or current desktop. MainPage lets you change the Page object that fills the browser and "navigate" from page to page. Desktop lets you change the active Desktop object on the client browser.

• 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.

Properties

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.

Methods

Adds an event filter to monitor all the incoming events before they are routed to their respective component.

Adds the text and corresponding translation to the default locale on the client.

Executes the JavaScript function on the client.

Executes the JavaScript function on the client and receives the return value (or null) in the callback method.

Asynchronously executes the JavaScript function on the client and returns an awaitable Task with the result of the remote call.

Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.

Cancels the fullscreen mode.

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Downloads the specified file on the client.

Downloads the specified image to the client.

Downloads the bytes in the stream to the client.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

Executes the JavaScript script on the client and receives the return value (or null) in the callback method.

Asynchronously executes the JavaScript script on the client and returns an awaitable Task with the result of the remote call.

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.

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.

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.

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.

Returns: IWisejComponent. An instance of a Wisej component implementing the IWisejComponent interface.

Returns: Task<Boolean>.

Changes the current theme.

Returns the full file path in relation to the application's project directory.

Returns: String. The full path relative to the current application's root directory.

Navigate to the specified URL.

Plays one of the built-in sounds

Plays a sound.

Executes the callback method after all processing is completed and before updating the client.

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.

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.

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Instructs the client to start polling the server for UI changes at the specified interval when a WebSocket connection is not available.

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.

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.

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.

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.

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);
      }
    });

});

Events

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.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application pages.

public class PageCollection : ICollection, IEnumerable

Public Class PageCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Count

Int32: Returns the total number of currently open pages.

Item(index)

Page: Returns the page at the specified index.

Item(name)

Page: Returns the first page with the specified name, the search is case insensitive.

Methods

GetEnumerator()

Returns an enumerator that iterates through the open pages.

Returns: IEnumerator.

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the HashChanged event.

public class HashChangedEventArgs : EventArgs

Public Class HashChangedEventArgs
    Inherits EventArgs

Constructors

HashChangedEventArgs(value)

Initializes a new instance of the HashChangedEventArgs class.

Properties

Hash

String: The hash string from the client.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Holds the collection of all top-level application forms.

public class FormCollection : ICollection, IEnumerable

Public Class FormCollection
    Inherits ICollection
    Implements IEnumerable

Properties

Count

Int32: Returns the total number of currently open forms.

Item(index)

Form: Returns the form at the specified index.

Item(name)

Form: Returns the first form with the specified name, the search is case insensitive.

Methods

GetEnumerator()

Returns an enumerator that iterates through the open forms.

Returns: IEnumerator.

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the Application.ResponsiveProfileChanged event.

public delegate void ResponsiveProfileChangedEventHandler(Object sender, ResponsiveProfileChangedEventArgs e)

Public Delegate Sub ResponsiveProfileChangedEventHandler(ByVal sender As [Object], ByVal e As ResponsiveProfileChangedEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the ResponsiveProfileChanged event.

public class ResponsiveProfileChangedEventArgs : EventArgs

Public Class ResponsiveProfileChangedEventArgs
    Inherits EventArgs

Constructors

ResponsiveProfileChangedEventArgs(oldValue, newValue)

Initializes a new instance of the ResponsiveProfileChangedEventArgs class.

Properties

CurrentProfile

ClientProfile: The new active profile.

PreviousProfile

ClientProfile: The previously active profile.

Used By

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.

Legend

Concepts & Reference

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.

Skills

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

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)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the ControlAdded and ControlRemoved events.

public class ControlEventArgs : EventArgs

Public Class ControlEventArgs
    Inherits EventArgs

Constructors

ControlEventArgs(control)

Initializes a new instance of the ControlEventArgs class for the specified control.

Properties

Control

Control: Returns the control object used by this event.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Extends and enabled the components to appear on the designer surface.

public class Component : Component, IComponent

Public Class Component
    Inherits Component
    Implements IComponent

Constructors

Component()

Default constructor

Methods

Update()

Updates the component on the client.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public delegate void DragEventHandler(Object sender, DragEventArgs e)

Public Delegate Sub DragEventHandler(ByVal sender As [Object], ByVal e As DragEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the , , or event.

public class DragEventArgs : EventArgs

Public Class DragEventArgs
    Inherits EventArgs

Constructors

DragEventArgs(allowedEffect, effect, data, location)

Initializes a new instance of the class.

Properties

AllowedEffect

: Returns which drag-and-drop operations are allowed by the originator (or source) of the drag event.

AllowedFileTypes

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

public class HelpEventArgs : EventArgs

Public Class HelpEventArgs
    Inherits EventArgs

Constructors

HelpEventArgs(target)

Initializes a new instance of the class.

Properties

Handled

: Returns or sets a value indicating whether the help event was handled.

Target

: Returns the that had the focus when the user pressed F1.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the or event.

public class KeyEventArgs : EventArgs

Public Class KeyEventArgs
    Inherits EventArgs

Constructors

KeyEventArgs(keyData)

Initializes a new instance of the class.

Properties

Alt

: Returns whether the ALT key was pressed.

Control

: Returns whether the CTRL key was pressed.

Handled

Methods

Returns whether the Alt key is pressed.

Returns whether the Control key is pressed.

Returns whether the Shift key is pressed.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

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

public delegate void KeyEventHandler(Object sender, KeyEventArgs e)

Public Delegate Sub KeyEventHandler(ByVal sender As [Object], ByVal e As KeyEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Base class for all Wisej controls.

public class Control : IWisejControl, IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles

Public Class Control
    Inherits IWisejControl
    Implements IWisejComponent, IBindableComponent, IWisejSerializable, IHasPropertyStore, IHasResponsiveProfiles

Constructors

Control()

Initializes a new instance of the class.

Properties

AccessibleDescription

: Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element.

AccessibleName

: 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

You can use this collection at design time or in code or through the listener methods:

You can use any CSS style string.

  // set the border radius to 100% and make the control round.
  this.button1.CssStyle = "border-radius:100%";

  // 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.');
    }
  });

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:

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 " ".

Methods

Adds a new listener script to the event name to the client widget.

The script will execute in the browser when the event name occurs. You can attach multiple listeners to the same event.

Adds the specified theme state to the widget.

Executes the specified delegate asynchronously.

Brings the control to the front of the z-order.

Runs the JavaScript function within the component's context in the browser.

Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.

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.

Indicates whether the specified control is a child of this control.

Creates and register this control and all its children.

Begins a drag-and-drop operation.

Begins a drag-and-drop operation.

Begins a drag-and-drop operation.

Begins a drag-and-drop operation.

Begins a drag-and-drop operation.

Runs the javaScript code within the component's context in the browser.

Runs the javaScript code within the component's context in the browser and returns the value to the callback method.

Retrieves the form that the control is on.

Retrieves the page that the control is on.

Sets input focus to the control.

Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.

Retrieves the child control that is located at the specified coordinates.

Returns the script associated to the listener identified by id .

Returns the scripts for all the listeners attached to the event name .

Retrieves the next control forward or back in the tab order of child controls.

Retrieves the value of the specified control style bit for the control.

Checks whether the specified event name has any listener attached.

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.

Executes the specified delegate.

Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.

Determines whether the specified character is the mnemonic character.

Computes the location of the specified screen point into client coordinates.

Computes the location of the specified client point into screen coordinates.

Computes the size and location of the specified screen rectangle in client coordinates.

Computes the size and location of the specified client rectangle 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.

Detaches and removes the listener identified by id .

Removes all the listeners attached to the event name .

Removes the specified theme state from the widget.

Resumes layout logic.

Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.

Scrolls the control into view in the container using the specified alignX and alignY preferences.

Scrolls the child control into view.

Activates a control.

Activates the next control in the list according to the specified selection rules.

Sends the control to the back of the z-order.

Sets the bounds of the control to the specified location and size.

Sets the specified bounds of the control to the specified location and size.

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 the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .

Events

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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;
    }
  }

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

public delegate void HelpEventHandler(Object sender, HelpEventArgs hlpevent)

Public Delegate Sub HelpEventHandler(ByVal sender As [Object], ByVal hlpevent As HelpEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the and events of the class.

public delegate void ControlEventHandler(Object sender, ControlEventArgs e)

Public Delegate Sub ControlEventHandler(ByVal sender As [Object], ByVal e As ControlEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents a collection of objects.

public class ControlCollection : ControlCollection, IList<Control>, ICollection<Control>, IEnumerable<Control>, IWisejSynchronized

Public Class ControlCollection
    Inherits ControlCollection
    Implements IList(Of Control), ICollection(Of Control), IEnumerable(Of Control), IWisejSynchronized

Constructors

ControlCollection(owner)

Initializes a new instance of the class.

Properties

IsDisposed

: Returns whether the owner control has already been disposed.

Item(index)

: Returns the at the specified indexed location.

Item(key)

Methods

Adds the specified control to the control collection.

Adds an array of control objects to the collection.

Removes all controls from the collection.

Removes and disposes all controls from the collection.

Determines whether the specified control is a member of the collection.

Searches for controls by their type and builds an array of all the controls that match.

Throws:

Searches for controls by their name and builds an array of all the controls that match.

Throws:

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.

Throws:

Retrieves the index of the specified control in the control collection.

Retrieves the index of the first occurrence of the specified item within the collection.

Removes the specified control from the control collection.

Removes the child control with the specified key.

Sets the index of the specified child control in the collection.

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)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the , , and events.

public class MouseEventArgs : EventArgs

Public Class MouseEventArgs
    Inherits EventArgs

Constructors

MouseEventArgs(button, clicks, x, y, delta)

Initializes a new instance of the class.

MouseEventArgs(button, clicks, x, y, delta, role)

Initializes a new instance of the class.

Properties

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.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

public delegate void KeyPressEventHandler(Object sender, KeyPressEventArgs e)

Public Delegate Sub KeyPressEventHandler(ByVal sender As [Object], ByVal e As KeyPressEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents the method that will handle the event of a .

public delegate void LayoutEventHandler(Object sender, LayoutEventArgs e)

Public Delegate Sub LayoutEventHandler(ByVal sender As [Object], ByVal e As LayoutEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

public class KeyPressEventArgs : EventArgs

Public Class KeyPressEventArgs
    Inherits EventArgs

Constructors

KeyPressEventArgs(keyChar)

Initializes a new instance of the class.

Properties

Handled

: Returns or sets whether the event was handled.

KeyChar

: Returns or sets the character corresponding to the key pressed.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Provides data for the event.

public class LayoutEventArgs : EventArgs

Public Class LayoutEventArgs
    Inherits EventArgs

Constructors

LayoutEventArgs(affectedComponent, affectedProperty)

Initializes a new instance of the class with the specified component and property affected.

LayoutEventArgs(affectedControl, affectedProperty)

Initializes a new instance of the class with the specified control and property affected.

Properties

AffectedComponent

Used By