SetHelpKeyword Method

HelpProvider.SetHelpKeyword Method (Control, String)

 

Specifies the keyword used to retrieve Help when the user invokes Help for the specified control.

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

public virtual void SetHelpKeyword(
	Control ctl,
	string keyword
)

Parameters

ctl
Type: System.Windows.Forms.Control

A Control that specifies the control for which to set the Help topic.

keyword
Type: System.String

The Help keyword to associate with the control.

The Help keyword provides the key information to retrieve the Help associated with this control from the Help file specified by the HelpNamespace property. To open Help to a specific topic, the keyword should be passed in the form topicName.htm. To clear the keyword, call the SetHelpKeyword method with a keyword value of null.

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