TDataSetScrolledEvent procedure type

In unit DBGrids

Specifies an event handler signalled after scrolling a dataset.

Declaration

pascal

TDataSetScrolledEvent = procedure(DataSet: TDataSet; Distance: Integer)
 of object

Arguments

`DataSet`	Dataset for the event.
`Distance`	Number of rows and direction for the event.

Description

TDatasetScrolledEvent specifies an event handler signalled after scrolling a dataset. TDatasetScrolledEvent can be used to perform actions required when the position in the DataSet has changed.

DataSet is the TDataset instance for the event notification.

Distance indicates both the number of rows and the direction for the event notification, for example:

Value: Meaning
<0: Scroll toward the beginning of the DataSet
0: Current row in the DataSet has been refreshed
>0: Scroll toward the end of the DataSet

TDatasetScrolledEvent is the type used for the OnDataSetScrolled property in TComponentDataLink.

See the TCustomDBGrid.OnDataSetScrolled procedure for an example implementation of TDatasetScrolledEvent.

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