Help.ShowHelp Methode

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)

Parameters

Voorbeelden

In het volgende codevoorbeeld ziet u de ShowHelp methode. Als u dit voorbeeld wilt uitvoeren, plakt u de volgende code in een formulier met de naam Button1van een knop.

// 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

Opmerkingen

Het url argument kan van het formulier C:\path\sample.chm of /folder/file.htmzijn. Zie Bestandspadindelingen op Windows systemen voor meer informatie over de indeling van paden.

Zie ook

• ShowHelpIndex(Control, String)

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)

Parameters

Voorbeelden

In het volgende codevoorbeeld wordt een formulier weergegeven met drie knoppen die kunnen worden gebruikt voor interactie met het Help-bestand mspaint.chm. Met de knop Help-index weergeven wordt het tabblad Index voor het Help-bestand weergegeven. Met de knop Help weergeven wordt inhoud in het Help-bestand weergegeven op basis van de waarde die is geselecteerd in de lijst Help Navigator . Met de knop Trefwoord weergeven wordt inhoud weergegeven in het Help-bestand op basis van het trefwoord dat is opgegeven in het tekstvak Trefwoord .

Als u bijvoorbeeld de Help-pagina Ovalen wilt weergeven op basis van de indexwaarde, selecteert u de HelpNavigator.KeywordIndex waarde in de vervolgkeuzelijst Help Navigator , typt u ovalen in het tekstvak Parameter en klikt u vervolgens op de knop Help weergeven . Als u het Help-onderwerp 'Met een kwast' wilt weergeven op het trefwoord, typt u mspaint.chm::/paint_brush.htm in het tekstvak Trefwoord en klikt u vervolgens op de knop Trefwoord weergeven .

In dit voorbeeld ziet u alleen de aanroep naar de ShowHelp methode. Zie het Help klasseoverzicht voor het volledige codevoorbeeld.

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

Opmerkingen

Het url argument kan van het formulier C:\path\sample.chm of /folder/file.htmzijn. Zie Bestandspadindelingen op Windows systemen voor meer informatie over de indeling van paden.

Als keyword dat het is null, wordt de inhoudsopgave voor het Help-bestand weergegeven.

Zie ook

• ShowHelpIndex(Control, String)

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)

Parameters

Voorbeelden

In het volgende codevoorbeeld ziet u hoe u de ShowHelp methode gebruikt om een Help-bestand te openen naar de indexpagina. Als u dit voorbeeld wilt uitvoeren, plakt u de volgende code in een formulier met de naam Button2van een knop.

// 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

Opmerkingen

Het url argument kan van het formulier C:\path\sample.chm of /folder/file.htmzijn. Zie Bestandspadindelingen op Windows systemen voor meer informatie over de indeling van paden.

Gecompileerde Help-bestanden bieden koppelingen naar inhoudsopgave, index, zoekopdrachten en trefwoordkoppelingen op pagina's. U kunt de volgende waarden gebruiken voor het navigator argument: HelpNavigator.TableOfContents, HelpNavigator.Find, , HelpNavigator.Indexof HelpNavigator.Topic.

Zie ook

• ShowHelpIndex(Control, String)

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

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 param);

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

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, param As Object)

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

Parameters

Uitzonderingen

Voorbeelden

In het volgende codevoorbeeld wordt een formulier weergegeven met drie knoppen die kunnen worden gebruikt voor interactie met het Help-bestand mspaint.chm. Met de knop Help-index weergeven wordt het tabblad Index voor het Help-bestand weergegeven. Met de knop Help weergeven wordt inhoud in het Help-bestand weergegeven op basis van de waarde die is geselecteerd in de lijst Help Navigator . Met de knop Trefwoord weergeven wordt inhoud weergegeven in het Help-bestand op basis van het trefwoord dat is opgegeven in het tekstvak Trefwoord .

Als u bijvoorbeeld de Help-pagina Ovalen wilt weergeven op basis van de indexwaarde, selecteert u de HelpNavigator.KeywordIndex waarde in de vervolgkeuzelijst Help Navigator , typt u ovalen in het tekstvak Parameter en klikt u vervolgens op de knop Help weergeven . Als u het Help-onderwerp 'Met een kwast' wilt weergeven op het trefwoord, typt u mspaint.chm::/paint_brush.htm in het tekstvak Trefwoord en klikt u vervolgens op de knop Trefwoord weergeven .

In dit voorbeeld ziet u alleen de aanroep naar de ShowHelp methode. Zie het Help klasseoverzicht voor het volledige codevoorbeeld.

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

Opmerkingen

Het url argument kan van het formulier C:\path\sample.chm of /folder/file.htmzijn. Zie Bestandspadindelingen op Windows systemen voor meer informatie over de indeling van paden.

Gecompileerde Help-bestanden bieden koppelingen naar inhoudsopgave, index, zoekopdrachten en trefwoordkoppelingen op pagina's. U kunt het parameter argument gebruiken om extra verfijning van de HelpNavigator.Topic, HelpNavigator.TopicIdof HelpNavigator.KeywordIndexHelpNavigator.AssociateIndex opdracht op te geven. Als de waarde die is opgegeven in het command argument HelpNavigator.TableOfContents, HelpNavigator.Indexof HelpNavigator.Find, moet deze waarde een lege tekenreeks zijn ("", of String.Empty). Als de command argumentverwijzingen HelpNavigator.Topic, HelpNavigator.TopicIdHelpNavigator.KeywordIndexof , deze HelpNavigator.AssociateIndexwaarde een tekenreeks moet zijn die de onderwerpnaam bevat, of het trefwoord of de numerieke id van het onderwerp dat moet worden weergegeven.

Zie ook

• ShowHelpIndex(Control, String)