GraffitiSuite Docs
Docs
Graffitibuttonsegment
Loading document parsing libraries...
# GraffitiButtonSegment Class Inherits GraffitiWebUIControl ## About GraffitiSegButton is a powerful segmented button component that can double as a BevelButton, toolbar replacement, and much more! ## Compatibility ### Framework API Version | 1.0 | 2.0 | | :---: | :---: | | True | True | ### Web | 32-Bit | 64-Bit | | :---: | :---: | | True | True | ## Enumerations | Name | Value | Description | | --- | :---: | --- | | SelectionModes | None <br> Single <br> Multiple | Supported item selection models. | | Sizes | SizeDefault <br> SizeLarge <br> SizeSmall | Supported button sizes. | ## Event Definitions | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | ButtonPressed | button as GraffitiButtonSegmentItem | (None) | Fires when a button is selected or deselected. | | GotFocus | (None) | (None) | | | LostFocus | (None) | (None) | | | MouseEnter | (None) | (None) | Raised when the user's cursor enters the control. | | MouseExit | (None) | (None) | Raised when user's cursor exits the control. | | Open | (None) | (None) | | | Shown | (None) | (None) | | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | Add | button as GraffitiButtonSegmentItem | (None) | Add a new button to the Segment. | | DeselectAll | (None) | (None) | Deselects all buttons. | | Item | index as Integer | GraffitiButtonSegmentItem | Returns the item at the specified index. | | Item | name as String | GraffitiButtonSegmentItem | Returns the item at the specified index. | | LastIndex | (None) | Integer | Returns the index of the final item in the internal array of items. | | Remove | button as GraffitiButtonSegmentItem | (None) | Removes the specified button from the control. | | Remove | index as Integer | (None) | Removes the specified button from the control. | | RemoveAll | (None) | (None) | Remove all items from the control. | | SelectAll | (None) | (None) | Selects all items. | | Attributes | Hidden = True | UpdateProperty | | | Attributes | Hidden = True | UpdatePropertyMultiple | | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | Enabled | Boolean | Nil | | | FullWidth | Boolean | Nil | If True all buttons will expand to fill the display, ignoring the assigned SegmentSize. | | Mode | SelectionModes | Nil | Determines how the control reacts to button presses. | | SegmentSize | Sizes | Nil | The size of the button segments, matching the class's constants. | | Toggle | Boolean | Nil | Determines whether the buttons should be toggleable. | | Value | GraffitiButtonSegmentItem | Nil | The currently selected item. Not for use when Toggle = true. |