Sign in Join
FPDoc Onlineexperiment

TCustomTabControl.IndexOfPageAt function

Member of TCustomTabControlprotectedIn unit ComCtrls

Gets the ordinal position for the page object located at the specified client coordinates.

Declaration

pascal
function IndexOfPageAt(X: Integer; Y: Integer): Integer; virtual
 ; overload
function IndexOfPageAt(P: TPoint): Integer; virtual; overload

Arguments

X

Horizontal client coordinate for the page position located in the method.

Y

Vertical client coordinate for the page position located in the method.

P

TPoint instance with the client coordinates for the requested page index.

Function result

Ordinal position for the page object located the specified client coordinates.

Description

IndexOfPageAt is an overloaded method in TCustomTabControl used to get the ordinal position for the page object located at the specified client coordinates. The overloaded variants allow the client coordinates to be specified as separate Integer values, or as a TPoint instance where the X and Y members contain the client-relative coordinates.

Example Usage: 

APos := TabControl1.IndexOfPageAt(TabControl1.ScreenToClient(Mouse.CursorPos));

See also

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