Help Files Sample
This sample shows how to add Help to a Windows-based application using the, , and controls.
This sample code is provided to illustrate a concept and should not be used in applications or Web sites, as it may not illustrate the safest coding practices. Microsoft assumes no liability for incidental or consequential damages should the sample code be used for purposes other than as intended.
To open the sample file in Solution Explorer
Click Download Sample.
The File Download message box appears.
Click Open, and on the left column of the zip folder window, click Extract all files.
The Extraction Wizard opens.
Click Next. You can change the directory that the files will be extracted to, and then click Next again.
Make sure that the Show extracted files check box is selected, and click Finish.
Double-click the sample's .sln file.
The sample solution is displayed in Solution Explorer. You might get a security warning that says the solution location is not trusted. Click OK to continue.
To run this sample
Each tabbed page of thedisplays a different type of help:
ToolTip A ToolTip component is added to the form. This adds the ToolTip1 property to each control on the form.
PopUp A HelpProvider component named hpAdvancedCHM is added to the form. This adds the Help String on hpAdvancedCHM property to each control which is set with a Help string. The ShowHelp on hpAdvancedCHM property is also added to each control, and is set to True. Theproperty of the form is set to True to display the question mark button in the corner next to the close button. The minimize and maximize buttons have to be turned off for the Help button to appear.
HTML Help A HelpProvider component named hpAdvancedCHM is added to the form. This adds the HelpKeyword on hpAdvancedCHM, HelpNavigator on hpAdvancedCHM, and ShowHelp on hpAdvancedCHM properties to each control. The ShowHelp on hpAdvancedCHM property is set to True. The compiled Help file is open to the Help page with the specified keyword. The HelpButton property of the form is set to True to display the question mark button in the corner next to the close button. The minimize and maximize buttons have to be turned off for the Help button to appear.
Error Provider The ErrorProvider component is used to show how to give the user visible warning on a control that does not validate to the correct data type.