TTabSet.MinClientRect Method ()

Returns the boundaries that are required to display the tabs in the tab set.

Pascal

function MinClientRect: TRect; overload;
function MinClientRect(IncludeScroller: Boolean): TRect; overload;
function MinClientRect(TabCount: Integer; IncludeScroller: Boolean = False): TRect; overload;

C++

__fastcall TRect MinClientRect();
__fastcall TRect MinClientRect(Boolean IncludeScroller);
__fastcall TRect MinClientRect(int TabCount, Boolean IncludeScroller = False);

Description

Use MinClientRect to obtain the minimum size that the tab set's client area must be to display its tabs and (if specified) a scroller for scrolling hidden tabs. MinClientRect calculates the width based on the widths of all the tabs up to a specified count, adding in the values of StartMargin and EndMargin and the space that appears between tabs. If requested, it also adds the width of a scroller for the tabs. It calculates the height based on the value of the TabHeight property.

TabCount specifies the number of tabs to display. MinClientRect uses the widths of these tabs to calculate the width of the client rectangle. If you use a syntax that does not include a TabCount parameter, MinClientRect assumes that all tabs must be visible.

IncludeScroller indicates whether the client rectangle must include space for the scroller control that allows users to scroll the tabs, displaying any tabs that are not included in TabCount. If IncludeScroller is false, or if this parameter is omitted, MinClientRect does not include the width for the scroller in the resulting rectange.

MinClientRect returns the dimensions, in pixels, needed to display the specified number of tabs and, if specified, the scroller. The returned rectangle has an origin of 0,0.