Skip to main content
Version: 3.5

Configuration

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.5.0.0)

Configuration settings.

public class Configuration

Constructors​

Instance memberConfiguration(json)​

Creates a new instance from the specified json string.

NameTypeDescription
jsonStringThe json string that defines the configuration values.

Properties​

Instance memberAllowedRoutes​

String[]: List of allowed Url routes separated by a semicolon. i.e.: "api;product;log/performance".

Instance memberAutoReload​

Boolean: When true, the application is automatically reloaded when the session expires or Exit is called.

The application can always override this feature by changing the Wisej.onExit method using a script.


  <script>
    Wisej.onExit = function() {
      // this is the default implementation
      // when AutoReload is set to true.
      location.reload();
    }
  </script>

Instance memberBrowserCheck​

String: The custom function used to validate the browser. If it returns false the browser is not supported and Wisej redirects to NotSupportedUrl.

Instance memberCulture​

String: Returns the culture set at the application's level. It can be any of the supported cultures or the keyword "auto", in which case we will detect the culture from the browser.

Instance memberDebug​

Boolean: Enables/disables debug mode.

Instance memberDisableClientObjectModel​

Boolean: When true, the client will not be able to access the application's controls using the object model registered with javascript under the "App" namespace.

Instance memberDropDuplicateClicks​

Boolean: When true, the client drops all "execute" events triggered while there is a pending request.

Instance memberEmbeddedResourcesCacheControl​

String: Cache-Control for embedded resources. The default is "browser" to cache the embedded resources on the browser for 1 month. Other allowed vaues are: - "server" to cache the resources on the server using the ETag header - "private, max-age=..." to use set the standard Cache-Control header - any value Cache-Control string value.

Instance memberEnablePWA​

Boolean: Enables the PWA installation of the application.

Instance memberEnableWebSocket​

Boolean: Enables/disables the WebSocket protocol.

Instance memberEnableWebSocketCompression​

Boolean: Enables/disables gzip compression when using the WebSocket protocol.

Instance memberFilePath​

String: The full path of the configuration file.

Instance memberImpersonate​

Boolean: Enables impersonation mode.

When set to true and windows authentication is configured in web.config, every request thread and application tasks started using Application.StartTask will impersonate the current user.

Instance memberKeepAliveInterval​

Int32: The keep-alive interval in seconds.

Instance memberLoader​

String: Name of the page loader resource to show at startup.

Instance memberLoaderTimeout​

Int32: The ajax loader timeout in milliseconds.

Instance memberMainWindow​

String: Full name of the first window created automatically at startup.

Instance memberMaxModalStack​

Int32: Returns the maximum number of nested modal loops.

Instance memberMaxSessions​

Int32: Returns the maximum number of active sessions before redirecting to NotAvailableUrl.

Instance memberNetworkCheckInterval​

Int32: Network check interval in milliseconds. The default is 1000 (1 second). If this value is set, Wisej will send a /healthcheck.wx request at the specified interval when the application goes offline.

Instance memberNotAvailableUrl​

String: The URL of the page to load when the server cannot respond to the request.

Instance memberNotSupportedUrl​

String: The URL of the page to load when the client browser is not supported.

Instance memberOfflineUrl​

String: The URL of the page to load when the connection is lost.

Instance memberOptions​

Object: Native client-side platform options.

Instance memberPollingInterval​

Int32: Polling interval in milliseconds. The default is zero (disabled). If this value is set, the polling starts when the application is loaded.

The polling interval determines the frequency of the automatic poll requests coming from the client when a WebSocket connection is not available. When the client is connected using a WebSocket channel, this value is ignored. An application that wants to enable automatic client updates in absence of a WebSocket connection can set this value, or it can call StartPolling and EndPolling to start and terminate the automatic polling from the client. Both methods are ignored when the client is using a WebSocket connection.

Instance memberResponseTimeout​

Int32: The timeout for the server to respond to a Wisej request in seconds.

Instance memberRightToLeft​

String: Returns the rightToLeft mode. It can be "true", "false", or "auto". When set to "auto" the RightToLeft layout is enabled automatically using the current language. The default is "auto".

Instance memberSecure​

Boolean: Forces the client to switch to a secure connection (HTTPS and WSS).

Instance memberSessionStorage​

String: Where to save the session id on the client. The default is "session" to indicate the browser's sessionStorage. It can be changed to "local" to indicate the browser's localStorage.

Instance memberSessionTimeout​

Int32: The session timeout in seconds. The timeout is enforced on the client side.

Instance memberSettings​

Object: Application settings.

Instance memberShowLoader​

Boolean: Shows the loader animated gif while initializing the application.

Instance memberStartUp​

String: The startup Main method.

Instance memberThemeName​

String: Theme name.

Instance memberThreadPool​

Object: ThreadPool min/max configuration, null by default.

Instance memberUrl​

String: Url redirection.

Instance memberValidateClient​

Boolean: Verifies the client's unique id when retrieving a session. It prevents session hijacking over unsecured connections.

Instance memberValidateResources​

Boolean: Verifies that resource requests are received from the user's authorizes browser. Prevents reusing a resource URL from an unauthorized browser.

Instance memberWebSocketCompressionThreshold​

Int32: Sets the response size that triggers the compression of the response over the WebSocket channel.

Methods​

Static memberGetInstance(filePath, uri)​

Loads or retrieves the configuration file.

ParameterTypeDescription
filePathStringThe full path to the .json file to load.
uriUriThe current Uri representing the site being loaded.

Returns: Configuration.

Events​

Static memberLoadConfiguration​

LoadConfigurationEventHandler Fired when the system needs to load a Wisej configuration file.

An application can install a custom configuration handler and return a custom Configuration object. In alternative, the handler can change the value of FilePath and let Wisej.NET load the alternative json file. This is a static event and should be attached to before the application starts. One way to do that is to register an HttpModuleStartup method with IIS when using .NET 4.8. When running on .NET Core, attach to the event in the Startup method.


[assembly: PreApplicationStartMethod(typeof(ApplicationNameSpace.HttpModuleStartup), "Start")]

namespace ApplicationNameSpace
{
  public static class HttpModuleStartup
  {
    public static void Start()
    {
      Wisej.Core.Configuration.LoadConfiguration += (s, e) =>
      {
        // load json from a file, or build a json object.
        // you can also implement your own caching mechanism here.
        
        e.SuppressCache = true;
        
        return new Wisej.Core.Configuration(new
        {
          url = "Default.html",
          theme = "bootstrap-4",
          startup = "ApplicationNameSpace.Program.Main, Application"
          
        }.ToJSON());
      }
    }
  }
}