NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

Form.HelpButton

Gets or sets a value indicating whether a help button should be displayed in the caption box of the form.

[Visual Basic]
Public Property HelpButton As Boolean
[C#]
public bool HelpButton {get; set;}
[C++]
public: __property bool get_HelpButton();
public: __property void set_HelpButton(bool);
[JScript]
public function get HelpButton() : Boolean;
public function set HelpButton(Boolean);

Property Value

true to display a help button in the form's caption bar; otherwise false. The default is false.

Remarks

When this property is set to true a small button with a question mark will appear in the caption bar to the left of the close button. You can use this button to display help for your application.

HelpButton will be ignored if maximize or minimize boxes are shown.

Example [C#]

The following example creates a new instance of a Form and calls the ShowDialog method to display the form as a dialog box. The example sets the BorderStyle, AcceptButton, CancelButton, MinimizeBox, MaximizeBox, and StartPosition properties to change the appearance and functionality of the form to a dialog box. The example also sets uses the System.WinForms.Form$Controls.Add method of the form's Controls collection to add two Button controls. The example uses the HelpButton property to display a help button in the caption bar of the dialog box.

[C#]

public void CreateMyForm()
{
   // Create a new instance of the form.
   Form form1 = new Form();
   // Create two buttons to use as the accept and cancel buttons.
   Button button1 = new Button ();
   Button button2 = new Button ();
  
   // Set the text of button1 to "OK".
   button1.Text = "OK";
   // Set the position of the button on the form.
   button1.Location = new Point (10, 10);
   // Set the text of button2 to "Cancel".
   button2.Text = "Cancel";
   // Set the position of the button based on the location of button1.
   button1.Location
      = new Point (button1.Left, button1.Height + button1.Top + 10);
   // Set the caption bar text of the form.   
   form1.Text = "My Dialog Box";
   // Display a help button on the form.
   form1.HelpButton = true;

   // Define the border style of the form to a dialog box.
   form1.BorderStyle = FormBorderStyle.FixedDialog
   // Set the MaximizeBox to false to remove the maximize box.
   form1.MaximizeBox = false;
   // Set the MinimizeBox to false to remove the minimize box.
   form1.MinimizeBox = false;
   // Set the accept button of the form to button1.
   form1.AcceptButton = button1;
   // Set the cancel button of the form to button2.
   form1.CancelButton = button2;
   // Set the start position of the form to the center of the screen.
   form1.StartPosition = FormStartPosition.CenterScreen;
   
   // Add button1 to the form.
   form1.Controls.Add(button1);
   // Add button2 to the form.
   form1.Controls.Add(button2);
   
   // Display the form as a modal dialog box.
   form1.ShowDialog();
}

See Also

Form Class | Form Members | System.WinForms Namespace