Sign in Join
FPDoc Onlineexperiment

TCustomSplitter.CheckOffset function

Member of TCustomSplitterprotectedIn unit ExtCtrls

Signals the OnCanOffset event handler to determine the offset used when aligning the control, and the success or failure of the calculation.

Declaration

pascal
function CheckOffset(var NewOffset: Integer): Boolean; virtual

Arguments

NewOffset

Offset value to check and optionally update in the method.

Function result

True if the offset was successfully determined for the splitter control.

Description

The return value is True by default, but it can be modified in the OnCanOffset event handler.

Used in the implementation of the MoveSplitter method.

See also

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