Helpbestanden in .NET

Hoe voorzie je help in een VB .NET programma? Niet zo ingewikkeld, maar je moet een paar dingen weten:

Helpbestanden worden aan formulieren gekoppeld, niet aan een volledig project.
Maak een helpbestand, en plaats dat in de map van het betrokken project - dezelfde map dan die waar de broncode in opgeslagen wordt.
Dat helpbestand moet een HTMLHelp bestand (CHM) zijn dat je kan maken met HTML Help Workshop, of een HTML bestand.
Voeg een HelpProvider toe aan het formulier. Via de eigenschap HelpNamespace kan je het helpbestand instellen.
Let erop dat het programma het helpbestand (HTML of CHM) kan vinden. Je kan dat bijvoorbeeld doen door ervoor te zorgen dat dat helpbestand in de map van het EXE bestand staat, en in Form_Load te zeggen:
HelpProvider1.HelpNamespace = Application.StartupPath & "\index.html"
Bij het opstarten van het formulier (in versie 2003: in de laatste lijn van InitializeComponent; in versie 2005: in Form_Load) bind je de Helpprovider aan de control (het formulier) en geeft een onderwerp (bijvoorbeeld index):
HelpProvider1.SetHelpKeyword(Me, "index")
De gebruiker zal nu het helpbestand zien bij het drukken op F1.
Een andere manier is een HelpButton - een eigenschap die je kan aanzetten in de eigenschappen van het formulier. Je moet dan wel MinimizeBox en MaximizeBox afzetten.
Je kan ook in code help laten verschijnen - bij voorbeeld bij de druk op een knop of bij een menu.
Private Sub showHelp_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showHelp.Click
' Display Help using the Help navigator enumeration
' that is selected in the combo box. Some enumeration
' values make use of an extra parameter, which can
' be passed in through the Parameter text box.
Dim navigator As HelpNavigator = HelpNavigator.TableOfContents
If Not (navigatorCombo.SelectedItem Is Nothing) Then
navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
End If
Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub 'showHelp_Click
Merk op dat je, als je dat verkiest, een Tooltip (aparte control) kan gebruiken om kleine, gespecialiseerde instructies te laten verschijnen bij controls.
Let op: Windows Vista ondersteunt geen 16 bit HLP bestanden meer (zie MSKB 917607). Het is best om je tot CHM bestanden te beperken. Die zijn trouwens een pak makkelijker te maken.