1 of 45

Content

AspNetPanel

Wisej.Web.AspNetPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- IFramePanel
  - AspNetPanel

Represents a control that can host ASP.NET or MVC pages within a Wisej application.

public class AspNetPanel : IFramePanel

Public Class AspNetPanel
    Inherits IFramePanel

The code in the hosted ASP.NET/MVC page can access any component in the current Wisej application session simply by using the Wisej.Web.Application class. All top level forms and pages are available in the Application.OpenForms, Application.OpenPages, Application.MainPage, and Appication.Desktop properties.

Constructors

AspNetPanel()

Properties

PageSource

String: Returns or sets the ASP.NET/MVC page to load in the AspNetPanel control.

Implements

Canvas

Wisej.Web.Canvas

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the HTML5 canvas element.

Constructors

Canvas()

Initializes a new instance of the class.

Properties

BorderStyle

: Indicates the border style for the control.

FillStyle

Methods

Creates an arc/curve (used to create circles, or parts of circles).

Creates an arc/curve between two tangents on the canvas.

begins a path, or resets the current path.

Adds a point to the current path by using the specified control points that represent a cubic Bézier curve.

A cubic bezier curve requires three points. The first two points are control points that are used in the cubic Bézier calculation and the last point is the ending point for the curve. The starting point for the curve is the last point in the current path. If a path does not exist, use the beginPath() and moveTo() methods to define a starting point.

Clears the specified pixels within a given rectangle.

Clips a region of any shape and size from the original canvas.

Once a region is clipped, all future drawing will be limited to the clipped region (no access to other regions on the canvas). You can however save the current canvas region using the save() method before using the clip() method, and restore it (with the restore() method) any time in the future.

Creates a path from the current point back to the starting point.

Creates a linear gradient object. The gradient can be used to fill rectangles, circles, lines, text, etc.

Repeats the specified element in the specified direction. The repeated element can be used to draw/fill rectangles, circles, lines etc.

Creates a linear gradient object. The gradient can be used to fill rectangles, circles, lines, text, etc.

Draws an image onto the canvas.

Fills the current drawing (path.)

Draws a "filled" rectangle. The default color of the fill is black.

Draws filled text on the canvas. The default color of the text is black.

Returns the current line dash pattern.

Adds a new point and creates a line TO that point FROM the last specified point in the canvas (this method does not draw the line).

Moves the path to the specified point in the canvas, without creating a line.

Use the stroke() method to actually draw the path on the canvas.

Moves the path to the specified point in the canvas, without creating a line.

Use the stroke() method to actually draw the path on the canvas.

Adds a point to the current path by using the specified control points that represent a quadratic Bézier curve.

A quadratic Bézier curve requires two points. The first point is a control point that is used in the quadratic Bézier calculation and the second point is the ending point for the curve. The starting point for the curve is the last point in the current path. If a path does not exist, use the beginPath() and moveTo() methods to define a starting point.

Creates a rectangle.

Returns previously saved path state and attributes.

Method rotates the current drawing.

The rotation will only affect drawings made AFTER the rotation is done.

Saves the state of the current context.

Scales the current drawing, bigger or smaller.

Sets the line dash pattern.

Resets the current transform to the identity matrix, and then runs transform() with the same arguments.

The transformation will only affect drawings made after the transform() method is called. The transform() method behaves relatively to other transformations made by rotate(), scale(), translate(), or transform(). Example: If you already have set your drawing to scale by two, and the transform() method scales your drawings by two, your drawings will now scale by four.

Draws the path you have defined.

Draws a rectangle (no fill). The default color of the stroke is black.

Draws text (with no fill) on the canvas. The default color of the text is black.

Replaces the current transformation matrix.

Remaps the (0,0) position on the canvas.

When you call a method such as fillRect() after translate(), the value is added to the x- and y-coordinate values.

Remaps the (0,0) position on the canvas.

When you call a method such as fillRect() after translate(), the value is added to the x- and y-coordinate values.

Events

Implements

