Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.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.5.0.0)

Represents the browser's storage objects.

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: . An awaitable 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.

Throws:

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

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

• BrowserStorage

  • LocalStorage

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

public class LocalStorage : BrowserStorage

Public Class LocalStorage
    Inherits BrowserStorage

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

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

public class FileSystemProvider : IFileSystemProvider

Public Class FileSystemProvider
    Inherits IFileSystemProvider

Constructors

FileSystemProvider()

Initializes a blank instance of FileSystemProvider.

FileSystemProvider(root, name)

Creates a new instance of the FileSystemProvider 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

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

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

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

String: 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

Checks whether the specified path starts with the Name of this file system provider.

Returns: Boolean. True if the specified path starts with the name of this file system provider.

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: Boolean. True of the file or directory exists.

Returns the FileAttributes for the specified path .

Returns: FileAttributes. An instance of FileAttributes with the relevant flags set.

Returns the file's creation time.

Returns: DateTime. A DateTime representing the timestamp of the file creation.

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

Returns: String[]. A Array containing the full path of the directories that match the search pattern and search options.

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

Returns: String[]. A Array containing the full path of the files that match the search pattern and search options.

Returns the size of the file.

Returns: Int64.

Returns the last write timestamp for the specified file.

Returns: DateTime. A DateTime representing the timestamp of the last time the file was written.

Maps the virtual path to the corresponding physical path on the specific IFileSystemProvider implementation.

Returns: String. The physical path for the IFileSystemProvider implementation.

Opens the specified file for reading or writing.

Returns: Stream. A Stream that can be used to read or write the content of the file.

Renames the specified directory.

Renames the specified file.

Implements

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.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.5.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.

public interface IFileSystemProvider

Public Interface IFileSystemProvider

Properties

Icon

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

IconSource

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

Name

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

Root

String: 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

Checks whether the specified path starts with the Name of this file system provider.

Returns: Boolean. True if the specified path starts with the name of this file system provider.

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: Boolean. True of the file or directory exists.

Returns the FileAttributes for the specified path .

Returns: FileAttributes. An instance of FileAttributes with the relevant flags set.

Returns the file's creation time.

Returns: DateTime. A DateTime representing the timestamp of the file creation.

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

Returns: String[]. A Array containing the full path of the directories that match the search pattern and search options.

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

Returns: String[]. A Array containing the full path of the files that match the search pattern and search options.

Returns the size of the file.

Returns: Int64. The size of the file in bytes.

Returns the last write timestamp for the specified file.

Returns: DateTime. A DateTime representing the timestamp of the last time the file was written.

Maps the virtual path to the corresponding physical path on the specific IFileSystemProvider implementation.

Returns: String. The physical path for the IFileSystemProvider implementation.

Opens the specified file for reading or writing.

Returns: Stream. A Stream that can be used to read or write the content of the file.

Renames the specified directory.

Renames the specified file.

Implemented By

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Maps document extensions to content MIME types.

public class MimeTypes

Public Class MimeTypes

Methods

GetMimeType(fileName)

Returns the MIME mapping for the specified file name.

Returns: String.

IsKnownType(extension)

Returns if the file extension corresponds to a known mime type.

Returns: Boolean.

SetMimeType(extension, mimeType)

Adds or changes the mime type for the specified file extension.

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Handler for healthcheck requests sent by load balancers.

public class HealthCheck

Public Class HealthCheck

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 load-balancing.

static class Program {

  // static constructor.
  static Program() {

    Wisej.Core.HealthCheck.MaxCPU = 0; // ignore
    Wisej.Core.HealthCheck.MaxMemory = 85;
    
  }
}

Fields

Properties

Boolean: Returns or sets whether the load balancing features are enabled.

Int32: Maximum CPU load in percentage: Default: 100; 0 = unlimited.

Int32: Maximum percentage of allocated memory. Default: 70; 0 = unlimited.

Int32: Maximum number of active sessions: Default: 0; 0 = unlimited.

