NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

HelpProvider.GetHelpString

Retrieves the contents of the pop-up help window for the specified control.

[Visual Basic]
Overridable Public Function GetHelpString( _
   ByVal ctl As RichControl _
) As String
[C#]
public virtual string GetHelpString(
   RichControl ctl
);
[C++]
public: virtual String* GetHelpString(
   RichControl* ctl
);
[JScript]
public function GetHelpString(
   ctl : RichControl
) : String;

Parameters

ctl
A RichControl from which to retrieve the Help string.

Return Value

The Help string associated with this control. The default value is a null reference (in Visual Basic Nothing).

Remarks

To display this Help string at run time, the user clicks F1 while the specified control has the input focus.

See Also

HelpProvider Class | HelpProvider Members | System.WinForms Namespace | GetHelpTopic | GetShowHelp | SetHelpTopic | SetHelpString | SetShowHelp