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

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

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)

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