CURSORPOS property (System) [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== CURSORPOS property (System) ======


 
==== Description ====
 
 
Retrieves the cursor position for the last Windows message retrieved by the PS in screen coordinates.
 
 
 
If the name of a window or control is passed in the index argument the returned coordinates will be scaled to DIPs based on the DPI and scale factor of the passed object.
 
 
 
 
==== Property Value ====
 
 
This is an @fm-delimited array containing the cursor coordinates, formatted as:
 
 
 
<1> X-Position
 
<2> Y-Position
 
 
 
 
==== Property Traits ====
 
 
 
^Development^Runtime^Indexed^Scaled^Synthetic^
|N/A|Get|Yes|See Description|No|

 


 
==== Remarks ====
 
 
This property is essentially a wrapper around the GetMessagePos Windows API function, so please refer to the documentation on the Microsoft website for further information.
 
 
 
 
==== Example ====
 
<code>
 
// Get the current screen position of the cursor in pixels

  

  CursorPos = Get_Property( "SYSTEM", "CURSORPOS" )

  

  // Get the screen position of the cursor in DIPs with respect  

  // to the current window

    

  CursorPos = Get_Property( "SYSTEM", "CURSORPOS", @Window )
 
 
 

</code>

 
==== See Also ====
 
 
ASYNCCURSORPOS property