TTMSFNCDataGridHeaderVisualGrouping Class
The drag-and-drop grouping zone displayed in the grid header.
API unit family: TMSFNCDataGrid
Inherits from: TPersistent
Syntax
TTMSFNCDataGridHeaderVisualGrouping = class(TPersistent)
class PASCALIMPLEMENTATION TTMSFNCDataGridHeaderVisualGrouping : public System::Classes::TPersistent
Remarks
Obtained through Header.VisualGrouping. The zone is only shown when TTMSFNCDataGridHeaderFooter.Visible of the header is True (False by default) and Visible is True.
Dragging a column header into the zone groups the grid on that column; each grouped column is shown as a chip. Dragging requires Dragging plus Options.Mouse.ColumnDragging with gcdmVisualGrouping in Options.Mouse.ColumnDragModes. Chips can be nested over up to three levels.
Related API
TTMSFNCCustomDataGrid.OnBeforeDrawHeaderGroup
Properties
| Name | Description |
|---|---|
| AutoSize | When True (default), chip height is derived from the chip text height and the zone grows with the number of nesting levels. |
| CloseIndicator | When True (default), each chip displays a close button that removes that grouping level when clicked. |
| ConnectionLines | When True (default), connection lines are drawn between consecutive chips to visualise the grouping hierarchy. |
| ConnectionStroke | Stroke used to draw the connection lines between nested chips. |
| Dragging | When True (default), the user can drag column headers into the zone and drag chips within it. |
| Layout | Cell layout (fill, font, stroke, alignment) used to render each chip in the zone. |
| LevelActiveIndicationFill | Fill of the nesting-level drop strip currently under the pointer during a drag. |
| LevelActiveIndicationStroke | Stroke outlining the nesting-level drop strip currently under the pointer during a drag. |
| LevelIndicationFill | Fill of the nesting-level drop strips shown while a chip or column is dragged over the zone. Default is no fill. |
| LevelIndicationStroke | Stroke outlining the nesting-level drop strips shown during a drag. Default is a light-grey dashed line. |
| Size | Height in logical pixels of the visual grouping zone and its chips. Default is 30. |
| SortOnClick | When True (default), clicking a chip toggles the sort direction of the grouped column. |
| Visible | When True (default), the visual grouping zone is rendered inside the header. |