AlertBox

Wisej.Web.AlertBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Displays an alert box that can contain an icon and text that inform and instruct the user. Alert boxes are not modal and can disappear automatically.

public class AlertBox : Component

Methods

OnAddReferences(list)

Returns a collection of referenced components or collection of components.

Parameter
Type
Description

list

List of referenced components or collection of components.

OnWebRender(config)

Renders the client component.

Parameter
Type
Description

config

Dynamic configuration object.

Show(text, icon, showCloseButton, alignment, autoCloseDelay, onclose, showProgressBar, allowHtml)

Displays an alert box with the specified text and icon in the specified position.

Parameter
Type
Description

text

The text to display in the message box. Newlines (CRLF) are converted to <BR/> when the text doesn't contain any html.

icon

One of the MessageBoxIcon values that specifies which icon to display in the message box.

showCloseButton

Shows or hides the close button. If not set it's managed automatically.

alignment

One of the ContentAlignment values that specifies where on the screen to display the alert box.

autoCloseDelay

A value in milliseconds that determines the delay after which the alert box disappears automatically. The default is 5000 (5 seconds). If set to 0 the box stays open.

onclose

Optional async handler for the close event; called when the Alert Box is closed either automatically or by the user.

showProgressBar

Shows a progress bar to display the time remaining until the alert box is automatically closed. If left null, it's managed by the theme.

allowHtml

Allows the message text to include HTML code.

Implements

Name
Description

Provides access to the UserData and Tag properties associated to the component implementing this interface.

All wisej components implement this interface.

Allows an object to serialize itself.

Last updated

Was this helpful?