SftDirectory.ContextMenu Event
The right mouse button is released or Shift-F10 is pressed requesting a context menu.
Syntax
| VB.NET | Private Sub object_ContextMenuEvent(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.ContextMenuEvent |
| VB | Private Sub object_ContextMenu(ByVal Button As Integer, ByVal Shift As Integer, ByVal FolderIDL As String, ByVal xPos As OLE_XPOS_PIXELS, ByVal yPos As OLE_YPOS_PIXELS) |
| C#.NET | void object_ContextMenuEvent(object sender, EventArgumentType e); |
| VC++ | void OnContextMenuobject(short Button, short Shift, _bstr_t FolderIDL, OLE_XPOS_PIXELS xPos, OLE_YPOS_PIXELS yPos); |
| C | HRESULT OnContextMenuobject(short Button, short Shift, BSTR FolderIDL, OLE_XPOS_PIXELS xPos, OLE_YPOS_PIXELS yPos); |
object
A SftDirectory object.
Button
Describes the button(s) that are pressed. The Button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. The bits set indicate the button that caused the event.
| Button | Value | Description |
|---|
| constSftControlLeftButton | 1 | The left mouse button was pressed. |
| constSftControlRightButton | 2 | The middle mouse button was pressed. |
| constSftControlMiddleButton | 4 | The right mouse button was pressed. |
Shift
Describes the state of the SHIFT, CONTROL and ALT keys. A bit is set if the key is down. The Shift argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. It indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
|---|
| constSftControlShiftMask | 1 | The SHIFT key is down. |
| constSftControlCtrlMask | 2 | The CONTROL key is down. |
| constSftControlAltMask | 4 | The ALT key is down. |
FolderIDL
Describes the currently selected folder using an absolute ITEMIDLIST structure. If multiple folders are selected, FolderIDL is an empty string. If context help for the column headers is requested, FolderIDL contains "Header". If context help is requested while the cursor is above the empty area at the end of the folder list, FolderIDL contains the string "Empty Area".
xPos
The x coordinate in pixels where the mouse cursor is located. If xPos and yPos are -1, the user pressed Shift-F10.
yPos
The y coordinate in pixels where the mouse cursor is located. If xPos and yPos are -1, the user pressed Shift-F10.
Comments
The ContextMenu event occurs when the right mouse button is released or Shift-F10 is pressed requesting a context menu.
If the ShowContextMenu property is set to True, this event will only occur if a context menu for portions other than folders is requested.
An application can display a context menu in response to this event. Before displaying the popup menu, the CancelMode method must be called.
See Also SftDirectory Object | Object Hierarchy
On
Off