Udostępnij za pośrednictwem

Jak: Określ plik pomocy dla składnika

  • Artykuł

W większości sytuacji należy pozwolić deweloperzy korzystający z sieci Włącz składnik pomocy.W niektórych przypadkach jednak wprowadzi pozostawienie składnik wyświetlić Pomoc HTML po wywołaniu.Pomoc HTML można podać składników przez System.Windows.Forms.Help obiektu.Ten obiekt jest statyczne klasy, która hermetyzuje 1 pomocy HTML.x engine.Nie można utworzyć wystąpienia tej klasy i jej metod musi być wywołana bezpośrednio.Aby wyświetlić Pomoc, należy wywołać Metoda Help.ShowHelp metody.Ta metoda przeciążony wymaga co najmniej dwa argumenty: formant, który działa jako formantu nadrzędnego w oknie dialogowym Pomoc i adres URL pliku pomocy.Plik Pomocy można skompilowanej 1 pomocy HTML. x plik (.chm) lub plik HTML w formacie HTML Help.

Jeśli zamierzasz włączyć obsługę plików pomocy bezpośrednio w składniku, masz dwie opcje, kiedy i jak go wyświetlić:

  • Preferowaną opcją jest implementacji metody pomocy, które mogą być wywoływane przez aplikację klienta.Aplikacja klienta można przekazać parametry metody pomocy aby zapewnić poprawne tematy są wyświetlane i developer kodowania z składnik ma możliwość całkowicie pomijanie pomocy.

  • Inną opcją jest wywoływanie ShowHelp metody w odpowiedzi na warunki występujące w kodzie.To podejście zapewnia możesz większą kontrolę nad pomocy jest wyświetlane, ale poważnie ogranicza deweloperzy przyszłego wykorzystania składnika.

Aby określić i wyświetlić plik pomocy dla składnika

  1. Tworzenie i kompilacji pliku CHM pomocy.

  2. Jeśli nie masz już odwołanie do System.Windows.Forms obszaru nazw w składniku, dodać jeden.

  3. Tworzenie metody publiczne do pokazywania Pomocy.Metoda ta powinna umożliwiają łatwe dla deweloperów określić jakie pomocy potrzebują, aby wyświetlić.

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

Zobacz też

Informacje

Help

Inne zasoby

System pomocy dla składników