Message Banner Workflow Usage
The Commands and Properties available for the Message Banner in Workflows are listed below.
Commands
| Command | Parameters | Description |
|---|---|---|
| Add Text Message | Value 1–5 — These values are the custom columns in the Message Banner. The corresponding column must be added to the banner for the text to appear. | Adds a Text Message for the custom fields in the Message Banner |
| Clear | Clears the rows from the message banner. | |
| Scroll To Top | Scrolls the user to the top of the message list. | |
| Scroll To Bottom | Scrolls the user to the bottom of the message list. | |
| Scroll To Latest | Scrolls the user to the newest message in the message list. | |
| Set Position | X Coordinate — The coordinate on the x-axis to move the item to. Y Coordinate — The coordinate on the y-axis to move the item to. |
Moves the position of the item to a specific set of coordinates on the canvas. |
| Set Size | Width — The width of the item in pixels. Height — The height of the item in pixels. |
Changed the size of the item to a specific Height and Width. |
| Set Visibility | Value — If the item is visible (True) or not (False). | Change whether an item is visible in Runtime. |
| Set Fill Color | Color — The Fill Color of the item. | Set a new Fill Color for the item. |
Properties
| Properties | Description |
|---|---|
| Item ID | The unique identifier for this item. |
| Item Type | The Type of item this is. |
| Row Height | The Height of each Row in pixels. |
| Header Background | The Color for the Background of the header for this item. |
| Header Text | The text value for the Header. |
| Header Text Color | The color of the caption's text. |
| Header Font Family | The name of the font to use for the caption. |
| Header Height | The Height of the header in pixels. |
| Display Header | Whether the Header is visible (True) or not (False). |
| Corner Radius | This determines how rounded or sharp the corners of the item are. The higher the value, the more rounded they are. |
| Fill Color | The color currently set to fill the item background. |
| Border Thickness | How thick in pixels the border is. If required, contained content is clipped to fit within the defined border. |
| Border Color | The color of the border on the item. |
| Item Name | The unique ID for this item. This property is deprecated and it is recommended to use the Item ID property instead. |
| Name | The value for this property is the Description configured via the property grid when the item is selected in Designer. |
| Width | The horizontal length of the item in pixels. |
| Height | The vertical height of the item in pixels. |
| Opacity | How visible the item is. The higher the value, the more opaque it is. The lower the value, the more translucent it is. |
| Top | The value for where on the y-axis the top of the item is located in relation to the canvas. |
| Left | The value for where on the x-axis the left side of the item is located in relation to the canvas. |
| Z Index | The position of the item when overlapped with other items. The item with the higher index value appears on top. |
| Is Visible | Whether the item is visible (True) or not (False). |