Form.HelpButtonClicked Event

 

Occurs when the Help button is clicked.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

<BrowsableAttribute(True)>
Public Event HelpButtonClicked As CancelEventHandler

The HelpButtonClicked event occurs when the Help button in the form's caption bar is clicked. The Help button is displayed when the HelpButton property is set to true. HelpButtonClicked can be canceled.

For more information about handling events, see Handling and Raising Events.

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the HelpButtonClicked event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox.Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type Form named Form1. Then ensure that the event handler is associated with the HelpButtonClicked event.

Private Sub Form1_HelpButtonClicked(sender as Object, e as CancelEventArgs) _ 
     Handles Form1.HelpButtonClicked

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"HelpButtonClicked Event")

End Sub

.NET Framework
Available since 2.0
Return to top
Show: