Help.ShowHelpIndex(Control, String) Método

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Determina o índice do arquivo de Ajuda especificado.

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

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

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

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

Parâmetros

parent

Control

Um Control que identifica o pai da caixa de diálogo de Ajuda.

url

String

O caminho e o nome do arquivo de Ajuda.

Exemplos

O exemplo de código a seguir exibe um formulário com três botões que podem ser usados para interagir com o arquivo de Ajuda mspaint.chm. O botão Mostrar Índice de Ajuda exibe a guia Índice do arquivo de Ajuda. O botão Mostrar Ajuda exibe o conteúdo no arquivo ajuda com base no valor selecionado na lista do Help Navigator . O botão Mostrar Palavra-Chave exibe o conteúdo no arquivo ajuda com base na palavra-chave especificada na caixa de texto Palavra-chave .

Por exemplo, para mostrar a página de Ajuda do Ovals pelo valor do índice, selecione o HelpNavigator.KeywordIndex valor na lista suspensa do Help Navigator , digite ovais na caixa de texto Parâmetro e clique no botão Mostrar Ajuda . Para mostrar o tópico de Ajuda "Para pintar com um pincel" pela palavra-chave, digite mspaint.chm::/paint_brush.htm na caixa de texto Palavra-chave e clique no botão Mostrar Palavra-Chave .

Este exemplo mostra apenas a chamada para o ShowHelpIndex método. Confira a visão geral da Help classe para o exemplo de código completo.

private:
   void showIndex_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      
      // Display the index for the help file.
      Help::ShowHelpIndex( this, helpfile );
   }

private void showIndex_Click(object sender, System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
}

Private Sub showIndex_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showIndex.Click
    ' Display the index for the Help file.
    Help.ShowHelpIndex(Me, helpfile)
End Sub

Comentários

O url parâmetro pode ser do formulário C:\path\sample.chm ou /folder/file.htm.

Confira também

• ShowHelp(Control, String)