HelpProvider.SetHelpKeyword(Control, String) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

HelpProvider.cs

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

public:
 virtual void SetHelpKeyword(System::Windows::Forms::Control ^ ctl, System::String ^ keyword);

public virtual void SetHelpKeyword (System.Windows.Forms.Control ctl, string? keyword);

abstract member SetHelpKeyword : System.Windows.Forms.Control * string -> unit
override this.SetHelpKeyword : System.Windows.Forms.Control * string -> unit

Public Overridable Sub SetHelpKeyword (ctl As Control, keyword As String)

Parameters

ctl

Control

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

keyword

String

The Help keyword to associate with the control.

Remarks

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.

See also

• GetHelpString(Control)
• GetHelpKeyword(Control)
• GetShowHelp(Control)
• SetHelpString(Control, String)
• SetHelpKeyword(Control, String)