Dela via

Översikt över HelpProvider-komponent (Windows-formulär)

  • Artikel

Komponenten Windows Forms HelpProvider används för att associera en HTML Help 1.x-hjälpfil (antingen en .chm-fil som skapats med HTML-hjälpverkstaden eller en .htm fil) med ditt Windows-program. Du kan ge hjälp på flera olika sätt:

  • Ge sammanhangsberoende hjälp för kontroller i Windows-formulär.

  • Ange sammanhangsberoende hjälp i en viss dialogruta eller specifika kontroller i en dialogruta.

  • Öppna en hjälpfil för specifika områden, till exempel huvudsidan i en innehållsförteckning, indexet eller en sökfunktion.

Använda hjälpprovidern

Genom att lägga till en HelpProvider komponent i ditt Windows-formulär kan de andra kontrollerna i formuläret exponera hjälpegenskaperna för komponenten HelpProvider. På så sätt kan du ge hjälp för kontrollerna i ditt Windows-formulär. Du kan associera en hjälpfil med komponenten HelpProvider med hjälp av egenskapen HelpNamespace. Du anger vilken typ av hjälp som tillhandahålls genom att anropa SetHelpNavigator och ange ett värde från HelpNavigator uppräkning för den angivna kontrollen. Du anger nyckelordet eller ämnet för Hjälp genom att anropa metoden SetHelpKeyword.

Om du vill associera en specifik hjälpsträng med en annan kontroll använder du metoden SetHelpString. Strängen som du associerar med en kontroll med den här metoden visas i ett popup-fönster när användaren trycker på F1-tangenten medan kontrollen har fokus.

Om HelpNamespace inte har angetts måste du använda SetHelpString för att ange hjälptexten. Om du har angett både HelpNamespace och hjälpsträngen prioriteras Hjälp baserat på HelpNamespace.

Not

Du kan stöta på problem med att använda den relativa sökvägen när du anger sökvägen till hjälpfilen i ShowHelp-metoden eller HelpNamespace egenskapen för HelpProvider-kontrollen. Se därför till att använda den absoluta filsökvägen för att ange Hjälpfilen.

Se även