Function GetToMousePos() Foundation

Moves the screen cursor to the location in the active Get object editing buffer at which the left mouse button was clicked.

GetToMousePos( <oGet>, <nMouseRow>, <nMouseCol> ) --> nBufferPos
<oGet> is the Get object which has input focus.
<nMouseRow> is the row on the screen in which the mouse pointer is found.
<nMouseCol> is the column on the screen in which the mouse pointer is located.

The return value of GetToMousePos() is a numeric value which gives the position of the screen cursor within the edit buffer. When the mouse coordinates do not lie in the edit buffer, 0 is returned.


The function GetToMousePos() is a service function in the Get system which moves the screen cursor to the position of the mouse pointer. The screen cursor is moved by GetToMousePos() only when the user has clicked the left mouse button in the input field of a Get object. The function is normally called only within the Get system. It should be noted that the return value of GetToMousePos() can be greater than the width of the visible input field on the screen, such as when the "@S" PICTURE formatting clause has been used and input has scrolled to the left.

In order for the function to return a meaningful value, SetMouse(.T.) must be called before the first call to READ or ReadModal().


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.