TTMSFNCKanbanBoardColumn Class
Represents a single column in a kanban board, containing a header, footer, item list, and column-level interaction controls such as filtering and sorting.
API unit family: TMSFNCKanbanBoard
Inherits from: TCollectionItem
Syntax
TTMSFNCKanbanBoardColumn = class(TCollectionItem)
Properties
| Name | Description |
|---|---|
| BitmapContainer | Returns the bitmap container shared with the owning kanban board. |
| CollapsedWidth | The display width of the column in pixels when collapsed; requires Expandable to be True. |
| DBKey | The database key used to match this column to an external data record. |
| DataBoolean | A Boolean value for associating arbitrary data with the column. |
| DataInteger | An integer value for associating arbitrary data with the column. |
| DataObject | An object reference for associating arbitrary data with the column. |
| DataPointer | An untyped pointer for associating arbitrary data with the column. |
| DataString | A string value for associating arbitrary data with the column. |
| DoneButton | Returns the Done button in the column's toolbar. |
| Expandable | When True, the user can collapse and expand the column. |
| Expanded | When True, the column is shown in its expanded state; when False, it is collapsed to CollapsedWidth. |
| Fill | The background fill of the column body area. |
| Filter | Configures the filter state and filter text for the column. |
| FilterButton | Returns the Filter button in the column's toolbar. |
| FooterFill | The background fill of the column footer bar. |
| FooterFont | The font used for the column footer text. |
| FooterHorizontalTextAlign | The horizontal alignment of the footer text. |
| FooterStroke | The border stroke of the column footer bar. |
| FooterText | The text displayed in the column footer bar. |
| FooterTrimming | The trimming style applied when the footer text overflows. |
| FooterVerticalTextAlign | The vertical alignment of the footer text. |
| FooterVisible | When True, the column footer bar is visible. |
| FooterWordWrapping | When True, the footer text wraps to multiple lines. |
| HeaderFill | The background fill of the column header bar. |
| HeaderFont | The font used for the column header text. |
| HeaderHorizontalTextAlign | The horizontal alignment of the header text. |
| HeaderStroke | The border stroke of the column header bar. |
| HeaderText | The text displayed in the column header bar. |
| HeaderTrimming | The trimming style applied when the header text overflows. |
| HeaderVerticalTextAlign | The vertical alignment of the header text. |
| HeaderVisible | When True, the column header bar is visible. |
| HeaderWordWrapping | When True, the header text wraps to multiple lines. |
| ItemIndex | Gets or sets the zero-based index of the selected item. |
| Items | The collection of item cards displayed in this column. |
| KanbanBoard | Returns the kanban board that owns this column. |
| Name | The programmatic name used to identify this column. |
| PrecalculateItems | When True, item sizes are calculated in advance to improve scrolling performance for variable-height items. |
| SelectedItem | Gets or sets the selected item in the column. |
| SelectedItems | Provides indexed access to all currently selected items in the column. |
| ShowFilterButton | When True, a filter button is shown in the column toolbar. |
| Sorting | Specifies whether and how items are automatically sorted in this column. |
| Stroke | The border stroke of the column body area. |
| TableView | Returns the internal table view that renders the column's items. |
| Tag | An integer tag for storing custom data or identifying the column. |
| UseDefaultAppearance | When True, the column uses the shared appearance from ColumnsAppearance; when False, individual fill, stroke, and font properties apply. |
| Visible | When True, the column is visible in the board; when False, it is hidden. |
| Width | The display width of the column in pixels when expanded. |
Methods
| Name | Description |
|---|---|
| AddItem | Appends a new item with the given text to the column and returns it. |
| ApplyFilter | Applies the current filter criteria to the column's item list. |
| ClearSelection | Deselects all items in the column. |
| CopyItem | Copies an item from this column to another column and returns the new copy. |
| DisableInteraction | Temporarily disables user interaction with the column. |
| EnableInteraction | Re-enables user interaction with the column after a call to DisableInteraction. |
| FindItem | Returns the item at the specified zero-based index in the column. |
| FindItemByNode | Returns the kanban board item associated with the specified tree view virtual node. |
| GetKanbanBoard | Returns the kanban board that owns this column. |
| GetSelectedItems | Returns an array of all currently selected items in the column. |
| GetTableView | Returns the internal table view that renders the column's items. |
| LookupItem | Finds and optionally selects the first item whose text matches the lookup string. |
| MoveItem | Moves an item from this column to another column and returns the relocated item. |
| RemoveFilter | Removes the most recently applied filter from the column's item list. |
| RemoveFilters | Removes all active filters from the column's item list. |
| RemoveItem | Removes the specified item from the column. |
| ScrollToItem | Scrolls the column's item list so that the item at the specified index is visible. |
| SelectItem | Selects the item at the specified zero-based index. |
| SelectItems | Selects the items at the specified zero-based indexes. |
| SelectedItemCount | Returns the number of currently selected items in the column. |
| StartEditMode | Puts the column's item list into edit mode. |
| StartFiltering | Shows the column's filter control and enters filtering mode. |
| StopEditMode | Exits edit mode in the column's item list. |
| StopFiltering | Hides the column's filter control and exits filtering mode. |
| ToggleEditMode | Toggles edit mode on or off for the column's item list. |
| UpdateWidth | Sets the column width and triggers a layout update. |
| XYToItem | Returns the item at the specified local coordinates within the column. |
| XYToItemIndex | Returns the zero-based index of the item at the specified local coordinates. |