Table of Contents
Enumerations #
Name | Values |
---|---|
MessagePositions | Top |
TopLeft | |
TopCenter | |
TopRight | |
Center | |
CenterLeft | |
CenterRight | |
Bottom | |
BottomLeft | |
BottomCenter | |
BottomRight | |
Constants #
Name | Type | Value |
---|
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 |
---|
This class exposes no properties.
Examples #
This class currently has no examples.
Notes #
This class currently has no notes.