Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 4
Form Class
Form Events
 HelpButtonClicked Event
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:
.NET Framework Class Library
Form..::.HelpButtonClicked Event

Occurs when the Help button is clicked.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
Visual Basic
<BrowsableAttribute(True)> _
Public Event HelpButtonClicked As CancelEventHandler
C#
[BrowsableAttribute(true)]
public event CancelEventHandler HelpButtonClicked
Visual C++
[BrowsableAttribute(true)]
public:
 event CancelEventHandler^ HelpButtonClicked {
    void add (CancelEventHandler^ value);
    void remove (CancelEventHandler^ value);
}
F#
[<BrowsableAttribute(true)>]
member HelpButtonClicked : IEvent<CancelEventHandler,
    CancelEventArgs>

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 Consuming 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.

Visual Basic
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
C#
private void Form1_HelpButtonClicked(Object sender, CancelEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "HelpButtonClicked Event" );
}

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2012 Microsoft. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker