# GraffitiStepBar
Class Inherits GraffitiSuite.BaseCanvas
## About
A display for integral actions, such as movement through a wizard. Uses custom icons and allows clicks, so it may double as a simple toolbar.
Features:
*
Clickable steps
*
Define custom point width
*
Define custom colors
## Preview
Previous
Next
## Compatibility
### Framework API Version
| 1.0 | 2.0 |
| :---: | :---: |
| True | True |
### Desktop
| 32-Bit | 64-Bit |
| :---: | :---: |
| True | True |
## Attributes
| Name | Value |
| --- | --- |
| DefaultEvent | "SelectionChanged" |
## Event Definitions
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| MouseEnterItem | item as GraffitiStepBarItem | (None) | Raised when the mouse enters a step item. |
| MouseExitItem | item as GraffitiStepBarItem | (None) | Raised when the mouse exits a step item. |
| SelectionChanged | (None) | (None) | Raised when the currently selected step item has been changed. |
| StepClicked | ItemClicked as GraffitiStepBarItem <br> ItemIndex as Integer | Boolean | A step on the StepBar has been clicked, return False to cancel navigation. |
## Methods
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| Sub | Add | (None) | Adds a step item. |
| Sub | AddAt | (None) | Inserts a step item. |
| Function | IndexOf | As | Returns the index of the specified step item. |
| Function | ItemAt | As | Returns the step item at the specified index. |
| Function | LastIndex | As | Returns the index of the final step item. |
| Sub | RemoveAll | (None) | Removes all step items. |
| Sub | RemoveAt | (None) | Removes the step item at the specified index. |
## Properties
| Name | Type | Default Value | Description |
| --- | :---: | :---: | --- |
| AllowNavigation | Boolean | Nil | Allow the user to change the value of the StepBar by clicking steps. |
| BGColorActive | ColorGroup | Nil | Item background color when active. |
| BGColorInactive | ColorGroup | Nil | Item background color when inactive. |
| BorderColor | ColorGroup | Nil | Sets the dark border color when UseCustomColors is True. |
| BorderRadius | Integer | Nil | The radius of the control’s corners, in pixels. |
| DescriptionBold | Boolean | Nil | Determines the font weight of the description text. |
| DescriptionColorActive | ColorGroup | Nil | Determines the color for active description text. |
| DescriptionColorInactive | ColorGroup | Nil | Determines the color for inactive description text. |
| DescriptionItalic | Boolean | Nil | Determines whether the description text is displayed in italics. |
| DescriptionTextFont | String | Nil | Sets the font face for the description text. |
| DescriptionTextSize | Integer | Nil | Sets the font size for the description text. |
| DescriptionUnderline | Boolean | Nil | Determines whether the description text is displayed with an underline. |
| PointWidth | Integer | Nil | The width, in pixels, of the point for each step. |
| Private | | GraffitiStepBarItem | |
| Private | As | = | |
| Private | As | = | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | = | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| Private | As | Nil | |
| SelectedItem | Integer | Nil | Returns the index of the currently selected StepBarItem. |
| TitleBold | Boolean | Nil | Sets whether the title is displayed in bold. |
| TitleColorActive | ColorGroup | Nil | Determines the color of the active items title. |
| TitleColorInactive | ColorGroup | Nil | Determines the color of inactive items title. |
| TitleItalic | Boolean | Nil | Sets whether titles are displayed in italics. |
| TitleTextFont | String | Nil | The font face used to display titles. |
| TitleTextSize | Integer | Nil | The font size used to display titles. |
| TitleUnderline | Boolean | Nil | Determines whether the item titles are displayed with an underline. |
| UseCustomColors | Boolean | Nil | Determines whether the class is drawn with the custom defined colors. |
