# GraffitiTour
Class Inherits GraffitiWebUIControl
## About
GraffitiTour is a beautifully animated and powerful user training assistant that allows you to create a guided tour of your application's interface.
## Compatibility
### Framework API Version
| 1.0 | 2.0 |
| :---: | :---: |
| True | True |
### Web
| 32-Bit | 64-Bit |
| :---: | :---: |
| True | True |
## Event Definitions
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| Closed | (None) | (None) | |
| Ended | (None) | (None) | Raised when the user has clicked “Done” on the final step of the tour or otherwise left the tour. |
| MovedNext | index as Integer <br> item as GraffitiTourItem | (None) | Raised when the user progresses to the next step in the tour. |
| MovedPrevious | index as Integer <br> item as GraffitiTourItem | (None) | Raised when the user has clicked the “Previous” button to step backward in the tour. |
| Started | (None) | (None) | Raised when the tour has started or restarted. |
## Methods
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| Add | item as GraffitiTourItem | (None) | Adds a step to the tour. |
| AddAt | index as Integer <br> item as GraffitiTourItem | (None) | Inserts item at index in the tour. |
| 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. |
| Resume | (None) | (None) | Resumes the last tour. |
| 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 | Boolean | Nil | Returns True when the tour is currently in progress. |
| AllowClose | Boolean | Nil | Determines whether the Close button is visible and users are allowed to exit the tour early. |
| AllowKeyboardControl | Boolean | Nil | Allows use of the keyboard to step through or end the tour when value is True. |
| ButtonsVisible | Boolean | Nil | Controls visibility of tour buttons. |
| CaptionDone | String | Nil | Caption of the Done button (replaces the Next button on the last step of the tour). Raw HTML supported. |
| CaptionNext | String | Nil | Caption of the Next button. Raw HTML supported. |
| CaptionPrevious | String | Nil | Caption of the Previous button. Raw HTML supported. |
| CurrentStep | Integer | Nil | On which step the tour is currently. |
| IndicatorClose | WebUIControl.Indicators | Nil | Bootstrap indicator applied to the Close button. |
| IndicatorNext | WebUIControl.Indicators | Nil | Bootstrap indicator applied to the Next button. |
| IndicatorPrevious | WebUIControl.Indicators | Nil | Bootstrap indicator applied to the Previous button. |
| IsAnimated | Boolean | Nil | Determines whether steps through the tour are animated. |
| Opacity | Double | Nil | Opacity of the page overlay that is applied while the tour is active. Valid values are between 0.0 and 1.0 |
| OverlayColor | Color | Nil | Color overlaid on the active control. Transparency supported. |
| Padding | Integer | Nil | Padding around the currently focused control for tour steps. |
| ShowProgress | Boolean | Nil | Controls visibility of tour progress status section. |
