Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Definition of the client device.

public class ClientProfile

Public Class ClientProfile

Fields

Properties

Device

String: Device type.

Landscape

Nullable<Boolean>: Device landscape mode.

MaxScreenWidth

Int32: Maximum screen width.

MaxWidth

Int32: Maximum browser width.

Int32: Minimum screen width.

Int32: Minimum browser width.

String: Name of the profile.

String: User agent string.

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

• BrowserStorage

  • CookieStorage

Represents the browser's cookie storage. Use this class through the CookieStorage instance.

public class CookieStorage : BrowserStorage

Public Class CookieStorage
    Inherits BrowserStorage

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Represents a Wisej theme.

public class ClientTheme : IWisejSerializable

Public Class ClientTheme
    Inherits IWisejSerializable

You can create a new custom theme based on an existing theme, empty, or initialized from a JSON string.

// create a new custom theme cloned from the current theme.
var myTheme1 = new ClientTheme("MyTheme1", Application.Theme);

// create a new custom theme from a JSON string.
var myTheme2 = new ClientTheme("MyTheme2", json);

You can alter any aspect of a theme by using the dynamic properties: Colors, Images, Fonts, Appearances, Settings, and Stylesheet. These properties, being dynamic, can support any field and any structure. To alter these properties in a way that doesn't break the theme, look at the theme's structure in the ThemeBuilder or a text editor. To save a custom theme you may convert it to a JSON string simply by calling the ToJSON extension method added to all objects by the Wisej framework.

Constructors

ClientTheme(name)

Default private constructor.

ClientTheme(name, json)

Constructs a new theme from the name and JSON definition.

Constructs a new theme from the base theme.

Properties

Object: Theme appearances.

This is a complex dynamic object with several child objects. The structure can get quite complicated. Before messing with the Appearances object, please study the structure of the themes using the ThemeBuilder or a text editor. Being a dynamic object, you can either create a new appearance or alter an existing appearance at any level.

// alter the border of buttons.
// note that when there is a keyword clash you can use the @ prefix.
Application.Theme.Appearances.button.states.@default.styles.width = 3;
Application.Theme.Appearances.button.states.@default.styles.radius = 0;

// additionally, you my use a string indexer to reach any property.
Application.Theme.Appearances.button.states["default"].styles.radius = 0;

Object: Theme colors.

You can add or change any color in the current theme:

// change existing color.
Application.Theme.Colors.buttonFace = "red";

// create a new color.
Application.Theme.Colors.myCoolColor = "rgba(5,23,55,0.9)";

// 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";

Object: Theme fonts.

You can add or alter any font to the theme. The structure of the font definition can get complicated. Please refer to the existing themes and the ThemeBuilder to determine the structure to use. The simplest way is to change an existing theme font:

// make the window title bigger and bold.
Application.Theme.Fonts.windowTitle.size = 18;
Application.Theme.Fonts.windowTitle.bold = true;

Object: Theme images.

You can add or change any theme image. Images in the theme are just URLs but can be defined in several ways:

• Absolute URL An URL starting with http: or https: pointing to an image resource.

• Relative URL An URL relative to the current site or relative to value of Images.baseUrl.

• base64 A base64 encoded embedded image.

String: The name of the theme.

Object: Theme settings.

The Settings property, added in Wisej 2, allows a theme to define certain internal properties. Currently these are the supported properties:

• native-scrollbars Instructs Wisej to use the native scrollbars instead of the themed scrollbars. Setting this property can have negative side effects for virtual scrolling widgets like the DataGridView. The default is false.

• overlapped-scrollbars Instructs Wisej to layout the scrollbars over the content being scrolled, similar to Windows' fluent themes or mobiles. The default is false.

Object: Stylesheet rules embedded in the theme.

The Stylesheet property is a new theme property added since Wisej 2.0. It allows a theme to define a set of CSS rules, just as if Default.html specified a css file. This property has only one string array field: "rules". When the theme is rendered, the client library joins all the rules into a css string and creates a stylesheet loaded into the browser.

// create a custom css rules in the theme.
Application.Theme.Stylesheet.rules = new []{

  "body: { background-color: red };",
  ".myClass: { background-color: red };"
};

Methods

Returns the resolved color defined in the theme for the specified appearance, property or style name and optionally the state.

Returns: Color. A Color representing the color in the theme.

Returns the resolved theme color from the color list.

Returns: Color. A Color representing the color in the theme.

Returns the resolved font defined in the theme for the specified appearance, property name and optionally the state.

Returns: Font. A Font representing the queried font or null if not found.

Returns the resolved font defined from the font list.

