GraffitiStepBar

Images #

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

Enumerations #

Name	Values
	This class exposes no enumerations.

Constants #

Name	Type	Value
		This class exposes no constants.

Events #

Definition	Description
StepClicked(ItemClicked as GraffitiStepBarItem, ItemIndex as Integer) as Boolean	A step on the StepBar has been clicked, return False to cancel navigation.

Methods #

Definition	Description
AddItem( newItem as GraffitiStepBarItem )	Add a new StepBarItem to the class.
ItemCount() as Integer	Returns the number of StepBarItems currently displayed.
RemoveItem( Index as Integer )	Removes the item at the specified index.

Properties #

Name	Type	Default Value	Description
AllowNavigation	Boolean	False	Allow the user to change the value of the StepBar by clicking steps.
BackgroundColorActive	ColorGroup	Nil	Sets the background color for active steps when UseCustomColors is True.
BackgroundColorInactive	ColorGroup	Nil	Sets the background color for inactive steps when UseCustomColors is True.
BorderColorDark	ColorGroup	Nil	Sets the dark border color when UseCustomColors is True.
BorderColorLight	ColorGroup	Nil	Sets the light border color when UseCustomColors is True.
BorderRadius	Integer	20	The radius of the control’s corners, in pixels.
DescriptionBold	Boolean	False	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	False	Determines whether the description text is displayed in italics.
DescriptionTextFont	String	“System”	Sets the font face for the description text.
DescriptionTextSize	Integer	0	Sets the font size for the description text.
DescriptionUnderline	Boolean	False	Determines whether the description text is displayed with an underline.
PointWidth	Integer	0	The width, in pixels, of the point for each step.
SelectedItem	Integer	-1	Returns the index of the currently selected StepBarItem.
TitleBold	Boolean	False	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	False	Sets whether titles are displayed in italics.
TitleTextFont	String	“System”	The font face used to display titles.
TitleTextSize	Integer	0	The font size used to display titles.
TitleUnderline	Boolean	False	Determines whether the item titles are displayed with an underline.
UseCustomColors	Boolean	False	Determines whether the class is drawn with the custom defined colors.

Examples #

There are currently no examples for this class.