Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CommonDialog.HelpRequest Event

Occurs when the user clicks the Help button on a common dialog box.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public event EventHandler HelpRequest
/** @event */
public void add_HelpRequest (EventHandler value)

/** @event */
public void remove_HelpRequest (EventHandler value)

JScript supports the use of events, but not the declaration of new ones.

For information about handling events, see Consuming Events.

The following code example demonstrates initializing a ColorDialog object setting the AnyColor, AllowFullOpen properties. The ColorDialog object does not allow the user to set a custom color, but it allows the full set of basic colors to be displayed. By setting the SolidColorOnly property to false, it allows the display of colors that are combinations of other colors on systems with 256 or less colors. The example also shows setting the ShowHelp property and handling a HelpRequest event for a dialog box. To run the example, paste the following code in a form and call the InitializeColorDialog method in the form's constructor or Load method. This example requires that the Click event of the button is connected to the event handler defined in the example.

// This method initializes ColorDialog1 to allow any colors, 
// and combination colors on systems with 256 colors or less, 
// but will not allow the user to set custom colors.  The
// dialog will contain the help button.
private void InitializeColorDialog()
{
    this.ColorDialog1 = new System.Windows.Forms.ColorDialog();
    this.ColorDialog1.AllowFullOpen = false;
    this.ColorDialog1.AnyColor = true;
    this.ColorDialog1.SolidColorOnly = false;
    this.ColorDialog1.ShowHelp = true;
    
    // Associate the event-handling method with
    // the HelpRequest event.
    this.ColorDialog1.HelpRequest 
        += new System.EventHandler(ColorDialog1_HelpRequest);
}


// This method opens the dialog and checks the DialogResult value. 
// If the result is OK, the text box's background color will be changed 
// to the user-selected color.
private void Button1_Click(System.Object sender, System.EventArgs e)
{
    DialogResult result = ColorDialog1.ShowDialog();
    if (result.Equals(DialogResult.OK))
    {
        TextBox1.BackColor = ColorDialog1.Color;
    }
}

// This method is called when the HelpRequest event is raised, 
//which occurs when the user clicks the Help button on the ColorDialog object.
private void ColorDialog1_HelpRequest(object sender, System.EventArgs e)
{

    MessageBox.Show("Please select a color by clicking it. "
       + "This will change the BackColor property of the TextBox.");
}

// This method initializes colorDialog1 to allow any colors, 
// and combination colors on systems with 256 colors or less, 
// but will not allow the user to set custom colors.  The
// dialog will contain the help button.
private void InitializeColorDialog()
{
    this.colorDialog1 = new System.Windows.Forms.ColorDialog();
    this.colorDialog1.set_AllowFullOpen(false);
    this.colorDialog1.set_AnyColor(true);
    this.colorDialog1.set_SolidColorOnly(false);
    this.colorDialog1.set_ShowHelp(true);
    // Associate the event-handling method with
    // the HelpRequest event.
    this.colorDialog1.add_HelpRequest(new System.EventHandler(
        colorDialog1_HelpRequest));
} //InitializeColorDialog

// This method opens the dialog and checks the DialogResult value. 
// If the result is OK, the text box's background color will be changed 
// to the user-selected color.
private void button1_Click(System.Object sender, System.EventArgs e)
{
    DialogResult result = colorDialog1.ShowDialog();
    if (result.Equals(DialogResult.OK)) {
        textBox1.set_BackColor(colorDialog1.get_Color());
    }
} //button1_Click

// This method is called when the HelpRequest event is raised, 
//which occurs when the user clicks the Help button on the ColorDialog object.
private void colorDialog1_HelpRequest(Object sender, System.EventArgs e)
{
    MessageBox.Show("Please select a color by clicking it. " 
        + "This will change the BackColor property of the TextBox.");
} //colorDialog1_HelpRequest

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.