HtmlPanel

Wisej.Web.HtmlPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- HtmlPanel

Represents a control that displays any HTML file and a corresponding CSS style sheet as embedded HTML.

public class HtmlPanel : Control

Public Class HtmlPanel
    Inherits Control

Constructors

HtmlPanel()

Initializes a new instance of the HtmlPanel class.

Properties

AllowNavigation

Boolean: Returns or sets whether clicking on a link in the Html panel can navigate to the URL specified in the link.

BorderStyle

BorderStyle: Indicates the border style for the control.

String: Returns or sets the CSS rules to apply to the html content.

String: Returns or sets the HTML text to display in the HtmlPanel control.

String: Returns or sets the html file name to display in the HtmlPanel control.

ScrollBars: Returns or sets the type of scroll bars to display for the HtmlPanel control.

String: Returns or sets the css file name to apply to the html text in HtmlPanel control.

Events

HtmlPanelElementClickHandler Fired when the user clicks on any element inside the html panel.

EventHandler Fired when the Html property is changed.

EventHandler Fired when the HtmlSource property is changed.

Implements

HtmlPanelElementClickArgs

Wisej.Web.HtmlPanelElementClickArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the HtmlPanelClickHandler event handler.

public class HtmlPanelElementClickArgs : EventArgs

Public Class HtmlPanelElementClickArgs
    Inherits EventArgs

Constructors

HtmlPanelElementClickArgs()

Initializes a new instance of the HtmlPanelClickArgs class.

HtmlPanelElementClickArgs(element, role)

Initializes a new instance of the HtmlPanelClickArgs class.

Name

Type

Description

Properties

Element

String: Returns the HTML of the element that was clicked in the HtmlPanel panel.

String: Returns the role attribute assigned to the element that generated the event.

The value in the Role property is taken from the "role" attribute of the clicked element inside the widget.

Used By

HtmlPanelElementClickHandler

Wisej.Web.HtmlPanelElementClickHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the ElementClick event.

public delegate void HtmlPanelElementClickHandler(Object sender, HtmlPanelElementClickArgs e)

