Postupy: Určení souboru nápovědy pro vaši komponentu
Ve většině případů by mělo umožnit vývojáři, kteří používají vaše komponenty povolit spuštění nápovědy.V některých případech však ji bude smysl povolit zobrazení nápovědy HTML při volání komponenty.Nápověda HTML může být poskytován prostřednictvím součásti Help objektu.Tento objekt je statická třída, která zapouzdřuje 1 nápovědy HTML.x engine.Nelze vytvořit instanci této třídy a jeho metody musí být volán přímo.Vyvolat nápovědu zobrazíte Help.ShowHelp metody metoda.Tato přetížená metoda vyžaduje nejméně dva argumenty: ovládací prvek, který slouží jako nadřazený ovládací prvek v dialogovém okně Nápověda a adresu URL souboru nápovědy.Soubor nápovědy může být zkompilované 1 nápovědy HTML. x soubor (soubor CHM) nebo soubor ve formátu HTML ve formátu nápovědy HTML.
Pokud chcete zahrnout podporu pro soubor nápovědy přímo v komponentě, máte dvě možnosti, kdy a jak jej zobrazit:
Upřednostňovanou možností je implementovat metodu nápovědy volanou aplikací klienta.Klientská aplikace lze předat parametry metody nápovědy k zajištění správné témata jsou zobrazeny a vývojáře kódování s komponenty má možnost zcela vynechání nápovědy.
Další možností je vyvolat ShowHelp metoda v reakci na podmínky v kódu.Tento přístup poskytuje, nejlépe ovládat co nápovědy se zobrazí, pokud jej však přísně omezuje budoucí vývojáře v používání komponenty.
Zadání a zobrazení souboru nápovědy pro komponenty
Vytvoření a kompilace souboru CHM nápovědy.
Pokud již nemáte odkaz na System.Windows.Forms oboru názvů v komponentě, přidejte jedno.
Vytvořte metodu veřejné zobrazení nápovědy.Tato metoda by poskytují snadný způsob pro vývojáře zadat nápovědu, jaké potřebují zobrazit.
' This method takes parameters from the client application that allow ' the developer to specify when Help is displayed. Public Sub DisplayHelp (ByVal parent as System.Windows.Forms.Control, _ ByVal topic as MyHelpEnum) ' The file to display is chosen by the value of the topic ' parameter. Select Case topic Case MyHelpEnum.enumWidgets Windows.Forms.Help.ShowHelp(parent, "C:\Help\Widgets.chm") Case MyHelpEnum.enumMechanisms ' Insert code to implement additional functionality. End Select End Sub// This method takes parameters from the client application that allow // the developer to specify when Help is to be shown. public void MyHelp(System.Windows.Forms.Control parent, myHelpEnum topic) { // The file to display is chosen by the value of the topic. switch (topic) { case myHelpEnum.enumWidgets: System.Windows.Forms.Help.ShowHelp(parent, " C:\\help\\widgets.chm "); break; case myHelpEnum.enumMechanism: // Insert code to implement additional functionality. break; } }