Sign in Join
FPDoc Onlineexperiment

TCustomGrid.ScrollBy procedure

Member of TCustomGridprotectedIn unit Grids

Scrolls the non-fixed area for the control by the specified delta values.

Declaration

pascal
procedure ScrollBy(DeltaX: Integer; DeltaY: Integer); override

Arguments

DeltaX

Scroll amount in the horizontal direction. A negative value scrolls to the left, and a positive value scrolls to the right.

DeltaY

Scroll amount in the vertical direction. A negative value scrolls toward the top, and a positive value scrolls toward the bottom.

Description

ScrollBy us an overridden method in TCustomGrid. No actions are performed in the method when both DeltaX and DeltaY contain 0 (zero).

ScrollBy calls ScrollWindowEx to perform the scrolling operation for the non-fixed client area on the control. It updates the visible grid area in the cached information for the control, and recalculates the scroll bar ranges.

ScrollBy is called from the TrySmoothScrollBy method, and occurs when scroll bar messages or mouse wheel events are handled for the grid control.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.