Export (0) Print
Expand All
Expand Minimize

HelpNavigator Enumeration

Specifies constants indicating which elements of the Help file to display.

[Visual Basic]
<Serializable>
Public Enum HelpNavigator
[C#]
[Serializable]
public enum HelpNavigator
[C++]
[Serializable]
__value public enum HelpNavigator
[JScript]
public
   Serializable
enum HelpNavigator

Remarks

This enumeration is used by Help and HelpProvider to provide access to specific elements of the Help file.

Members

Member name Description
AssociateIndex Specifies that the index for a specified topic is performed in the specified URL.
Find Specifies that the search page of a specified URL is displayed.
Index Specifies that the index of a specified URL is displayed.
KeywordIndex Specifies a keyword to search for and the action to take in the specified URL.
TableOfContents Specifies that the table of contents of the specfied URL is displayed.
Topic Specifies that the topic referenced by the specified URL is displayed.

Example

[Visual Basic, C#, C++] The following example displays a form with three buttons that can be used to interact with the mspaint.chm Help file. The Show Help Index button displays the Index tab for the Help file. The Show Help button displays content in the Help file based on the value selected in the Help Navigator list. The Show Keyword button displays content in the Help file based on the keyword specified in the Keyword text box.

[Visual Basic, C#, C++] For example, to show the Ovals Help page by the index value, select the HelpNavigator.KeywordIndex value in the Help Navigator drop-down list, type "ovals" (without the quotation marks) in the Parameter text box, and click the Show Help button. To show the "To paint with a brush" Help topic by the keyword, type "mspaint.chm::/paint_brush.htm" (without the quotation marks) in the Keyword text box and click the Show Keyword button.

[Visual Basic, C#, C++] The example uses the ShowHelp method to display the different Help tabs and Help topics, and the ShowHelpIndex method to display the Help index.

[Visual Basic, C#, C++] This example only shows using the HelpNavigator enumeration. See the Help class overview for the complete code example.

[Visual Basic] 
' Load the various values of the HelpNavigator enumeration
' into the combo box. 
Dim converter As TypeConverter
converter = TypeDescriptor.GetConverter(GetType(HelpNavigator))

Dim value As Object
For Each value In converter.GetStandardValues()
    navigatorCombo.Items.Add(value)
Next value

[C#] 
// Load the various values of the HelpNavigator enumeration
// into the combo box.
TypeConverter converter;
converter = TypeDescriptor.GetConverter(typeof(HelpNavigator));
foreach(object value in converter.GetStandardValues()) 
{
    navigatorCombo.Items.Add(value);
}

[C++] 
// Load the various values of the HelpNavigator enumeration
// into the combo box.
TypeConverter* converter;
converter = TypeDescriptor::GetConverter(__typeof(HelpNavigator));
System::Collections::IEnumerator* myEnum = 
   converter->GetStandardValues()->GetEnumerator();
while (myEnum->MoveNext()) {
   Object* value = __try_cast<Object*>(myEnum->Current);
   navigatorCombo->Items->Add(value);
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Windows.Forms

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

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

See Also

System.Windows.Forms Namespace

Show:
© 2014 Microsoft