AlertBox

Wisej.Web.AlertBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Component
- AlertBox

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

Public Class AlertBox
    Inherits Component

Methods

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	String	The text to display in the message box. Newlines (CRLF) are converted to when the text doesn't contain any html.
icon	MessageBoxIcon	One of the MessageBoxIcon values that specifies which icon to display in the message box.
showCloseButton	Nullable<Boolean>	Shows or hides the close button. If not set it's managed automatically.
alignment	ContentAlignment	One of the ContentAlignment values that specifies where on the screen to display the alert box.
autoCloseDelay	Int32	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	Action	Optional async handler for the close event; called when the Alert Box is closed either automatically or by the user.
showProgressBar	Nullable<Boolean>	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	Boolean	Allows the message text to include HTML code.

Parameter

Type

Description

text

String

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

icon

MessageBoxIcon

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

showCloseButton

Nullable<Boolean>

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

alignment

ContentAlignment

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

autoCloseDelay

Int32

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

Action

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

showProgressBar

Nullable<Boolean>

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

Boolean

Allows the message text to include HTML code.