Table of Contents
Enumerations #
| Name | Values |
|---|---|
| ButtonPositions | Left Center Right |
Constants #
| Name | Type | Value |
|---|---|---|
| This class exposes no constants. |
Events #
| Definition | Description |
|---|---|
| This class exposes no events. |
Constructors #
| Name | Parameters |
|---|---|
| Constructor | msgName as String msgContent as String msgTitle as String = “” |
| Constructor | msgName as String msgContent as String msgIndicator as WebUIControl.Indicators msgTitle as String = “” |
| Constructor | msgName as String msgContent as String msgTimeout as Integer msgPosition as GraffitiAlert.MessagePositions msgProgressbar as Boolean = True msgTitle as String = “” |
Properties #
| Name | Type | Default Value | Description |
|---|---|---|---|
| ButtonAlignment | ButtonPositions | ButtonPositions.Left | Position within the alert’s footer where buttons will be displayed. |
| ButtonAreaStyle | GraffitiStyle | Nil | GraffitiStyle applied to the area of the alert which contains any buttons. |
| Buttons() | GraffitiWebAlertButton | Nil | Buttons to be displayed on the Alert. |
| CanOverflow | Boolean | False | Determines whether other objects will be able to extend outside the alert’s area. |
| CloseButton | Boolean | False | If True a close button will be displayed to allow users to dismiss the alert. |
| CloseOnInteraction | Boolean | True | Controls whether interactions with buttons or the modal backdrop will close the message. |
| Content | String | “” | The content of the alert. |
| ContentContainer | WebContainer | Nil | The WebContainer to embed within the alert. The container must be loaded in the browser using EmbedWithin first. |
| ContentStyle | GraffitiStyle | Nil | GraffitiStyle to apply to the alert’s content area. |
| Draggable | Boolean | False | When True and the message has a title, it can be dragged around the page. |
| Icon | String | “” | The FontAwesome 5 Icon identifier for the alert, IE: fas fa-times |
| IconStyle | GraffitiStyle | Nil | GraffitiStyle applied to the icon within the message. |
| Indicator | WebUIControl.Indicators | Default | Bootstrap Indicator to apply to the message. |
| Left | Integer | -1 | Left position of the alert when shown. -1 for default. |
| Height | Integer | -1 | Height of the alert when shown. -1 for auto. |
| MaximizeButton | Boolean | False | When True and the message has a title, a Maximize button will be displayed in the titlebar. |
| Minimize Button | Boolean | False | True and the message has a title, a Minimize button will be displayed in the titlebar. |
| Modal | Boolean | False | If True clicks outside the alert will be ignored. |
| Name | String | “” | A unique name provided to the alert for identification purposes. This should contain no spaces or other special characters. _ or - are acceptable. |
| Position | GraffitiWebAlert.MessagePositions | Top | The position of the alert within the browser window. |
| Progressbar | Boolean | True | Displays a progressbar that counts down with the Timeout property. |
| Resizable | Boolean | False | When True, the alert can be resized from the East and South edges, as well as the SouthEast corner. |
| Style | GraffitiStyle | Nil | Custom GraffitiStyle for altering the appearance of the alert. |
| Tag | Variant | Nil | Developer storage. |
| Timeout | Integer | 10000 | How long the alert will be visible on the screen. A value of 0 disables the automatic dismissal. |
| Title | String | “” | Text shown within the alert’s titlebar when applicable. |
| TitleStyle | GraffitiStyle | Nil | GraffitiStyle applied to the titlebar area of the alert when applicable. |
| Top | Integer | -1 | Top position of the alert when shown. -1 for default. |
| Width | Integer | -1 | Width of the alert when shown. -1 for default. |
Examples #
There are currently no examples for this class.