Sign in Join
FPDoc Onlineexperiment

TControlScrollBar.UpdateScrollBar procedure

Member of TControlScrollBarprotectedIn unit Forms

Updates the state and position for the scroll bar on the associated control.

Declaration

pascal
procedure UpdateScrollBar; virtual

Description

UpdateScrollBar is a procedure used to update the state and position for the scroll bar on the associated control.

If the associated control is a TScrollingWinControl instance, TScrollInfo is captured using the Range, Position, and Page properties. The scroll bar information is applied to the associated control by calling SetScrollInfo. The visibility for the scroll bar is updated by calling ShowScrollBar.

TScrollInfo values and visibility are not applied when a handle has not been allocated for the control, when the scroll information has not been changed, or when when the control is not a TScrollingWinControl class instance.

UpdateScrollBar applies the current value in Position to a visible scroll bar in the class instance. If the associated control is a TScrollingWinControl instance, the Smooth property is used to determine whether Increment needs to be adjusted to a value that is 10% of the Page size for the control. Increment is not modified if Smooth is set to False.

UpdateScrollBar is used in the implementation of the ControlUpdateScrollBars method.

Modified in LCL version 3.0 to omit updates to scroll bar information if the values have not been changed.

See also

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