Gewusst wie: Festlegen einer Hilfedatei für Ihre Komponente

Aktualisiert: November 2007

In den meisten Fällen sollten Sie es den Entwicklern, die Ihre Komponente verwenden, ermöglichen, die Laufzeithilfe zu aktivieren. In manchen Fällen ist es jedoch sinnvoll, wenn die Komponente beim Aufrufen die HTML-Hilfe anzeigt. HTML Help kann über das System.Windows.Forms.Help-Objekt für Komponenten bereitgestellt werden. Dieses Objekt ist eine statische Klasse, von der das Modul HTML Help 1.x gekapselt wird. Diese Klasse kann nicht instanziiert werden, und ihre Methoden müssen direkt aufgerufen werden. Um die Hilfe anzuzeigen, rufen Sie die Help.ShowHelp-Methode auf. Für diese überladene Methode sind mindestens zwei Argumente erforderlich: das Steuerelement, das als das übergeordnete Steuerelement des Hilfedialogfelds fungiert, und der URL der Hilfedatei. Die Hilfedatei kann eine kompilierte HTML Help 1.x-Datei (CHM-Erweiterung) oder eine HTML-Datei im HTML Help-Format sein.

Wenn Sie die Unterstützung für eine Hilfedatei direkt in die Komponente integrieren, gibt es zwei Optionen, wann und wie sie angezeigt werden soll:

• Die bevorzugte Methode ist, eine Hilfemethode zu implementieren, die von der Clientanwendung aufgerufen werden kann. Die Clientanwendung übergibt Parameter an die Hilfemethode, um zu gewährleisten, dass die richtigen Themen angezeigt werden, und der Entwickler, der Codierungen für die Komponente vornimmt, hat die Möglichkeit, die Hilfe komplett zu umgehen.

• Die andere Möglichkeit besteht darin, die ShowHelp-Methode als Antwort auf Bedingungen im Code aufzurufen. Mit diesem Ansatz können Sie am besten steuern, welche Hilfe wann angezeigt wird. Zukünftige Entwickler können die Komponente jedoch nur eingeschränkt verwenden.

So legen Sie eine Hilfedatei für die Komponente fest und zeigen sie an

1. Erstellen und kompilieren Sie die CHM-Hilfedatei.

2. Wenn noch kein Verweis auf den System.Windows.Forms-Namespace in der Komponente enthalten ist, fügen Sie einen hinzu.

3. Erstellen Sie eine öffentliche Methode, um die Hilfe anzuzeigen. Mit dieser Methode sollte es für Entwickler einfach sein, die Hilfe festzulegen, die angezeigt werden soll.

   ' 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;
      }
   }
   

Siehe auch

Referenz

Help

Weitere Ressourcen

Benutzerhilfe für Komponenten