HelpProvider::SetHelpNavigator Method (Control^, HelpNavigator)
.NET Framework (current version)
Specifies the Help command to use when retrieving Help from the Help file for the specified control.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Parameters
- ctl
-
Type:
System.Windows.Forms::Control^
A Control for which to set the Help keyword.
- navigator
-
Type:
System.Windows.Forms::HelpNavigator
One of the HelpNavigator values.
| Exception | Condition |
|---|---|
| InvalidEnumArgumentException | The value of navigator is not one of the HelpNavigator values. |
The following code example demonstrates the use of the SetHelpNavigator method.
To run this example, place it in a form containing a HelpProvider named HelpProvider1 and a TextBox named TextBox1. The example requires the existence of a Help file named input.chm in the C:\Windows directory.
//Declare the HelpProvider. internal: System::Windows::Forms::HelpProvider^ HelpProvider1; private: void InitializeHelpProvider() { // Construct the HelpProvider Object. this->HelpProvider1 = gcnew System::Windows::Forms::HelpProvider; // Set the HelpNamespace property to the Help file for // HelpProvider1. this->HelpProvider1->HelpNamespace = "c:\\windows\\input.chm"; // Specify that the Help provider should open to the table // of contents of the Help file. this->HelpProvider1->SetHelpNavigator( TextBox1, HelpNavigator::TableOfContents ); }
.NET Framework
Available since 1.1
Available since 1.1
Show: