System.Windows.Forms.HelpNavigator Enumeration

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

Syntax

public enum HelpNavigator

Remarks

This enumeration is used by the System.Windows.Forms.Help and System.Windows.Forms.HelpProvider classes to provide access to specific elements of a Help file. For example, when used with the System.Windows.Forms.HelpProvider component that provides F1 Help, the HelpNavigator.TopicId or HelpNavigator.Topic value could be specified to open Help to a context-specific topic.

Members

Member NameDescription
AssociateIndex

The Help file opens to the index entry for the first letter of a specified topic.

Find

The Help file opens to the search page.

Index

The Help file opens to the index.

KeywordIndex

The Help file opens to the topic with the specified index entry, if one exists; otherwise, the index entry closest to the specified keyword is displayed.

TableOfContents

The Help file opens to the table of contents.

Topic

The Help file opens to a specified topic, if the topic exists.

TopicId

The Help file opens to a topic indicated by a numeric topic identifier.

Requirements

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0