SftOptions.HelpRequested Event
The user requested context-sensitive help.
Syntax
| VB.NET | Private Sub object_HelpRequestedEvent(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.HelpRequestedEvent |
| VB | Private Sub object_HelpRequested(Entry As SftOptionsEntry, ByVal xPos As OLE_XPOS_PIXELS, ByVal yPos As OLE_XPOS_PIXELS) |
| C#.NET | void object_HelpRequestedEvent(object sender, EventArgumentType e); |
| VC++ | void OnHelpRequestedobject(ISftOptionsEntry* Entry, OLE_XPOS_PIXELS xPos, OLE_XPOS_PIXELS yPos); |
| C | HRESULT OnHelpRequestedobject(ISftOptionsEntry* Entry, OLE_XPOS_PIXELS xPos, OLE_XPOS_PIXELS yPos); |
object
A SftOptions object.
Entry
The name of the entry for which help is requested.
xPos
The x coordinate of the mouse cursor. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
yPos
The y coordinate of the mouse cursor. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Comments
The HelpRequested event occurs when the user requests context-sensitive help.
The HelpRequested event occurs when the user clicks on the question mark in the title bar (WhatsThisButton) and then on an entry in the SftOptions control or if the F1 key is pressed while the control has the input focus.
If context-sensitive help is requested using F1, both xPos and yPos are set to -1.
Visual C++ and MFC: When using C++/MFC, a special FixHelp finction must be called for proper functioning of the Windows WM_HELP message, which is otherwise suppressed by MFC, preventing the HelpRequested event from occurring. Please see the included sample code for more information.
Example
Private Sub SftOptions1_HelpRequested(ByVal Entry As SftOptionsLib10.ISftOptionsEntry, ByVal xPos As Single, ByVal yPos As Single)
' The Entry argument describes for which entry the user is requesting
' context sensitive help
SftOptions1.CancelMode ' required when handling this event
MsgBox ("This example does not offer actual context sensitive help, but it does demonstrate how an application can easily provide context sensitive help." & _
Chr(10) & Chr(10) & _
"You requested help for the entry named """ & Entry.Text & """.")
End Sub See Also SftOptions Object | Object Hierarchy
On
Off