ICSHIDProvider API

The ICSHIDProviderAPI is used to enable a System.Windows.Forms.Control to be a context-sensitive Help (CSH) ID provider. This is required to incorporate any of the following:

If your application uses any of these features, 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

The following shows how to implement the ICSHIDProvider interface:

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

 public string HelpSystemCSHID
 {
  get { return mHelpSystemCSHID; }
 }

 ...
}

The following shows how to set the Tag object:

TextBox myTextBox = new TextBox();

myTextBox.Tag = "CSH:TestID1";