OnRButtonDown

This event occurs when the user presses the right mouse button.

 

JavaScript
OnRButtonDown(       Flags,       X,       Y)

 

C#
bool OnRButtonDown(       int Flags,       int X,       int Y)

 

C++
HRESULT OnRButtonDown(       long Flags,       int X,       int Y,       VARIANT_BOOL* pbHandled)

Parameters

Flags

Indicates whether various virtual keys are down. This parameter can be any combination of the following values:

·         MK_ LBUTTON                  = 1

·         MK_ RBUTTON                 = 2

·         MK_ SHIFT                          = 4

·         MK_CONTROL                   = 8

·         MK_ MBUTTON                =16

X

The X-coordinate of the mouse. The coordinates are given in screen coordinates, with the origin in the top-left corner of the 3D Window.

Y

The Y-coordinate of the mouse. The coordinates are given in screen coordinates, with the origin in the top-left corner of the 3D Window.

Return Value

pbHandled

A Boolean that indicates whether or not the client handled the mouse action itself and does not wish TerraExplorer to respond to the mouse action. The value is FALSE when TerraExplorer handled the mouse action.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.