Description
For the entity under the control-relative x and y pixel coordinates, this returns a bitmask describing the entity. This bitmask is zero if the coordinates are off-page, otherwise it is the OR of all that apply from:
OTM_EMPTY &H00000001
OTM_HYPERLINK &H00000002
OTM_TEXT &H00000004
OTM_IMAGE &H00000008
OTM_IMAGEMAP &H00000010
OTM_IMAGEINPUT &H00000020
OTM_FORMCONTROL &H00000040
OTM_TABLE &H00000080
OTM_USEMAP &H00000100
OTM_FRAME &H00000200
OTM_FRAMEBORDER &H00000400
Arguments
|
Name |
Type |
I/O |
Description |
|
X |
Long Integer |
In |
The control-relative X coordinate of the point of interest. |
|
Y |
Long Integer |
In |
The control-relative Y coordinate of the point of interest. |
|
PobjectURL |
String |
Out |
If an embedded object is present at the specified coordinates, this returns it’s URL. |
|
PhyperlinkURL |
String |
Out |
If the coordinates specify a hyperlink, this returns the destination URL. |
|
plReserved1 |
Long Integer (by Reference) |
Out |
Returns the offset in pure text of the character under the cursor or, if the cursor is not over text, then returns the offset of the most recent preceding pre text character. |
Return Value
A bitmask describing the object at the specified coordinates.
Remarks
Zero is returned when the specified coordinates are outside the bounds of the control.
plReserved1 should be set to reference a long integer (32-bit) variable, which will receive the offset in pure text of the character at the X,Y coordinates when the return bitmask includes the OTM_TEXT flag. When this flag is not set (indicating that there is no text at the specified X,Y coordinates) then the returned offset is to the most recent character preceding the coordinates. Pure text can be retrieved with GetText.