HelpNamespace Property
Collapse the table of content
Expand the table of content

HelpProvider.HelpNamespace Property


Gets or sets a value specifying the name of the Help file associated with this HelpProvider object.

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

abstract HelpNamespace : string with get, set
override HelpNamespace : string with get, set

Property Value

Type: System.String

The name of the Help file. This can be of the form C:\path\sample.chm or /folder/file.htm.

The file name retrieved by this method identifies the file that provides Help support for all the controls for which this object provides Help. This file name can designate either a compiled Help (.chm) file or a raw HTML file.

The following example demonstrates using the HelpProvider class to display context-sensitive Help on a form containing four address fields. The example uses the SetHelpString to set the Help ToolTip text. When using the context-sensitive Help button and clicking the Help cursor on an address field, the Help ToolTip appears with the specified text. When pressing the F1 key with the focus in an address field, the mspaint.chm Help file is displayed because the HelpNamespace property has been set to mspaint.chm. The SetShowHelp method is called for each address control to identify that it has Help content available.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
© 2016 Microsoft