Help.ShowHelp Método

Referência

Definição

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Exibe o conteúdo de um arquivo de Ajuda.

Sobrecargas

ShowHelp(Control, String)	Exibe o conteúdo do arquivo de Ajuda na URL especificada.
ShowHelp(Control, String, String)	Exibe o conteúdo do arquivo de Ajuda encontrado no URL especificado para uma palavra-chave específica.
ShowHelp(Control, String, HelpNavigator)	Exibe o conteúdo do arquivo de Ajuda localizado no URL especificado para um tópico específico.
ShowHelp(Control, String, HelpNavigator, Object)	Exibe o conteúdo do arquivo de Ajuda localizado na URL fornecida pelo usuário.

ShowHelp(Control, String)

Exibe o conteúdo do arquivo de Ajuda na URL especificada.

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

public static void ShowHelp (System.Windows.Forms.Control parent, 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)

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 demonstra o ShowHelp método . Para executar este exemplo, cole o código a seguir em um formulário que contém um botão chamado 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

Comentários

O url argumento pode ser do formato C:\path\sample.chm ou /folder/file.htm. Para obter informações sobre o formato dos caminhos, consulte Formatos de caminho de arquivo em sistemas Windows.

Confira também

ShowHelpIndex(Control, String)

Aplica-se a

ShowHelp(Control, String, String)

Exibe o conteúdo do arquivo de Ajuda encontrado no URL especificado para uma palavra-chave específica.

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

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)

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.

keyword: String

A palavra-chave para a qual exibir a 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 de Ajuda com base no valor selecionado na lista Navegador da Ajuda . O botão Mostrar Palavra-chave exibe o conteúdo no arquivo de Ajuda com base no palavra-chave especificado na caixa de texto Palavra-chave.

Por exemplo, para mostrar a página ajuda ovals pelo valor de índice, selecione o HelpNavigator.KeywordIndex valor na lista suspensa Navegador da Ajuda , digite ovals na caixa de texto Parâmetro e clique no botão Mostrar Ajuda . Para mostrar o tópico da Ajuda "Para pintar com um pincel" da 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 ShowHelp método . Consulte a visão geral da Help classe para obter o exemplo de código completo.

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

Comentários

O url argumento pode ser do formato C:\path\sample.chm ou /folder/file.htm. Para obter informações sobre o formato dos caminhos, consulte Formatos de caminho de arquivo em sistemas Windows.

Se keyword for null, o sumário do arquivo de Ajuda será exibido.

Confira também

ShowHelpIndex(Control, String)

Aplica-se a

ShowHelp(Control, String, HelpNavigator)

Exibe o conteúdo do arquivo de Ajuda localizado no URL especificado para um tópico específico.

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

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)

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.

navigator: HelpNavigator

Um dos valores de HelpNavigator.

Exemplos

O exemplo de código a seguir demonstra como usar o ShowHelp método para abrir um arquivo de Ajuda em sua página de índice. Para executar este exemplo, cole o código a seguir em um formulário que contém um botão chamado 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

Comentários

O url argumento pode ser do formato C:\path\sample.chm ou /folder/file.htm. Para obter informações sobre o formato dos caminhos, consulte Formatos de caminho de arquivo em sistemas Windows.

Os arquivos de Ajuda compilados fornecem um sumário, índice, pesquisa e palavra-chave links em páginas. Você pode usar os seguintes valores para o navigator argumento: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexou HelpNavigator.Topic.

Confira também

ShowHelpIndex(Control, String)

Aplica-se a

ShowHelp(Control, String, HelpNavigator, Object)

Exibe o conteúdo do arquivo de Ajuda localizado na URL fornecida pelo usuário.

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

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)

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.

command: HelpNavigator

Um dos valores de HelpNavigator.

paramparameter: Object

Uma cadeia de caracteres que contém o identificador do tópico.

Exceções

ArgumentException

parameter é um inteiro.

Exemplos

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

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

Comentários

O url argumento pode ser do formato C:\path\sample.chm ou /folder/file.htm. Para obter informações sobre o formato dos caminhos, consulte Formatos de caminho de arquivo em sistemas Windows.

Os arquivos de Ajuda compilados fornecem links de sumário, índice, pesquisa e palavra-chave em páginas. Você pode usar o parameter argumento para fornecer refinamento adicional do HelpNavigator.Topiccomando , HelpNavigator.TopicId, HelpNavigator.KeywordIndexou HelpNavigator.AssociateIndex . Se o valor especificado no command argumento for HelpNavigator.TableOfContents, HelpNavigator.Indexou HelpNavigator.Find, esse valor deverá ser uma cadeia de caracteres vazia ("", ou String.Empty). Se o argumento fizer referência a command , HelpNavigator.TopicId, HelpNavigator.KeywordIndexou HelpNavigator.AssociateIndex, esse valor deverá ser uma cadeia de caracteres HelpNavigator.Topicque contém o nome do tópico ou o identificador palavra-chave ou numérico do tópico a ser exibido.

Confira também

ShowHelpIndex(Control, String)

Aplica-se a

Partilhar via

Help.ShowHelp Método

Definição

Sobrecargas

ShowHelp(Control, String)

Parâmetros

Exemplos

Comentários

Confira também

Aplica-se a

ShowHelp(Control, String, String)

Parâmetros

Exemplos

Comentários

Confira também

Aplica-se a

ShowHelp(Control, String, HelpNavigator)

Parâmetros

Exemplos

Comentários

Confira também

Aplica-se a

ShowHelp(Control, String, HelpNavigator, Object)

Parâmetros

Exceções

Exemplos

Comentários

Confira também

Aplica-se a

Recursos adicionais