GRAFFITILISTBOX - GRAFFITISUITE DOCS

# GraffitiListbox Container Inherits DesktopContainer ## About GraffitiListbox is a replacement for the standard Xojo listbox that uses GraffitiColors to properly draw list contents, supports cell border variants, cell alignments, advanced modern header with support for drop-down menus, and much more! Looks great on macOS, Windows, or Linux! ## Preview ![](https://graffitisuite.com/wp-content/uploads/2023/05/desktop_listbox1.png) Previous Next ## Enumerations | Name | Value | Description | | --- | :---: | --- | | Borders | None ThinDotted ThinSolid ThickSolid DoubleThinSolid | Possible border styles. | | HoverEffects | System On Off | Possible row hover effects. | ## Event Definitions | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | CellAction | Row as Integer Column as Integer | (None) | If a cell is editable, a CellAction event occurs when the user finishes editing a cell. Row and Column are zero-based. | | CellBackgroundPaint | g as Graphics Row as Integer Column as Integer | Boolean | Raised when a cell's background is being drawn. | | CellClick | Row as Integer Column as Integer X as Integer Y as Integer | Boolean | Raised when the user clicks a cell. | | CellGotFocus | Row as Integer Column as Integer | (None) | The user has selected an editable cell of a ListBox. Row and Column are zero-based. | | CellKeyDown | row as Integer column as Integer key as String | Boolean | The user has pressed a key while a cell in the ListBox is being edited. Row and Column are zero-based. | | CellLostFocus | row as Integer column as Integer | (None) | An editable cell has lost focus. | | CellTextChange | Row as Integer Column as Integer | (None) | The user has changed the text in an editable cell. | | CellTextPaint | g as Graphics Row as Integer Column as Integer x as Integer y as Integer | Boolean | Raise before text is drawn to cells, allowing modifcation. | | Change | (None) | (None) | The user has selected a row. | | CollapseRow | Row as Integer | (None) | The user has collapsed a hierarchical row. | | ColumnResized | column as Integer | (None) | Raised when a column resize operation has completed. | | ColumnResizing | column as Integer | (None) | Raised during a column resize operation. | | CompareRows | Row1 as Integer Row2 as Integer Column as Integer ByRef Result as Integer | Boolean | Compare rows for sort operations. | | ConstructContextualMenu | Base As DesktopMenuItem x As Integer y As Integer | Boolean | (None) | | ContextualMenuItemSelected | selectedItem as DesktopMenuItem | Boolean | (None) | | DisclosureWidgetPaint | g As Graphics row As Integer ByRef x As Integer ByRef y As Integer ByRef width As Integer ByRef height As Integer | Boolean | The hierarchical expand/collapse icon is being drawn. | | DoubleClick | (None) | (None) | The user has double-clicked a row or cell. | | DragEnter | obj as DragItem Action as DragItem.Types | Boolean | Fires when the passed DragItem enters the RectControl. | | DragExit | obj as DragItem Action as DragItem.Types | (None) | Raised when the dragged item has left the display area. | | DragOver | x as Integer y as Integer obj as DragItem Action as DragItem.Types | Boolean | Raised when a DragItem is being dragged inside the display. | | DragOverRow | x As Integer y As Integer obj As DragItem action As DragItem.Types ByRef row As Integer ByRef parentRow As Integer ByRef location As Desktoplistbox.DropLocations | Boolean | Raised when a DragItem is being dragged over rows. | | DragReorderRows | newPosition As Integer parentRow As Integer | Boolean | Raised when a row has been dragged to a new position. | | DragRow | Drag as DragItem Row as Integer | Boolean | Raised when a row drag operation has begun. | | DropObject | Obj as DragItem Action as DragItem.Types | (None) | Raised when a DragItem has been dropped on the control. | | DropObjectOnRow | x As Integer y As Integer obj As DragItem action As DragItem.Types row As Integer parentRow As Integer location As Desktoplistbox.DropLocations | (None) | Raised when a DragItem has been dropped on a row. | | EnableMenuItems | (None) | (None) | The control has received the focus. Menu handlers are invoked if the control has the focus. | | ExpandRow | Row as Integer | (None) | Raised when the user has expanded a hierarchical row. | | GotFocus | (None) | (None) | Raised when the control has received focus. | | HeaderBackgroundPaint | g as Graphics column as Integer | Boolean | A column header is being redrawn. Return True to override default drawing. | | HeaderContentPaint | g as Graphics column as Integer | Boolean | A column header's text is being redrawn. Return True to override default drawing. | | HeaderMenuAction | column as Integer parentMenu as DesktopMenuItem selectedItem as DesktopMenuItem | (None) | Raised when the user clicks a column header's menu item. | | HeaderMouseEnter | column as Integer | (None) | Raised when the user's cursor enters a header's area. | | HeaderMouseExit | column as Integer | (None) | Raised when the user's cursor enter's a header's area. | | HeaderPressed | Column as Integer IsContextualClick as Boolean | Boolean | Raised when the user clicks a column header. | | KeyDown | Key as String | Boolean | Raised when the control has focus and a keyboard key is pressed. Return True to cancel default behavior and raise KeyUp on release. | | KeyUp | Key As String | (None) | Raised when the user releases a pressed key while the control has focus. | | LostFocus | (None) | (None) | Raised when the control has lost focus. | | MouseDown | x as Integer y as Integer | Boolean | Raise when the user clicks the control. Return True to cancel default operation and raise MouseUp. | | MouseDrag | x as Integer y as Integer | (None) | Raised when a drag operation is occurring. | | MouseEnter | (None) | (None) | Raised when the mouse enters the control's area. | | MouseExit | (None) | (None) | Raised when the mouse exits the control's area. | | MouseMove | X as Integer Y as Integer | (None) | Raised when the mouse is moved within the control's area. | | MouseUp | x As Integer y As Integer | (None) | Raised when the pressed mouse button is released. | | MouseWheel | X as Integer Y as Integer DeltaX as Integer DeltaY as Integer | Boolean | Raised when the user has used the mouse wheel. Return True to cancel scrolling. | | Opening | (None) | (None) | (None) | | SortColumn | Column as Integer | Boolean | Raised when the user has clicked a column header in an attempt to sort the row values. Return True to cancel sort operation. | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | AcceptFileDrop | FileType as String | (None) | (None) | | AcceptPictureDrop | (None) | (None) | (None) | | AcceptRawDataDrop | Type as String | (None) | (None) | | AcceptTextDrop | (None) | (None) | (None) | | AddFolder | text as String | (None) | (None) | | AddRow | Item() as String | (None) | (None) | | AddRow | ParamArray Item as String | (None) | (None) | | Cell | RowNumber as Integer ColumnNumber as Integer | String | (None) | | Cell | RowNumber as Integer ColumnNumber as Integer assigns newValue as String | (None) | (None) | | CellAlignment | Row as Integer Column as Integer | DesktopListBox.Alignments | (None) | | CellAlignment | Row as Integer Column as Integer assigns newValue as DesktopListBox.Alignments | (None) | (None) | | CellAlignmentOffset | Row as Integer Column as Integer | Integer | (None) | | CellAlignmentOffset | Row as Integer Column as Integer assigns newValue as Integer | (None) | (None) | | CellBackgroundColor | RowNumber as Integer ColumnNumber as Integer | Color | (None) | | CellBackgroundColor | RowNumber as Integer ColumnNumber as Integer assigns Value as Color | (None) | (None) | | CellBold | row as Integer column as Integer | Boolean | (None) | | CellBold | row as Integer column as Integer assigns newValue as Boolean | (None) | (None) | | CellBorderBottom | RowNumber as Integer ColumnNumber as Integer | Borders | (None) | | CellBorderBottom | RowNumber as Integer ColumnNumber as Integer Assigns Value as Borders | (None) | (None) | | CellBorderColor | RowNumber as Integer ColumnNumber as Integer | Color | (None) | | CellBorderColor | RowNumber as Integer ColumnNumber as Integer Assigns Value as Color | (None) | (None) | | CellBorderLeft | RowNumber as Integer ColumnNumber as Integer | Borders | (None) | | CellBorderLeft | RowNumber as Integer ColumnNumber as Integer Assigns Value as Borders | (None) | (None) | | CellBorderRight | RowNumber as Integer ColumnNumber as Integer | Borders | (None) | | CellBorderRight | RowNumber as Integer ColumnNumber as Integer Assigns Value as Borders | (None) | (None) | | CellBorderTop | RowNumber as Integer ColumnNumber as Integer | Borders | (None) | | CellBorderTop | RowNumber as Integer ColumnNumber as Integer Assigns Value as Borders | (None) | (None) | | CellBounds | Row as Integer Column as Integer | Xojo.Rect | (None) | | CellCheck | Row as Integer Column as Integer | Boolean | (None) | | CellCheck | Row as Integer Column as Integer assigns newValue as Boolean | (None) | (None) | | CellClearBackgroundColor | RowNumber as Integer ColumnNumber as Integer | (None) | (None) | | CellClearTextColor | RowNumber as Integer ColumnNumber as Integer | (None) | (None) | | CellHasBackgroundColor | RowNumber as Integer ColumnNumber as Integer | Boolean | (None) | | CellHasTextColor | RowNumber as Integer ColumnNumber as Integer | Boolean | (None) | | CellHelpTag | RowNumber as Integer ColumnNumber as Integer | String | (None) | | CellHelpTag | RowNumber as Integer ColumnNumber as Integer assigns newValue as String | (None) | (None) | | CellItalic | row as Integer column as Integer | Boolean | (None) | | CellItalic | row as Integer column as Integer assigns newValue as Boolean | (None) | (None) | | CellState | row as Integer column as Integer | DesktopCheckbox.VisualStates | (None) | | CellState | row as Integer column as Integer assigns newValue as DesktopCheckBox.VisualStates | (None) | (None) | | CellTag | Row as Integer Column as Integer | Variant | (None) | | CellTag | Row as Integer Column as Integer assigns newValue as Variant | (None) | (None) | | CellTextColor | RowNumber as Integer ColumnNumber as Integer | Color | (None) | | CellTextColor | RowNumber as Integer ColumnNumber as Integer assigns Value as Color | (None) | (None) | | CellType | Row as Integer Column as Integer | DesktopListBox.CellTypes | (None) | | CellType | Row as Integer Column as Integer assigns newValue as DesktopListBox.CellTypes | (None) | (None) | | CellUnderline | row as Integer column as Integer | Boolean | (None) | | CellUnderline | row as Integer column as Integer assigns newValue as Boolean | (None) | (None) | | Column | ColumnNumber as Integer | DesktopListBoxColumn | (None) | | Column | ColumnNumber as Integer assigns newListColumn as DesktopListBoxColumn | (None) | (None) | | ColumnAlignment | ColumnNumber as Integer | DesktopListBox.Alignments | (None) | | ColumnAlignment | ColumnNumber as Integer assigns newValue as DesktopListBox.Alignments | (None) | (None) | | ColumnAlignmentOffset | ColumnNumber as Integer | Integer | (None) | | ColumnAlignmentOffset | ColumnNumber as Integer assigns newValue as Integer | (None) | (None) | | ColumnCount | (None) | Integer | (None) | | ColumnCount | assigns newValue as Integer | (None) | (None) | | ColumnFromXY | X as Integer Y as Integer | Integer | (None) | | ColumnIsHovered | index as Integer | Boolean | (None) | | ColumnSortable | index as Integer | Boolean | (None) | | ColumnSortable | index as Integer assigns newValue as Boolean | (None) | (None) | | ColumnSortDirection | columnNumber as Integer | DesktopListBox.SortDirections | (None) | | ColumnSortDirection | columnNumber as Integer assigns newValue as DesktopListBox.SortDirections | (None) | (None) | | ColumnTag | Column as Integer | Variant | (None) | | ColumnTag | Column as Integer assigns newValue as Variant | (None) | (None) | | ColumnType | columnNumber as Integer | DesktopListBox.CellTypes | (None) | | ColumnType | columnNumber as Integer assigns newValue as DesktopListBox.CellTypes | (None) | (None) | | DeleteAllRows | (None) | (None) | (None) | | EditCell | row as Integer column as Integer | (None) | (None) | | Expanded | row as Integer | Boolean | (None) | | Expanded | row as Integer assigns newValue as Boolean | (None) | (None) | | HeaderAlignmentAt | index as Integer | DesktopListBox.Alignments | (None) | | HeaderAlignmentAt | index as Integer assigns value as DesktopListBox.Alignments | (None) | (None) | | HeaderBackgroundColorAt | index as Integer | Color | (None) | | HeaderBackgroundColorAt | index as Integer assigns value as Color | (None) | (None) | | HeaderBackgroundColorClearAt | index as Integer | (None) | (None) | | HeaderBackgroundColorHoverAt | index as Integer | Color | (None) | | HeaderBackgroundColorHoverAt | index as Integer assigns value as Color | (None) | (None) | | HeaderBackgroundColorHoverClearAt | index as Integer | (None) | (None) | | HeaderBackgroundColorHoverSetAt | index as Integer | Boolean | (None) | | HeaderBackgroundColorSetAt | index as Integer | Boolean | (None) | | HeaderBoldAt | index as Integer | Boolean | (None) | | HeaderBoldAt | index as Integer assigns value as Boolean | (None) | (None) | | HeaderBoldSetAt | index as Integer | Boolean | (None) | | HeaderItalicAt | index as Integer | Boolean | (None) | | HeaderItalicAt | index as Integer assigns value as Boolean | (None) | (None) | | HeaderItalicSetAt | index as Integer | Boolean | (None) | | HeaderMenu | index as Integer | DesktopMenuItem | (None) | | HeaderMenu | index as Integer assigns menuVal as DesktopMenuItem | (None) | (None) | | HeaderTextColorAt | index as Integer | Color | (None) | | HeaderTextColorAt | index as Integer assigns value as Color | (None) | (None) | | HeaderTextColorClearAt | index as Integer | (None) | (None) | | HeaderTextColorHoverAt | index as Integer | Color | (None) | | HeaderTextColorHoverAt | index as Integer assigns value as Color | (None) | (None) | | HeaderTextColorHoverClearAt | index as Integer | (None) | (None) | | HeaderTextColorHoverSetAt | index as Integer | Boolean | (None) | | HeaderTextColorSetAt | index as Integer | Boolean | (None) | | HeaderType | Column as Integer | DesktopListbox.SortTypes | (None) | | HeaderType | Column as Integer assigns newValue as DesktopListBox.SortTypes | (None) | (None) | | HeaderUnderlineAt | index as Integer | Boolean | (None) | | HeaderUnderlineAt | index as Integer assigns value as Boolean | (None) | (None) | | HeaderUnderlineSetAt | index as Integer | Boolean | (None) | | Heading | index as Integer | String | (None) | | Heading | index as Integer assigns newValue as String | (None) | (None) | | InsertFolder | RowNumber as Integer Item as String Indent as Integer = 0 | (None) | (None) | | InsertRow | RowNumber as Integer Item as String Indent as Integer = 0 | (None) | (None) | | InvalidateCell | row as Integer column as Integer | (None) | (None) | | List | Index as Integer | String | (None) | | List | Index as Integer assigns newValue as String | (None) | (None) | | LockUpdate | Assigns newValue as Boolean | (None) | (None) | | PressHeader | v as Integer | (None) | (None) | | RemoveRow | RowNumber as Integer | (None) | (None) | | RowDepth | row as Integer | Integer | (None) | | RowFromXY | X as Integer Y as Integer | Integer | (None) | | RowIsFolder | row as Integer | Boolean | (None) | | RowPicture | RowNumber as Integer | Picture | (None) | | RowPicture | RowNumber as Integer assigns newValue as Picture | (None) | (None) | | RowTag | row as Integer | Variant | (None) | | RowTag | row as Integer assigns newValue as Variant | (None) | (None) | | Selected | Row as Integer | Boolean | (None) | | Selected | Row as Integer Assigns newValue as Boolean | (None) | (None) | | SetFocus | (None) | (None) | (None) | | Sort | (None) | (None) | (None) | | Text | (None) | String | (None) | | Text | assigns value as String | (None) | (None) | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | ActiveCell | DesktopTextControl | (None) | (None) | | AlternateRowColors | Boolean | (None) | (None) | | AutoHideScrollBars | Boolean | (None) | (None) | | Bold | Boolean | (None) | (None) | | BoldHeader | Boolean | (None) | (None) | | Border | Boolean | (None) | (None) | | ColumnCount | Integer | (None) | (None) | | ColumnsResizable | Boolean | (None) | (None) | | ColumnWidths | String | (None) | (None) | | DefaultRowHeight | Integer | (None) | (None) | | EnableDrag | Boolean | (None) | (None) | | EnableDragReorder | Boolean | (None) | (None) | | GridLines | DesktopListBox.GridLineStyles | (None) | (None) | | HasHeading | Boolean | (None) | (None) | | HeaderChange | Boolean | (None) | (None) | | HeaderHeight | Integer | (None) | (None) | | HeadingIndex | Integer | (None) | (None) | | Hierarchical | Boolean | (None) | (None) | | HoverEffect | HoverEffects | (None) | (None) | | InitialValue | String | (None) | (None) | | IsHorizontalScrollVisible | Boolean | (None) | (None) | | IsVerticalScrollVisible | Boolean | (None) | (None) | | Italic | Boolean | (None) | (None) | | ItalicHeader | Boolean | (None) | (None) | | LastAddedIndex | Integer | (None) | (None) | | LastIndex | Integer | (None) | (None) | | ListCount | Integer | (None) | (None) | | ListIndex | Integer | (None) | (None) | | ListIndexHover | Integer | (None) | (None) | | RequiresSelection | Boolean | (None) | (None) | | RowHeight | Integer | (None) | (None) | | ScrollbarHorizontal | Boolean | (None) | (None) | | ScrollbarVertical | Boolean | (None) | (None) | | ScrollPosition | Integer | (None) | (None) | | ScrollPositionX | Integer | (None) | (None) | | SelCount | Integer | (None) | (None) | | SelectionType | DesktopListBox.RowSelectionTypes | (None) | (None) | | ShowDropIndicator | Boolean | (None) | (None) | | SortedColumn | Integer | (None) | (None) | | TabStop | Boolean | (None) | (None) | | TextFont | String | (None) | (None) | | TextFontHeader | String | (None) | (None) | | TextSize | Integer | (None) | (None) | | TextSizeHeader | Integer | (None) | (None) | | TextUnit | FontUnits | (None) | (None) | | TextUnitHeader | REALbasic.FontUnits | (None) | (None) | | Underline | Boolean | (None) | (None) | | UnderlineHeader | Boolean | (None) | (None) |