Int32: Value for the Retry-After header in minutes. Default: 10.

Int32: HTTP return code to signal that this server is not available. Default: 503.

String: Redirection Url in alternative to the error return code. Default: null.

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Properties of the client browser currently interacting with the application.

public class ClientBrowser

Public Class ClientBrowser

Fields

Properties

ClientFingerprint

Deprecated: Deprecated, please use Application.ClientId instead. 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.

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

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

String: IP Address of the client computer.

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.

String: Returns the session ID associated with this ClientBrowser.

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

String: Identifies the browser tab associated with with this ClientBrowser instance.

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

String: Returns the raw user agent string of the client browser.

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

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

public class SynchronizedLinkedList<T> : ICollection<T>, IEnumerable<T>, IEnumerable, ICollection

Public Class SynchronizedLinkedList(Of T)
    Inherits ICollection(Of T)
    Implements IEnumerable(Of T), IEnumerable, ICollection

Parameters

Constructors

SynchronizedLinkedList(collection, syncLock)

Initializes a new instance of the SynchronizedLinkedList 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

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

Object: Gets the object used to synchronize access to 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.

Returns: Boolean. true if the element value is found in the collection; otherwise false.

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

Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List.

Returns: T. The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value.

Throws:

• ArgumentNullException match is null.

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

Returns: List<T>. A List containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty List.

Throws:

• ArgumentNullException match is null.

Returns an enumerator that iterates through the synchronized collection.

Returns: IEnumerator<T>. An IEnumerator for objects of the type stored in the collection.

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

Returns: Boolean. true if item was successfully removed from the collection; otherwise, false.

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

Returns: Int32. The number of elements removed from the List .

Throws:

• ArgumentNullException match is null.

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Default arguments for Wisej events.

Constructors

WisejEventArgs(target, type, args)

Creates a new instance of .

WisejEventArgs(e)

Creates a new instance of WisejEventArgs using the incoming event data.

Fields

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Defines the event filter interface to use with the method.

Methods

PreFilterEvent(e)

Process an event before it is dispatched.

Returns: . true to stop the event from being dispatched; false to allow the event to continue to the next filter or control.

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Keyboard informs from the event.

Properties

IsEmpty

: Indicates whether the KeyboardInfo properties have been initialize or not.

KeyCode

: Pressed key.

KeyData

: Pressed key with modifier.

KeyValue

: Raw pressed key code.

LockKeys

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

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

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Indicates that the method can be called from the browser using JavaScript.

You can add this attribute to static methods in your Wisej application Program class and to instance methods in top level containers: Page, Form, and Desktop. If you want to register web methods on child controls, you can, but Wisej only searches top level containers automatically. To register web methods on a child control, extend the control class, override and call .

Constructors

WebMethodAttribute()

Initializes the attribute.

WebMethodAttribute(inheritable)

Properties

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Enables automatic resource loading form the assembly.

Constructors

WisejResourcesAttribute()

Initializes a new instance of .

WisejResourcesAttribute(ExcludeList)

Initializes a new instance of using the initialization arguments.

WisejResourcesAttribute(ExcludeList, RootName)

Initializes a new instance of using the initialization arguments.

Properties

Methods

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

Pointer information from the event.

Properties

Button

: Mouse button.

IsEmpty

: Indicates whether the PointerInfo properties have been initialize or not.

Location

: Pointer location.

Modifiers

: Keyboard modifiers.

WheelDelta

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

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

Namespace: Wisej.Core

Assembly: Wisej.Framework (2.5.0.0)

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

public class SynchronizedList<T> : IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable, IList, ICollection

Public Class SynchronizedList(Of T)
    Inherits IList(Of T)
    Implements ICollection(Of T), IEnumerable(Of T), IEnumerable, IList, ICollection

Parameters

Constructors

SynchronizedList(capacity, collection, syncLock)

Initializes a new instance of the SynchronizedList 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.