Returns: Font. A Font representing the queried font or null if not found.

Returns the resolved image defined in the theme for the specified appearance, property or style name and optionally the state.

Returns: Image. A Image representing the queried image or null if not found. SVG images at runtime always return null, they are resolved only at design time.

Returns the resolved image defined from the image list.

Returns: Image. A Image representing the queried image or null if not found. SVG images at runtime always return null, they are resolved only at design time.

Returns the size of the inset border and padding.

Returns: Padding. Dimension of the border and optionally the padding as a Padding value

Returns the property value for the specified name and state within the specified appearance key.

Returns: T. The typed value of the requested property, or default(T) if not found.

Returns the style value for the specified name and state within the specified appearance key.

Returns: T. The typed value of the requested style, or default(T) if not found.

Returns true if the color is a theme color.

Returns: Boolean. True if color is a theme color.

Since the theme may also define SystemColors, using IsThemeColor on a system color returns false, but the rendering on the browser will use the color in the theme, if defined.

Returns true if the font is a theme font.

Returns: Boolean. True if font is a theme font.

Theme fonts (font's with the OriginalFontName starting with "@") are always rendered using the definition in the theme for their size and style. However, an application may use a theme font and change the size and style. In this case, the OriginalFontName is the theme name without the "@". If the name of the font (which could be a system name like "Arial") matches a theme font, Wisej will use the theme font but it uses the size and style set by the application.

Returns the resolved Color with the proper RGB values. If the color specified in color is a theme color, the value is resolved from the current theme, otherwise the original color is returned.

Returns: Color. A Color instance with the resolved RGB values.

Returns the resolved Font from the theme font. If the font is a theme font, the value is resolved from current theme.

Returns: Font. A Font instance that can be used directly.

Implements

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Properties of the client browser currently interacting with the application.

public class ClientBrowser

Public Class ClientBrowser

Fields

Properties

CultureInfo

CultureInfo: Returns the locale declared in the application configuration file or detected from the client browser.

Device

String: Device type. Can be one of "Mobile", "Tablet" or "Desktop".

Features

Object: Returns the set of features supported/not-supported by the browser. Currently we detect: geolocation, webSocket, fullScreen, speechSynthesis, speechRecognition, notification, fullScreen, browserStorage.

Boolean: Returns true if the browser is in full screen mode.

Boolean: Returns true if the connection is secure.

String: Client language.

String: Client OS. Can be one of "iOS", "Android", "WebOS", "BlackBerry", "MacOS", "Linux", "Windows", "Unix", "Other".

Double: Returns the ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device.

ClientProfile[]:

Size: Screen size.

Size: Browser size. This is the window size, which can be different from the device (or screen) size.

Int32: Returns the time difference between UTC time and local time, in minutes.

String: Browser type. Can be one of "IE", "Edge", "Chrome", "Opera", "Firefox", "Safari", "Other".

Object: Returns a value or map set by the client when loading the application's first HTML page.

An application can use this property to retrieve a custom value on startup. For example, in Default.html add:

<script>
Wisej.userData = {
value1: 100,
someName: "test"
};
</script>

On the server side, you can retrieve the user data use at any time like this:

int value1 = Application.Browser.UserData.value1;
string value2 = Application.Browser.UserData.someName;

When used in conjunction with an aspx startup page (Default.aspx) it allows the application to retrieve data passed as a POST request and pass it to the Wisej application.

Int32: Browser version.

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Represents the browser's storage objects.

public class BrowserStorage : IWisejSynchronized

Public Class BrowserStorage
    Inherits IWisejSynchronized

Methods

Clear()

Removes all the values from the browser's storage.

GetKeys(callback)

Returns all the keys in the browser's storage.

GetKeysAsync()

Asynchronously returns all the keys in the browser's storage.

Returns: Task<String[]>. An awaitable Task that represents the asynchronous operation.

GetValue<T>(key, callback)

Returns the value stored in the browser's storage associated with the specified key .

This method returns the value asynchronously because it waits for the browser to respond.

Application.LocalStorage.GetValue<string>("userName", (value) => {
  if (value != null)
    AlertBox.Show($"Welcome back, {value}");
});

Throws:

• ArgumentNullException The key is null or empty, or callback is null.

Asynchronously returns the value stored in the browser's storage associated with the specified key .

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

Removes the value associated with the key from the browser's storage.

Stores the specified value in the browser's storage.

Inherited By

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Represents the browser's localStorage. Use this class through the instance.

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Handler for healthcheck requests sent by load balancers.

Configure the load balancer to use "http://your-server/healthcheck.wx" as the health check URL. You can modify the default healthcheck value either by placing a Healthcheck.json file in the root of your project, or programmatically assigning the values to Wisej.Core.HealthCheck properties. See .

Fields

Properties

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Provides a thread-safe collection that contains objects of a type specified by the generic parameter as elements.

Parameters

Constructors

SynchronizedLinkedList(collection, syncLock)

Initializes a new instance of the class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied and uses the specified syncLock object to synchronize its internal operations.

Properties

Count

: Gets the number of elements contained in the thread-safe collection.

Methods

Adds a new item at the end of the LinkedList.

Adds a new item after the specified item.

Adds a new item before the specified item.

Adds a new item at the start of the LinkedList.

Removes all items from the collection.

Determines whether the collection contains an element with a specific value.

Copies the elements of the collection to a specified array, starting at a particular index.

Throws:

Retrieves all the elements that match the conditions defined by the specified predicate.

Throws:

Returns an enumerator that iterates through the synchronized collection.

Removes the first occurrence of a specified item from the collection.

Removes all the elements that match the conditions defined by the specified predicate.

Throws:

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Abstracts access to the file system. Implementations of this interface are used by the file dialogs and other components that need to interact with the file system. Wisej provides the built-in default implementation for the standard disk-based file system and a number of alternative implementations in the Wisej extensions, such as: Amazon S3, Google Drive, and Microsoft OneDrive.

Properties

Icon

: Returns or sets the icon that represents the file system.

IconSource

: Returns or sets the icon name or URL that represents the file system.

Name

: Returns or sets the name of this root. This is the name that should be shown to the user.

Root

: Returns or sets the root path for the file system. All file system operations in the implementation class are expected to be limited to the root.

Methods

Creates the specified directory and sub-directories.

Deletes the specified directory and, optionally, sub-directories.

Deletes the specified file.

Returns whether the specified file or directory exists.

Returns the file's creation time.

Returns a list of directory paths that match the pattern and search options in the specified path.

Returns a list of file paths that match the pattern and search options in the specified path.

Returns the size of the file.

Returns the last write timestamp for the specified file.

Opens the specified file for reading or writing.

Renames the specified directory.

Renames the specified file.

Implemented By

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Default implementation of IFileSystemProvider. Provides access to the server's file system.

Constructors

FileSystemProvider()

Initializes a blank instance of .

FileSystemProvider(root, name)

Creates a new instance of the class with the specified root and name . The root is added in front of all path arguments passed to all methods in this class.

The root path is also the current directory path.

Properties

Icon

Methods

Creates the specified directory and sub-directories.

Deletes the specified directory and, optionally, sub-directories.

Deletes the specified file.

Returns whether the specified file or directory exists.

Returns the file's creation time.

Returns a list of directory paths that match the pattern and search options in the specified path.

Returns a list of file paths that match the pattern and search options in the specified path.

Returns the size of the file.

Returns the last write timestamp for the specified file.

Opens the specified file for reading or writing.

Renames the specified directory.

Renames the specified file.

Implements

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Provides a thread-safe collection that contains objects of a type specified by the generic parameter as elements.

Parameters

Constructors

SynchronizedList(capacity, collection, syncLock)

Initializes a new instance of the class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied and uses the specified syncLock object to synchronize its internal operations.

Properties

Count

Throws:

Methods

Adds an item to the thread-safe collection.

Throws:

Throws:

Throws:

Removes all items from the collection.

Determines whether the collection contains an element with a specific value.

Copies the elements of the collection to a specified array, starting at a particular index.

Throws:

Throws:

Retrieves all the elements that match the conditions defined by the specified predicate.

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Returns an enumerator that iterates through the synchronized collection.

Returns the index of the first occurrence of a value in the collection.

Inserts an item into the collection at a specified index.

Throws:

Throws:

Removes the first occurrence of a specified item from the collection.

Removes all the elements that match the conditions defined by the specified predicate.

Throws:

Removes an item at a specified index from the collection.

Throws:

Throws:

Throws:

Throws:

Throws:

Computes the sum of the sequence of System.Int32 values that are obtained by invoking a transform function on each element of the list.

Throws:

Computes the sum of the sequence of System.Int64 values that are obtained by invoking a transform function on each element of the list.

Throws:

Computes the sum of the sequence of System.Single values that are obtained by invoking a transform function on each element of the list.

Throws:

Computes the sum of the sequence of System.Double values that are obtained by invoking a transform function on each element of the list.

Throws:

Computes the sum of the sequence of System.Decimal values that are obtained by invoking a transform function on each element of the list.

Throws:

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.2.0.0)

Represents the browser's localStorage. Use this class through the instance.