TControl.ClientToParent function

Declaration

function ClientToParent(const Point: TPoint; AParent: TWinControl=Nil)
: TPoint

Arguments

Function result

TPoint instance with the client coordinates adjusted to the parent control.

Description

ClientToParent is a TPoint function used to convert the client-relative coordinates specified in Point to the screen coordinates for the parent control in AParent. If AParent is unassigned ( Nil), the Parent property for the control is used in the method.

ClientToParent calls the IsParentOf method in AParent to determine if the control is a child control for AParent. An EInvalidOperation exception is raised if the return value from IsParentOf is False.

ClientToParent calls ClientToScreen to get the absolute screen coordinates for the values in Point. The return value is the TPoint instance returned by converting the client coordinates to screen coordinates, and asking the parent control to convert the values back to client-relative coordinates for the parent control.

ClientToParent is used, for instance, in the TScrollingWinControl.ScrollInView method.