VpeGetClickedObject

<< Click to Display Table of Contents >>

Navigation:  Clickable Objects >

VpeGetClickedObject

Previous pageReturn to chapter overviewNext page

[Windows platform only, Enterprise Edition and above]

Returns the VPE Object handle - instead of the ObjectID, which is only an integer - of the object that fired the VPE_OBJECTCLICKED event.

VpeHandle VpeGetClickedObject(

VpeHandle hDoc

)

VpeHandle hDoc

Document Handle

Returns:

the VPE Object handle of the clicked object

Remarks:

This property is only accessible while your application is processing the event VPE_OBJECTCLICKED.
 

If you call this function while not processing the event VPE_OBJECTCLICKED, it will return NULL.