MessageBox
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.1.0.0)
Displays a message box that can contain text, buttons, and symbols that inform and instruct the user.
- C#
- VB.NET
public class MessageBox : Component
Public Class MessageBox
Inherits Component
Methods
Dispose(disposing)
Frees resources related to this component.
| Parameter | Type | Description |
|---|---|---|
| disposing | Boolean | true when this method is called by the application rather than a finalizer. |
OnWebEvent(e)
Processes the event from the client.
| Parameter | Type | Description |
|---|---|---|
| e | WisejEventArgs | Event arguments. |
OnWebRender(config)
Renders the client component.
| Parameter | Type | Description |
|---|---|---|
| config | Object | Dynamic configuration object. |
Show(text, caption, buttons, icon, defaultButton, modal, allowHtml, keepOnScreen, rightToLeft, onclose)
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.
| Parameter | Type | Description |
|---|---|---|
| text | String | The text to display in the message box. Newlines (CRLF) are converted to <BR/> when the text doesn't contain any html. |
caption  | String | The text to display in the title bar of the message box. |
| buttons | MessageBoxButtons | One of the MessageBoxButtons values that specifies which buttons to display in the message box. |
| icon | MessageBoxIcon | One of the MessageBoxIcon values that specifies which icon to display in the message box. |
| defaultButton | MessageBoxDefaultButton | One of the MessageBoxDefaultButton values that specifies the default button for the message box. |
| modal | Boolean | Indicates whether the message box is modal and waits for the user response before resuming execution. When set to false, the return value is always DialogResult.None. The default is true - modal. |
| allowHtml | Boolean | Allows the message text to include HTML code. |
| keepOnScreen | Boolean | Keeps the message box in the viewable area when being moved by the user. The default is false. |
| rightToLeft | RightToLeft | Indicates whether the dialog box should display it's content right aligned. |
| onclose | Action<DialogResult> | Optional async handler for the close event; called when the MessageBox has been closed. |
Returns: DialogResult. One of the DialogResult values.
Show(owner, text, caption, buttons, icon, defaultButton, modal, allowHtml, keepOnScreen, rightToLeft, onclose)
Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.
| Parameter | Type | Description |
|---|---|---|
| owner | Form | An implementation of Form that owns the modal dialog box. |
| text | String | The text to display in the message box. Newlines (CRLF) are converted to <BR/> when the text doesn't contain any html. |
| caption | String | The text to display in the title bar of the message box. |
| buttons | MessageBoxButtons | One of the MessageBoxButtons values that specifies which buttons to display in the message box. |
| icon | MessageBoxIcon | One of the MessageBoxIcon values that specifies which icon to display in the message box. |
| defaultButton | MessageBoxDefaultButton | One of the MessageBoxDefaultButton values that specifies the default button for the message box. |
| modal | Boolean | Indicates whether the dialog box is modal and waits for the user response before resuming execution. When set to false, the return value is always DialogResult.None. The default is true - modal. |
| allowHtml | Boolean | Allows the message text to include HTML code. |
| keepOnScreen | Boolean | Keeps the message box in the viewable area when being moved by the user. The default is false. |
| rightToLeft | RightToLeft | Indicates whether the dialog box should display it's content right aligned. |
| onclose | Action<DialogResult> | Optional async handler for the close event; called when the MessageBox has been closed. |
Returns: DialogResult. One of the DialogResult values.
ShowAsync(text, caption, buttons, icon, defaultButton, modal, allowHtml, keepOnScreen, rightToLeft)
Asynchronously displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.
| Parameter | Type | Description |
|---|---|---|
| text | String | The text to display in the message box. Newlines (CRLF) are converted to <BR/> when the text doesn't contain any html. |
| caption | String | The text to display in the title bar of the message box. |
| buttons | MessageBoxButtons | One of the MessageBoxButtons values that specifies which buttons to display in the message box. |
| icon | MessageBoxIcon | One of the MessageBoxIcon values that specifies which icon to display in the message box. |
| defaultButton | MessageBoxDefaultButton | One of the MessageBoxDefaultButton values that specifies the default button for the message box. |
| modal | Boolean | Indicates whether the dialog box is modal and waits for the user response before resuming execution. When set to false, the return value is always DialogResult.None. The default is true - modal. |
| allowHtml | Boolean | Allows the message text to include HTML code. |
| keepOnScreen | Boolean | Keeps the message box in the viewable area when being moved by the user. The default is false. |
| rightToLeft | RightToLeft | Indicates whether the dialog box should display it's content right aligned. |
Returns: Task<DialogResult>. One of the DialogResult values.
ShowAsync(owner, text, caption, buttons, icon, defaultButton, modal, allowHtml, keepOnScreen, rightToLeft)
Asynchronously displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.
| Parameter | Type | Description |
|---|---|---|
| owner | Form | An implementation of Form that owns the modal dialog box. |
| text | String | The text to display in the message box. Newlines (CRLF) are converted to <BR/> when the text doesn't contain any html. |
| caption | String | The text to display in the title bar of the message box. |
| buttons | MessageBoxButtons | One of the MessageBoxButtons values that specifies which buttons to display in the message box. |
| icon | MessageBoxIcon | One of the MessageBoxIcon values that specifies which icon to display in the message box. |
| defaultButton | MessageBoxDefaultButton | One of the MessageBoxDefaultButton values that specifies the default button for the message box. |
| modal | Boolean | Indicates whether the dialog box is modal and waits for the user response before resuming execution. When set to false, the return value is always DialogResult.None. The default is true - modal. |
| allowHtml | Boolean | Allows the message text to include HTML code. |
| keepOnScreen | Boolean | Keeps the message box in the viewable area when being moved by the user. The default is false. |
| rightToLeft | RightToLeft | Indicates whether the dialog box should display it's content right aligned. |
Returns: Task<DialogResult>. One of the DialogResult values.
Implements
| Name | Description |
|---|---|
| IUserData | Provides access to the UserData and Tag properties associated to the component implementing this interface. |
| IWisejComponent | All wisej components implement this interface. |
| IWisejSerializable | Allows an object to serialize itself. |