ICSHIDProvider API

 

Interface:

ICSHIDProvider

The ICSHIDProvider is used to enable a System.Windows.Forms.Control to be a CSH ID provider. If your application uses dynamic help, F1 help, or the dialog's help button, the DotNet CSH engine uses this interface to determine the desired topic to display. As an alternative to implementing this interface, you may also set the control's Tag property to the desired CSH ID string. In this case, you must prefix the string with "CSH:". For example, if your CSH ID is "MyHelpTopic", you would set the Tag object to the string "CSH:MyHelpTopic".

 

Name Description
public string HelpSystemCSHID Gets the CSH ID of the topic that should be displayed in the help system.

 

Examples

1) Implementing the ICSHIDProvider interface:

 

public class MyTextBox : TextBox, ICSHIDProvider
{
private string mHelpSystemCSHID = "TestID1";

public string HelpSystemCSHID
{
get { return mHelpSystemCSHID; }
}

...
}

 

2) Setting the Tag object:

 

TextBox myTextBox = new TextBox();

myTextBox.Tag = "CSH:TestID1";