Public Delegate Sub HtmlPanelElementClickHandler(ByVal sender As [Object], ByVal e As HtmlPanelElementClickArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

IFramePanel

Wisej.Web.IFramePanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- IFramePanel

Represents a control that displays any HTML file in an IFrame element.

public class IFramePanel : Control

Public Class IFramePanel
    Inherits Control

Constructors

IFramePanel()

Properties

Allow

String: Allows the IFrame to access certain local features when using a cross-origin source. Valid values for allow include: geolocation, microphone, camera, midi, encrypted-media. See deprecating-permissions-in-cross-origin-iframes for more information on the syntax and values to use in this attribute.

BorderStyle

BorderStyle: Indicates the border style for the control.

Boolean: Returns or sets whether the control shows the scrollbars when needed.

String: Returns or sets the source Url of the IFrame.

Methods

Reloads the contents of the IFrame.

Events

EventHandler Fired when the IFrame has finished loading the document.

EventHandler Fired when the Url property is changed.

Inherited By

Implements

ImageList

Wisej.Web.ImageList

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Component
- Component
  - ImageList

Provides methods to manage a collection of Image objects. This class cannot be inherited.

public class ImageList : Component, IWisejHandler

Public Class ImageList
    Inherits Component
    Implements IWisejHandler

Constructors

ImageList()

Initializes a new instance of the ImageList without a specified container.

ImageList(container)

Initializes a new instance of the ImageList class with a specified container.

Name

Type

Description

Properties

ImageCollection: Returns the ImageCollection for this image list.

Size: Returns or sets the size of the images in the image list.

Throws:

ArgumentException The value assigned is equal to IsEmpty; or the value of the height or width is less than or equal to 0; or the value of the height or width is greater than 256.
ArgumentOutOfRangeException The new size has a dimension less than 0 or greater than 256.

Object: Returns or sets an object that contains additional data about the ImageList.

Color: Returns or sets the color to treat as transparent.

Implements

Label

Wisej.Web.Label

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- Label

Represents a label control.

public class Label : Control

Public Class Label
    Inherits Control

Constructors

Label()

Initializes a new instance of the Label class.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property.

Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

AutoEllipsis

Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the label, denoting that the text extends beyond the size of the label.

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.

BorderStyle: Indicates the border style for the control.

CharacterCasing: Returns or sets the case of the text to display to the user.

Boolean: Enables or disables the browser's context menu.

Image: Returns or sets the image that is displayed on a Label.

ContentAlignment: Returns or sets the alignment of an image that is displayed in the control.

Int32: Returns or sets the image list index value of the image displayed on the label control.

Throws:

ArgumentOutOfRangeException The specified index is less than -1.

String: Returns or sets the key accessor for the image in the ImageList.

ImageList: Returns or sets the ImageList that contains the images to display in the Label control.

String: Returns or sets the theme name or URL for the image to display in the Label.

String: Returns or sets the text associated with this control.

Newlines (CRLF) are converted to when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

ContentAlignment: Returns or sets the alignment of text in the label.

Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control.

Inherited By

Implements

Line

Wisej.Web.Line

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- Line

Represents a line control.

public class Line : Control

Public Class Line
    Inherits Control

Constructors

Line()

Initializes a new instance of the Line class.

Properties

LineColor

Color: Returns or sets a value indicating the color of the line.

LineSize

Int32: Indicates the size of the line in pixels.

LineStyle: Indicates the LineStyle of the Line control.

Orientation: Returns or sets a value indicating the horizontal or vertical orientation of the Line control.

Implements

LinkLabel

Wisej.Web.LinkLabel

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- Label
  - LinkLabel

Represents an hyper-link control.

public class LinkLabel : Label, IButtonControl

Public Class LinkLabel
    Inherits Label
    Implements IButtonControl

Constructors

LinkLabel()

Initializes a new default instance of the LinkLabel class.

Properties

ActiveLinkColor

Color: Returns or sets the color used to display an active link (while being pressed).

DisabledLinkColor

Color: Returns or sets the color used when displaying a disabled link.

LinkArea: Returns or sets the range in the text to treat as a link.

Throws:

ArgumentOutOfRangeException The Start property of the LinkArea object is less than zero; or the Length property of the LinkArea object is less than -1.

LinkBehavior: Returns or sets a value that represents the behavior of a link.

Color: Returns or sets the color used when displaying a link.

Events

LinkLabelLinkClickedEventHandler Fired when a link is clicked within the control.

EventHandler Fired when the value of the TabStop property changes.

Implements

LinkArea

Wisej.Web.LinkArea

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents an area within a LinkLabel control that represents a hyperlink within the control.

public struct LinkArea : ValueType

Public Structure LinkArea
    Implements ValueType

Constructors

LinkArea(start, length)

Initializes a new instance of the LinkArea class.

Name

Type

Description

Properties

IsEmpty

Boolean: Returns a value indicating whether the LinkArea is empty.

Length

Int32: Returns or sets the number of characters in the link area.

Int32: Returns or sets the starting location of the link area within the text of the LinkLabel.

Used By

Canvas

Wisej.Web.Canvas

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the HTML5 canvas element.

Constructors

Canvas()

Initializes a new instance of the class.

Properties

BorderStyle

: Indicates the border style for the control.

FillStyle

: Sets or returns the color, gradient, or pattern used to fill the drawing.

GlobalAlpha

: Sets or returns the current alpha or transparency value of the drawing.

GlobalCompositeOperation

: Sets or returns how a new image are drawn onto an existing image.

LineCap

: Sets or returns the style of the end caps for a line.

LineDashOffset

: Sets or returns the type of corner created, when two lines meet.

LineJoin

: Sets or returns the type of corner created, when two lines meet.

LineWidth

: Sets or returns the current line width, in pixels.

LiveUpdate

: Turns live update mode on or off. When live update is on, all canvas calls are pushed to the client immediately, when is off (default) the control updates the client at the end of the request.

MiterLimit

: Sets or returns the maximum miter length.

ShadowBlur

: Sets or returns the blur level for shadows.

ShadowColor

: Sets or returns the color to use for shadows.

ShadowOffsetX

: Sets or returns the horizontal distance of the shadow from the shape.

ShadowOffsetY

: Sets or returns the vertical distance of the shadow from the shape.

StrokeStyle

: Sets or returns the color, gradient, or pattern used for strokes.

TextAlign

: Sets or returns the current alignment for text content, according to the anchor point.

TextBaseline

: Sets or returns the current text baseline used when drawing text.

TextFont

Draws an image onto the canvas.

Parameter

Type

Description

Use the stroke() method to actually draw the path on the canvas.

MoveTo(location)

Moves the path to the specified point in the canvas, without creating a line.

Parameter

Type

Description

Use the stroke() method to actually draw the path on the canvas.

QuadraticCurveTo(cpx, cpy, x, y)

Adds a point to the current path by using the specified control points that represent a quadratic Bézier curve.

Parameter

Type

Description

Rect(rect)

Creates a rectangle.

Parameter

Type

Description

Rect(x, y, width, height)

Creates a rectangle.

Parameter

Type

Description

Restore()

Returns previously saved path state and attributes.

Rotate(degrees)

Method rotates the current drawing.

Parameter

Type

Wisej.Web.Widget

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- Widget

Provides a generic widget that can use most third party javascript widgets.

public class Widget : Control, IWisejHandler

Public Class Widget
    Inherits Control
    Implements IWisejHandler

See the InitScript property for a detailed description on how to initialize the imported widget.

Constructors

Initializes a new instance of the Widget class.

Properties

BorderStyle

BorderStyle: Indicates the border style for the control.

EnableNativeContextMenu

Boolean: Enables or disables the browser's context menu.

String: Returns or sets the initialization script.

The initialization script is called after the widget is created and before it is rendered by the browser. It is here that the code should initialize the third party widget, hook up any event, and save any reference it may need. The initialization function is named "init" and must be declared like this:

this.init = function(options)
{
  // simple example on how to initialize
  // a jQuery hypothetical widget.
  
  $(this.container).widget(options);
  
  // alternative example on how to
  // initialize a widget that needs a specific
  // child element.
  this.container.innerHTML = "<select id='widget'></select>
  $('#widget').widget(options);
}

The update function is named "update", it is optional, and must be declared like this:

this.update = function(options, old)
{
  // update the widget either using the
  // changed options or by invoking specific methods.
  $('#widget').widget(options);
}

The "options" parameter is optional. It contains a javascript map with all the options defined in the Options property. Within the init function you can refer to the Wisej widget class using "this" and to the HTML element using "this.container". To fire an event back to the server, use "this.fireWidgetEvent() as show in the sample code below:

this.init = function(options)
{
  // add the onSelect handler to the initialization options
  // to relay the client event back to the server side
  // representation of the widget.
  //
  // The e.getId() and e.getText() are just examples, the values
  // to send back to the server depend on the third party widget
  // and the event specification.
  
  var me = this;
  options.onSelect = function(e) {
    me.fireWidgetEvent("select", {id:e.getId(), text:e.getText()});
  };

  $(this.container).widget(options);
}

On the server side, you can handle the WidgetEvent and receive any data passed in the "fireWidgetEvent" call in the Data dynamic object.

Object: Returns a DynamicObject that can convert any method call into the equivalent JavaScript call targeting the third party "widget" object.

An application can invoke any method on the wrapped third party widget by using the Instance property. Dynamic method calls are automatically transformed to JavaScript client calls.


  // invokes the setLineColor(color) JavaScript method
  // on the third party chart widget.
  this.chart1.Instance.setLineColor("red");
  
  // to get a return value you can add either a callback function or
  // use the Async version and await the result.
  this.chart1.Instance.getSeriesCount((count) => { AlertBox.Show(count.ToString()); });
  
  // all methods have the Async version registered automatically.
  var count = await this.chart1.Instance.getSeriesCountAsync();
  AlertBox.Show(count.ToString());

Boolean: Returns whether the JavaScript widget has been initialized.

Object: Returns or sets a dynamic object that is passed to the init(options) function upon initialization of the widget and to the update(options, old) when updating the widget.

The Widget class automatically detects changes to first level fields only. If your code changes a nested object you have to either call Update or notify the Options object that a property has changed like this:


this.widget.Options.value = 10;
// no need to notify, value is a first level field.

this.widget.Options.toolbar.show = true;
// need to notify, show is a field of toolbar.
this.widget.Update();
// or
this.widget.Options.Notify("toolbar.show");

this.widget.Options.toolbar = new { show = true };
// no need to notify, we are setting toolbar.show but the assignment
// changes toolbar which is a first level field.

List<Package>: List of packages required to run this widget.

Each package is a URL to either a JavaScript or a CSS file. The packages are loaded in the order they are listed. If a script depends on another script, it should be declared after the script it depends on, i.e.: Query usually if the first script in the package list. Wisej uses the name of the package to cache it and load it only once. It's important that you use consistent names when creating multiple widgets in order to load the shared packages only once.

String[]: Returns or sets the list of events that are fired by the widget wrapper.

Defines the list of events that the widget wrapper can fire. You have to add the code that handles the third party widget's events and fire a server event back to this widget wrapper. If your initialization code fires the event correctly and the event is registered in the WiredEvents list, the application code can attach a listener to the dynamic Instance object like any native event.


  this.chart1.WiredEvents = new [] {"AreaClick"};

  this.chart1.Instance.areaClick += new WidgetEventHandler(chart1_AreaClick);
  
  private void chart1_AreaClick(object sender, WidgetEventArgs e) {

    // event data is available at e.Data as a dynamic object.
    var data = e.Data;
    var x = data.x;
    var y = data.y;
    var name = data.name;
    AlertBox.Show($"Clicked area {name} at {x}, {y}.");

  }

For the sample code above to receive the "areaClick" event you have to handle the third party widget event and fire a Wisej event. The syntax for the handler registration depends on each wrapped third party widget: some may use native events, other may use jQuery, and others may use callback methods.


  var me = this;
  this.widget.addEventHandler("areaClick", function(e){
    me.fireWidgetEvent("AreaClick", {name:a.areaName, x:e.xPos, y:e.yPos});
  });

The list of the wired events that the server component expects to receive is available on the client side wrapper using the events array: this.getEvents(). [Since 2.5.31] You can attach to the event without having to register it with the WiredEvents collection when you prefix the handler with "on". i.e. this.Instance.onPointClick += new WidgetEventHandler(onPointClick). Wisej will try to attach to the "pointClick" event automatically removing the "on" prefix. When you attach the listener Wisej will automatically add it to the WiredEvents collection. Additionally, instead of having to iterate the this.getEvents() collection in the widget's initScript, you can override "_addListener", "_removeListener", "_getEventData".

  
  this._addListener = function(name, handler) {
    this.widget.on(name, handler);
  }
  
  this._removeListener = function(name, handler) {
    this.widget.off(name, handler);
  }

  this._getEventData = function(type, e, expression) {
    if (type === "cellClick") {
      return {row:e.rowIndex, column:e.colIndex};
    }
  }

Methods

Registers the event handler to listen to the event eventName fired by the third party widget.

Using AddListener only registers the server side handlers and adds the eventName to the list of WiredEvents. However, the client side wiring of the client event and the firing of the event back to the server must Throws:

ArgumentNullException eventName or handler is null.

Removes the event handler for the eventName fired by the third party widget.

Throws:

ArgumentNullException eventName or handler is null.

Events

EventHandler Fired when the widget is created on the client.

WebRequestHandler Fired when the widget used the "postbackUrl" to retrieve data from this control.