Sign in Join
FPDoc Onlineexperiment

TCustomControlBar.CalcBandHeightSnapped function

Member of TCustomControlBarprotectedIn unit ExtCtrls

Calculates the vertical space needed for a band on the control bar when RowSnap is enabled.

Declaration

pascal
function CalcBandHeightSnapped(AControl: TControl): Integer

Arguments

AControl

Control on the TCtrlBand instance with the total height used in the method.

Function result

Number of pixels needed for the specified band when RowSnap is enabled.

Description

CalcBandHeightSnapped is an Integer function used to calculate the height for the bands on the control bar when RowSnap is enabled.

The RowSize property contains the height for an individual band, and is used as a divisor to determine the number of visible bands given the overall height for the Control. Space is reserved for borders on each band using the cBandBorderV constant.

The return value contains the space required for the number of visible bands using the calculated row size.

CalcBandHeightSnapped is a called from the CalcBandHeight method when RowSnap is enabled for the control. It is also called from CheckBandsSizeAndVisibility for each of the visible bands on the control bar.

See also

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