Help.ShowHelp Metoda

Definicja

Przestrzeń nazw:

System.Windows.Forms

Zestaw:

System.Windows.Forms.dll

Wyświetla zawartość pliku Pomocy.

Przeciążenia

ShowHelp(Control, String)	Wyświetla zawartość pliku Pomocy pod określonym adresem URL.
ShowHelp(Control, String, String)	Wyświetla zawartość pliku Pomocy znalezionego pod określonym adresem URL określonego słowa kluczowego.
ShowHelp(Control, String, HelpNavigator)	Wyświetla zawartość pliku Pomocy znalezionego pod określonym adresem URL dla określonego tematu.
ShowHelp(Control, String, HelpNavigator, Object)	Wyświetla zawartość pliku Pomocy znajdującego się pod adresem URL dostarczonym przez użytkownika.

ShowHelp(Control, String)

Wyświetla zawartość pliku Pomocy pod określonym adresem URL.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url);

static member ShowHelp : System.Windows.Forms.Control * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String)

Parametry

parent

Control

Element Control identyfikujący element nadrzędny okna dialogowego Pomoc.

url

String

Ścieżka i nazwa pliku Pomocy.

Przykłady

Poniższy przykład kodu przedstawia metodę ShowHelp . Aby uruchomić ten przykład, wklej następujący kod w formularzu zawierającym przycisk o nazwie Button1.

// Open the Help file for the Character Map topic.  
void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm" );
}

// Open the Help file for the Character Map topic.  
private void Button1_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm");
}

' Open the Help file for the Character Map topic.  
Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm")
End Sub

Uwagi

Argument url może mieć postać C:\path\sample.chm lub /folder/file.htm. Aby uzyskać informacje na temat formatu ścieżek, zobacz Formaty ścieżek plików w systemach Windows.

Zobacz też

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Wyświetla zawartość pliku Pomocy znalezionego pod określonym adresem URL określonego słowa kluczowego.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::String ^ keyword);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, string? keyword);

static member ShowHelp : System.Windows.Forms.Control * string * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, keyword As String)

Parametry

parent

Control

Element Control identyfikujący element nadrzędny okna dialogowego Pomoc.

url

String

Ścieżka i nazwa pliku Pomocy.

keyword

String

Słowo kluczowe do wyświetlenia Pomocy.

Przykłady

Poniższy przykład kodu wyświetla formularz z trzema przyciskami, których można użyć do interakcji z plikiem pomocy mspaint.chm. Przycisk Pokaż indeks Pomocy wyświetla kartę Indeks dla pliku Pomocy. Przycisk Pokaż Pomoc wyświetla zawartość w pliku Pomocy na podstawie wartości wybranej na liście Nawigator pomocy . Przycisk Pokaż słowo kluczowe wyświetla zawartość w pliku Pomocy na podstawie słowa kluczowego określonego w polu tekstowym Słowo kluczowe .

Aby na przykład wyświetlić stronę Pomoc Ovals według wartości indeksu, wybierz HelpNavigator.KeywordIndex wartość z listy rozwijanej Nawigator pomocy , wpisz owalny w polu tekstowym Parametr , a następnie kliknij przycisk Pokaż Pomoc . Aby wyświetlić temat Pomocy "Aby malować za pomocą pędzla" według słowa kluczowego, wpisz mspaint.chm::/paint_brush.htm w polu tekstowym Słowo kluczowe , a następnie kliknij przycisk Pokaż słowo kluczowe .

W tym przykładzie pokazano tylko wywołanie ShowHelp metody . Zobacz omówienie klasy, Help aby zapoznać się z kompletnym przykładem kodu.

void showKeyword_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display help using the provided keyword.
   Help::ShowHelp( this, helpfile, keyword->Text );
}

private void showKeyword_Click(object sender, System.EventArgs e)
{
    // Display help using the provided keyword.
    Help.ShowHelp(this, helpfile, keyword.Text);
}

Private Sub showKeyword_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showKeyword.Click
    ' Display Help using the provided keyword. 
    Help.ShowHelp(Me, helpfile, keyword.Text)
End Sub

Uwagi

Argument url może mieć postać C:\path\sample.chm lub /folder/file.htm. Aby uzyskać informacje na temat formatu ścieżek, zobacz Formaty ścieżek plików w systemach Windows.

Jeśli keyword parametr ma nullwartość , zostanie wyświetlony spis treści pliku Pomocy.

Zobacz też

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Wyświetla zawartość pliku Pomocy znalezionego pod określonym adresem URL dla określonego tematu.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator navigator);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator navigator);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, navigator As HelpNavigator)

Parametry

parent

Control

Element Control identyfikujący element nadrzędny okna dialogowego Pomoc.

url

String

Ścieżka i nazwa pliku Pomocy.

navigator

HelpNavigator

HelpNavigator Jedna z wartości.

Przykłady

