TControlScrollBar.ClientSizeWithBar function

Declaration

function ClientSizeWithBar: Integer

Function result

Size for the client area after adjusting for a visible scroll bar.

Description

ClientSizeWithBar is an Integer function used to calculate the client area for the associated control when the scroll bar is Visible. The return value contains the calculated value from ClientSize. If the scroll bar is not Visible, additional spacing (for the SM_SWSCROLLBARSPACING system metric) between the scroll bar and its associated control is removed from the return value.

ClientSizeWithBar is used in the implementation of the ComputeScrollbars method in TScrollingWinControl when the Range for the scroll bar would exceed the space available on the control, and in the GetPreferredSizeClientFrame method.

See also

• ClientSize
• Visible
• Range
• ComputeScrollbars
• GetPreferredSizeClientFrame