Skip to main content
Table of Contents

TTMSFNCDataGridMouseOptions Class

Options governing mouse interaction: selection, sizing, dragging, auto-scrolling, wheel scrolling, touch, and direct-edit behaviour.

API unit family: TMSFNCDataGridRenderer Inherits from: TPersistent

Syntax

GeneratedPascalC++
TTMSFNCDataGridMouseOptions = class(TPersistent)
class PASCALIMPLEMENTATION TTMSFNCDataGridMouseOptions : public System::Classes::TPersistent

Remarks

Reached through the grid's Options.Mouse. Changes take effect on the next mouse interaction and do not repaint the grid.

Properties

Name Description
AutoDragging When True, the grid scrolls automatically while a row or column is dragged beyond the edge of the visible area. Default is True.
AutoScrolling When True, moving the mouse beyond the grid edge while selecting automatically scrolls the grid. Default is True.
AutoScrollingInterval Timer interval in milliseconds between auto-scroll steps. Default is 100 ms.
AutoScrollingSpeed How many units (pixels or cells, see AutoScrollingSpeedMode) to scroll per auto-scroll timer tick. Default is 1.
AutoScrollingSpeedMode Whether AutoScrollingSpeed is applied in pixels (gasmPixels, default) or whole cells (gasmCell).
ClickMargin Distance in pixels the pointer must move after a mouse-down before the gesture is treated as a drag (range selection, dragging or touch scrolling) instead of a click. Default is 2.
ColumnAutoSizeOnDblClick When True, double-clicking a column border auto-sizes that column to fit its content. Default is True.
ColumnDragModes Which column-drag operations are active while ColumnDragging is True. Default is [gcdmReorder, gcdmVisualGrouping].
ColumnDragging Enables dragging columns to reorder them or move them into the grouping area. Default is False.
ColumnSizeMargin Width in pixels of the hit zone around a column border that starts column sizing. Default is 6.
ColumnSizing Enables resizing columns by dragging a vertical cell border in the normal (non-fixed) cell area. Default is False.
ColumnSizingMode Controls whether column sizing resizes only the dragged column (gszmOneSided, default) or redistributes space between the two adjacent columns (gszmTwoSided).
DirectEdit When True, clicking a cell immediately enters edit mode. Default is False.
DragMode Controls whether row/column dragging reorders within the grid (gdmReorder, default) or starts a framework drag-and-drop operation (gdmDrag).
FixedCellSelection Set of click gestures on fixed header/footer cells that select entire rows or columns. Default is empty (fixed cells do not trigger structural selection).
FixedColumnSizing Enables resizing columns by dragging a vertical border of a fixed (header) cell. Default is False.
FixedRowSizing Enables resizing rows by dragging a horizontal border of a fixed (header) cell. Default is False.
RowAutoSizeOnDblClick When True, double-clicking a row border auto-sizes that row to fit its content. Default is True.
RowDragging Enables dragging rows to reorder them. Default is False.
RowSizeMargin Height in pixels of the hit zone around a row border that starts row sizing. Default is 6.
RowSizing Enables resizing rows by dragging a horizontal cell border in the normal (non-fixed) cell area. Default is False.
RowSizingMode Controls whether row sizing resizes only the dragged row (gszmOneSided, default) or redistributes height between the two adjacent rows (gszmTwoSided).
TouchScrolling Enables scrolling the grid by dragging its content with a finger or the mouse (touch scrolling). Default is False.
TouchScrollingSensitivity Multiplier applied to the drag distance during touch scrolling. Default is 1; higher values scroll further per dragged pixel.
WheelScrollKeepSelection When True (default), the mouse wheel scrolls the grid and keeps the current selection. When False, the wheel moves the focused cell up or down instead.
WheelScrollSize Number of rows to scroll (or to move the focused cell) per mouse wheel notch. Default is 4.