# GraffitiTour
Class
## About
GraffitiTour is a beautifully animated and powerful user training assistant that allows you to create a guided tour of your application's interface.
## Preview
## Compatibility
### Framework API Version
| 1.0 | 2.0 |
| :---: | :---: |
| True | True |
### Desktop
| 32-Bit | 64-Bit |
| :---: | :---: |
| True | True |
## Attributes
| Name | Value |
| --- | --- |
| DefaultEvent | "Started" |
## Enumerations
| Name | Value | Description |
| --- | :---: | --- |
| AnimationStyles | Fade <br> SlideUp <br> SlideDown <br> SlideLeft <br> SlideRight <br> Grow <br> Reveal <br> RollHorizontal <br> RollVertical <br> WindowShade <br> Doors <br> None | Supported show and hide animation styles. |
## Event Definitions
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| BeforeMoveNext | (None) | Boolean | |
| Cancelled | (None) | (None) | Raised when the tour has ended by the user canceling. |
| Ended | (None) | (None) | Raised when the tour has ended by the user clicking the “Done” button at the end. |
| HighlightCompleted | target as Object | (None) | Raised when a Highlight operation has been full displayed and any animation is complete. |
| LinkPressed | item as GraffitiTourItem <br> index as Integer <br> content as String | (None) | Raised when a link within a tour step has been pressed. |
| MovedNext | (None) | (None) | Raised when the user has progressed forward in the tour. |
| MovedPrevious | (None) | (None) | Raised when the user chooses to reverse a step in the tour. |
| Paint | g as Graphics <br> areas() as Rect | (None) | |
| Started | (None) | (None) | Raised when the tour has started. |
| UnhighlightCompleted | target as Object | (None) | Raised when a highlight operation has ended and any animation is complete. |
## Methods
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| Sub | Add | (None) | Adds a new step to the tour. |
| Sub | AddAt | (None) | Inserts a new tour step. |
| Sub | AddMultiple | (None) | Adds multiple tour steps. |
| Sub | AddMultiple | (None) | Adds multiple tour steps. |
| Sub | Constructor | (None) | Creates a new instance of the class. |
| Sub | Constructor | (None) | Creates a new instance of the class. |
| Function | CurrentStepItem | As | |
| Sub | Destructor | (None) | |
| Sub | Highlight | (None) | If the tour is inactive, this method will highlight the supplied DesktopContainer for a set period of time. |
| Sub | Highlight | (None) | If the tour is inactive, this method will highlight the supplied DesktopUIControl for a set period of time. |
| Sub | Highlight | (None) | If the tour is inactive, this method will highlight the supplied Rect for a set period of time. |
| Function | ItemAt | As | Returns the item at the specified index. |
| Function | LastIndex | As | Returns the index of the last item in the tour. |
| Sub | MoveNext | (None) | Moves to the next step of the tour. |
| Sub | MovePrevious | (None) | Moves to the previous step of the tour. |
| Sub | RemoveAll | (None) | Removes all steps from the tour. |
| Sub | RemoveAt | (None) | Removes the item at the specified index. |
| Sub | Reset | (None) | Ends and resets the tour. |
| Sub | Resume | (None) | Resumes the tour from the user’s last position. |
| Sub | Start | (None) | Starts a new tour. |
| Sub | StartAt | (None) | Starts the tour at the specified index. |
| Sub | Stop | (None) | Ends the current tour. |
| Sub | Unhighlight | (None) | Ends a highlight duration before it is elapsed. |
## Properties
| Name | Type | Default Value | Description |
| --- | :---: | :---: | --- |
| Active | Boolean | Nil | Returns True when the tour is in progess. |
| AllowClose | Boolean | Nil | Determines whether tour cards will display a close button. |
| AnimationEasing | GraffitiAnimator.Easings | Nil | Easing operation used to control animation progression. |
| AnimationLength | Integer | 250 | Length of in/out animation. |
| AnimationStyle | AnimationStyles | Nil | Style of animation, IE: Fade, Roll, Slide, Reveal. |
| Attributes | wasCancelled | Boolean | |
| Attributes | isEnding | Boolean | |
| BorderRadius | Integer | 10 | Border radius drawn on the container. |
| ButtonsVisible | Boolean | Nil | When False, Next/Previous buttons will not be visible. Useful for timed progression or highlighting a single object in the user interface. |
| CaptionDone | String | Nil | Text to display in the right-most button of the last card in the tour. |
| CaptionNext | String | Nil | Text to display in the left button of the last card in the tour. |
| CaptionPrevious | String | Nil | Text to display in the left button of the tour when there are steps remaining. |
| CurrentStep | Integer | Nil | Current step in the tour regardless of active state. |
| HasOverlayColor | Boolean | False | Determines if a custom overlay color should be drawn behind tour steps. |
| IsAnimated | Boolean | Nil | Alternative to AnimationStyle.None that may be used to disable animations. Some underpowered systems may have issues with animations in UI, or users may not desire excessive screen motion, so you may wish to provide a setting to disable animations. |
| OverlayColor | ColorGroup | Nil | Colors applied to the backdrap, overrides default transparent color. |
| OverlayNextOnClick | Boolean | Nil | When True, clicking the modal backdrop will progress the tour to the next step. |
| Padding | Integer | Nil | Padding between tour items and their target. |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | = | |
| Private | | GraffitiTourItem | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | = | |
| Private | As | = | |
| Private | As | = | |
| Private | As | = | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | = | |
| StepTextFormat | String | "{current} | Format applied to tour status text. |
| Window | DesktopWindow | Nil | Read only once set (either directly or via the Constructor). The parent window of the tour. |
