Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.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 (3.1.0.0)

• BrowserStorage

  • CookieStorage

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

public class CookieStorage : BrowserStorage

Public Class CookieStorage
    Inherits BrowserStorage

Namespace: Wisej.Core

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

String: Returns or sets the response header to return to the browser.

Can be used in conjunction with the ReturnCode set to 200 (OK) and the value of the return header set to "Refresh: 0; Set-Cookie: AffinityCookie=" to cause the client browser to load the affinity cookie and reload the page to (hopefully) reach another server.

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

Encapsulates all HTTP-specific information about an individual HTTP request.

public class HttpContext

Public Class HttpContext

Properties

Cookies

HttpCookieCollection: Returns a collection of HttpCookie values sent by the client.

Request

HttpRequest: Returns the HttpRequest object for the current HTTP request.

Response

HttpResponse: Returns the HttpResponse object for the current HTTP response.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Custom fast implementation of a dynamic object that can handle the JSON serialization and deserialization. This class implements IDynamicMetaObjectProvider allowing the DLR to compile the dynamic member access on the fly. We could have derived from System.Dynamic.Dynamic but the implementation in the .NET framework uses exceptions to manage custom properties.

public class DynamicObject : IDynamicMetaObjectProvider, ICloneable, IList<Member>, ICollection<Member>, IEnumerable<Member>, IEnumerable, ISerializable, ICustomTypeDescriptor, INotifyPropertyChanged, IConvertible

Public Class DynamicObject
    Inherits IDynamicMetaObjectProvider
    Implements ICloneable, IList(Of Member), ICollection(Of Member), IEnumerable(Of Member), IEnumerable, ISerializable, ICustomTypeDescriptor, INotifyPropertyChanged, IConvertible

Constructors

DynamicObject()

Default constructor.

DynamicObject(capacity)

Optional constructor. Takes the initial capacity to allocate the specified number of slots in the store.

DynamicObject(source)

Creates a new DynamicObject cloned from the source object.

Properties

Int32: Returns the number of fields.

Boolean: Returns true if the dynamic doesn't object contains any field.

Object: Returns or sets the value of the specified member.

Methods

Wipes out the object.

Wipes out the object but it keeps the capacity.

Clones the members of the dynamic object.

Returns: DynamicObject. The cloned instance.

This is a shallow copy. Reference members are copied by reference.

Returns whether the object contains the specified field.

Returns: Boolean. True if the field name exists in the store.

Copies all the values from the source object.

Deletes the field.

Returns: DynamicObject. Itself, this call can be chained.

Returns a new ComponentConfiguration object containing only the values that don't exist in the ComponentConfiguration object passed to the method.

Returns: Object. Returns null if there are no differences.

Returns an enumerator that iterates through the collection.

Returns: IEnumerator<Member>. A IEnumerator

Fires the PropertyChanged event.

Sorts the field by their name.

Serializes the object to a JSON string.

Returns: String. A String representing the serialized object.

Serializes the object to a JSON string.

Returns: String. A String representing the serialized object.

Removes the excess entries in the inner array and in all child fields, recursively.

Returns: Boolean.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.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. (Default: null)

String: Returns or sets the icon name or URL that represents the file system. (Default: "resource.wx/icon-storage.svg")

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

Represents a cookie value in the client browser.

public class HttpCookie

Public Class HttpCookie

Constructors

HttpCookie(name)

Creates and names a new HttpCookie.

HttpCookie(name, value)

Creates, names, and assigned a new value to a new HttpCookie.

Properties

Domain

String: Restricts domain cookie is to be used with.

DateTime: Expiration time for the cookie (in minutes).

Boolean: Return whether the cookie has sub-keys.

Boolean: Indicates whether the cookie should have HttpOnly attribute

String: Returns or sets a value in a cookie with multple values.

String: Returns or sets the name of the cookie.

String: Returns or sets the URL prefix to transmit with the cookie.

SameSiteMode: Returns or sets the SameSiteMode for the cookie.

Boolean: Indicates whether the cookie should be transmitted only over HTTPS.

String: Returns or sets the cookie value.

NameValueCollection: Returns an individual key:value pairs within a single cookie object with multple values.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Determine if a cookie should be restricted to a first-party or same-site context.

Fields

Used By

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Provides access to individual files that have been uploaded by a client.

Properties

ContentLength

: Returns the size of an uploaded file, in bytes.

ContentType

: Returns the MIME content type of a file sent by a client.

FileName

: Return the fully qualified name of the file on the client.

InputStream

: Returns a object that points to an uploaded file to prepare for reading the contents of the file.

Methods

Saves the contents of an uploaded file.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Provides access to and organizes files uploaded by a client.

Properties

AllKeys

: Returns a string array containing the keys (names) of all members in the file collection.

Count

: Returns the number of files in the collection.

Item(index)

: Returns the at the index.

Item(name)

: Returns the identified by the specified name .

Methods

Returns the name of the file at the specified index .

Returns all files that match the specified name.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Encapsulates the cookies sent in an HTTP request.

Properties

AllKeys

: Returns all the keys (cookie names) in the cookie collection.

Count

: Returns the number of cookies in the collection.

Item(name)

: Returns the cookie with the specified name from the cookie collection.

Item(index)

: Returns the cookie with the specified numerical index from the cookie collection.

Methods

Adds the specified cookie to the cookie collection.

Clears all cookies from the cookie collection.

Returns the cookie with the specified name from the cookie collection.

Returns the key (name) of the cookie at the specified numerical index.

Removes the cookie with the specified name from the collection.

Updates the value of an existing cookie in a cookie collection.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Encapsulates HTTP-request information for an ASP.NET operation.

Constructors

HttpRequest(context, request)

Constructs an new instance initialized from the original .

Properties

ContentLength

: Returns the length, in bytes, of content sent by the client.

ContentType

: Returns the MIME content type of the incoming request.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Encapsulates HTTP-response information from an ASP.NET operation.

Properties

ContentType

: Returns or set the HTTP MIME type of the output stream.

Context

: Returns the current .

OutputStream

: Enables binary output to the outgoing HTTP content body.

StatusCode

: Returns or sets the HTTP status code returned to the client.

StatusDescription

Methods

Adds the HTTP header to the response.

Writes an array of bytes to the HTTP output stream.

Writes an array of bytes to the HTTP output stream.

Sends all currently buffered output to the client.

Throws:

Returns a redirect response (HTTP 301 or HTTP 302) to the client.

Writes the specified filePath to the current HTTP response stream without buffering it in memory.

Throws:

Writes the specified part of a file directly to an HTTP response output stream without buffering it in memory.

Throws:

Writes an image to the HTTP response stream.

Throws:

Copies a stream to the HTTP response stream.

Writes a string to the current HTTP response string.

Writes an object to the HTTP response stream.

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

• BrowserStorage

  • SessionStorage

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

public class SessionStorage : BrowserStorage

Public Class SessionStorage
    Inherits BrowserStorage

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

• BrowserStorage

  • LocalStorage

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

public class LocalStorage : BrowserStorage

Public Class LocalStorage
    Inherits BrowserStorage

Namespace: Wisej.Core

Assembly: Wisej.Framework (3.1.0.0)

Defines the event filter interface to use with the AddEventFilter method.

public interface IEventFilter

Public Interface IEventFilter

Methods

PreFilterEvent(e)

Process an event before it is dispatched.

Returns: Boolean. 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 (3.1.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 (3.1.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 (3.1.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 (3.1.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 (3.1.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 (3.1.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 (3.1.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