Table of Contents
Enumerations #
| Name | Values |
|---|---|
| MessagePositions | Top |
| TopLeft | |
| TopCenter | |
| TopRight | |
| Center | |
| CenterLeft | |
| CenterRight | |
| Bottom | |
| BottomLeft | |
| BottomCenter | |
| BottomRight | |
Constants #
This class exposes no constants.
Events #
| Definition | Parameters | Description |
|---|---|---|
| Ended | None | Raised when the user has clicked “Done” on the final step of the tour or otherwise left the tour. |
| MovedNext | index as Integer | Raised when the user progresses to the next step in the tour. |
| item as GraffitiTourItem | ||
| MovedPrevious | index as Integer | Raised when the user has clicked the “Previous” button to step backward in the tour. |
| item as GraffitiTourItem | ||
| Started | None | Raised when the tour has started or restarted. |
Methods #
| Definition | Parameters | Return Type | Description |
|---|---|---|---|
| Add | item as GraffitiTourItem | None | Adds a step to the tour. |
| AddAt | index as Integer | None | Inserts item at index in the tour. |
| item as GraffitiTourItem | |||
| AddMultiple | ParamArray items() as GraffitiTourItem | None | Adds items in bulk to the tour. |
| Item | index as Integer | GraffitiTourItem | Returns the item at the specified index. |
| LastIndex | None | Integer | Returns the index of the last item in the tour. |
| Remove | index as Integer | None | Removes the item at the specified index. |
| RemoveAll | None | None | Removes all tour items. |
| Reset | None | None | Resets the user’s tour progress back to the beginning. |
| Start | None | None | Starts the user’s tour either at the beginning or where they left off. |
| StartAt | index as Integer | None | Start the tour at the specified step index. |
Properties #
| Name | Type | Default Value | Description |
|---|---|---|---|
| Active (Read Only) | Boolean | False | Returns True when the tour is currently in progress. |
| AllowClose | Boolean | True | Determines whether the Close button is visible and users are allowed to exit the tour early. |
| AllowKeyboardControl | Boolean | True | Allows use of the keyboard to step through or end the tour when value is True. |
| ButtonVisible | Boolean | True | When False, all buttons will be hidden. |
| CaptionClose | String | “× Close” | Caption of the Close button. Raw HTML supported. |
| CaptionDone | String | “Done” | Caption of the Done button (replaces the Next button on the last step of the tour). Raw HTML supported. |
| CaptionNext | String | “Next” | Caption of the Next button. Raw HTML supported. |
| CaptionPrevious | String | “Previous” | Caption of the Previous button. Raw HTML supported. |
| CurrentStep | Integer | 0 | On which step the tour is currently. |
| IndicatorClose | WebUIControl.Indicators | WebUIControl.Indicators.Danger | Bootstrap indicator applied to the Close button. |
| IndicatorNext | WebUIControl.Indicators | WebUIControl.Indicators.Primary | Bootstrap indicator applied to the Next button. |
| IndicatorPrevious | WebUIControl.Indicators | WebUIControl.Indicators.Secondary | Bootstrap indicator applied to the Previous button. |
| IsAnimated | Boolean | True | Determines whether steps through the tour are animated. |
| Opacity | Double | 0.75 | Opacity of the page overlay that is applied while the tour is active. Valid values are between 0.0 and 1.0 |
| OverlayColor | Color | &cFFFFFF | Color overlaid on the active control. Transparency supported. |
| OverlayNextOnClick | Boolean | False | When True, the tour will progress the next step in the tour if the user clicks on the background overlay. |
| Padding | Integer | 10 | Padding around the currently focused control for tour steps. |
Examples #
This class currently has no examples.
Notes #
This class currently has no notes.