W poniższym przykładzie kodu pokazano, jak za pomocą ShowHelp metody otworzyć plik Pomocy na stronie indeksu. Aby uruchomić ten przykład, wklej następujący kod w formularzu zawierającym przycisk o nazwie Button2.

// Open the Help file for the Character Map topic and 
// display the Index page.
void Button2_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm", HelpNavigator::Index );
}

// Open the Help file for the Character Map topic and 
// display the Index page.
private void Button2_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm", 
        HelpNavigator.Index);
}

' Open the Help file for the Character Map topic and 
' display the Index page.
Private Sub Button2_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button2.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm", HelpNavigator.Index)
End Sub

Uwagi

Argument url może mieć postać C:\path\sample.chm lub /folder/file.htm. Aby uzyskać informacje na temat formatu ścieżek, zobacz Formaty ścieżek plików w systemach Windows.

Skompilowane pliki Pomocy udostępniają spis treści, indeks, wyszukiwanie i linki słów kluczowych na stronach. Dla argumentu navigator można użyć następujących wartości: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexlub HelpNavigator.Topic.

Zobacz też

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Wyświetla zawartość pliku Pomocy znajdującego się pod adresem URL dostarczonym przez użytkownika.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ parameter);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator command, object? parameter);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator * obj -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)

Parametry

parent

Control

Element Control identyfikujący element nadrzędny okna dialogowego Pomoc.

url

String

Ścieżka i nazwa pliku Pomocy.

command

HelpNavigator

HelpNavigator Jedna z wartości.

parameter

Object

Ciąg zawierający identyfikator tematu.

Wyjątki

ArgumentException

parameter jest liczbą całkowitą.

Przykłady

Poniższy przykład kodu wyświetla formularz z trzema przyciskami, których można użyć do interakcji z plikiem pomocy mspaint.chm. Przycisk Pokaż indeks Pomocy wyświetla kartę Indeks dla pliku Pomocy. Przycisk Pokaż Pomoc wyświetla zawartość w pliku Pomocy na podstawie wartości wybranej na liście Nawigator pomocy . Przycisk Pokaż słowo kluczowe wyświetla zawartość w pliku Pomocy na podstawie słowa kluczowego określonego w polu tekstowym Słowo kluczowe .

Aby na przykład wyświetlić stronę Pomoc Ovals według wartości indeksu, wybierz HelpNavigator.KeywordIndex wartość z listy rozwijanej Nawigator pomocy , wpisz owalny w polu tekstowym Parametr , a następnie kliknij przycisk Pokaż Pomoc . Aby wyświetlić temat Pomocy "Aby malować za pomocą pędzla" według słowa kluczowego, wpisz mspaint.chm::/paint_brush.htm w polu tekstowym Słowo kluczowe , a następnie kliknij przycisk Pokaż słowo kluczowe .

W tym przykładzie pokazano tylko wywołanie ShowHelp metody . Zobacz omówienie klasy, Help aby zapoznać się z kompletnym przykładem kodu.

void showHelp_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // 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.
   HelpNavigator navigator = HelpNavigator::TableOfContents;
   if ( navigatorCombo->SelectedItem != nullptr )
   {
      navigator =  *safe_cast<HelpNavigator^>(navigatorCombo->SelectedItem);
   }

   Help::ShowHelp( this, helpfile, navigator, parameterTextBox->Text );
}

private void showHelp_Click(object sender, System.EventArgs e)
{
    // 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.
    HelpNavigator navigator = HelpNavigator.TableOfContents;
    if (navigatorCombo.SelectedItem != null)
    {
        navigator = (HelpNavigator)navigatorCombo.SelectedItem;
    }
    Help.ShowHelp(this, helpfile, navigator, parameterTextBox.Text);
}

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 (navigatorCombo.SelectedItem IsNot Nothing) Then
        navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
    End If
    Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub

Uwagi

Argument url może mieć postać C:\path\sample.chm lub /folder/file.htm. Aby uzyskać informacje na temat formatu ścieżek, zobacz Formaty ścieżek plików w systemach Windows.

Skompilowane pliki Pomocy udostępniają na stronach łącza spisu treści, indeksu, wyszukiwania i słowa kluczowego. Możesz użyć argumentu parameter , aby zapewnić dodatkowe uściślenie HelpNavigator.Topicpolecenia , HelpNavigator.TopicId, HelpNavigator.KeywordIndexlub HelpNavigator.AssociateIndex . Jeśli wartość określona w argumencie command to HelpNavigator.TableOfContents, HelpNavigator.Indexlub HelpNavigator.Find, ta wartość powinna być pustym ciągiem ("", lub String.Empty). command Jeśli argument odwołuje HelpNavigator.Topicsię do , HelpNavigator.TopicId, HelpNavigator.KeywordIndexlub HelpNavigator.AssociateIndex, ta wartość powinna być ciągiem zawierającym nazwę tematu lub słowem kluczowym lub identyfikatorem liczbowym tematu do wyświetlenia.

Zobacz też

• ShowHelpIndex(Control, String)