Help.ShowHelp Método

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)

Parâmetros

Exemplos

O seguinte exemplo de código demonstra o ShowHelp método. Para executar este exemplo, cole o código seguinte numa forma que contenha 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

Observações

O url argumento pode ser da forma C:\path\sample.chm ou /folder/file.htm. Para informações sobre o formato dos caminhos, veja formatos de caminho de ficheiro em sistemas Windows.

Ver também

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

Parâmetros

Exemplos

O exemplo de código seguinte apresenta um formulário com três botões que pode ser usado para interagir com o ficheiro de Ajuda mspaint.chm. O botão Mostrar Índice de Ajuda mostra o separador Índice do ficheiro de Ajuda. O botão Mostrar Ajuda mostra o conteúdo no ficheiro Ajuda com base no valor selecionado na lista do Navegador de Ajuda . O botão Mostrar Palavra-Chave mostra o conteúdo no ficheiro Ajuda com base na palavra-chave especificada na caixa de texto Palavra-chave .

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

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

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

Observações

O url argumento pode ser da forma C:\path\sample.chm ou /folder/file.htm. Para informações sobre o formato dos caminhos, veja formatos de caminho de ficheiro em sistemas Windows.

Se keyword for null, será exibido o índice do ficheiro de Ajuda.

Ver também

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

Parâmetros

Exemplos

O exemplo de código seguinte demonstra como usar o ShowHelp método para abrir um ficheiro de Ajuda na sua página de índice. Para executar este exemplo, cole o código seguinte numa forma que contenha 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

Observações

O url argumento pode ser da forma C:\path\sample.chm ou /folder/file.htm. Para informações sobre o formato dos caminhos, veja formatos de caminho de ficheiro em sistemas Windows.

Os ficheiros de Ajuda Compilada fornecem índice, indexação, pesquisa e links de palavras-chave nas páginas. Pode usar os seguintes valores para o navigator argumento: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Index, ou HelpNavigator.Topic.

Ver também

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

Parâmetros

Exceções

Exemplos

O exemplo de código seguinte apresenta um formulário com três botões que pode ser usado para interagir com o ficheiro de Ajuda mspaint.chm. O botão Mostrar Índice de Ajuda mostra o separador Índice do ficheiro de Ajuda. O botão Mostrar Ajuda mostra o conteúdo no ficheiro Ajuda com base no valor selecionado na lista do Navegador de Ajuda . O botão Mostrar Palavra-Chave mostra o conteúdo no ficheiro Ajuda com base na palavra-chave especificada na caixa de texto Palavra-chave .

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

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

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

Observações

O url argumento pode ser da forma C:\path\sample.chm ou /folder/file.htm. Para informações sobre o formato dos caminhos, veja formatos de caminho de ficheiro em sistemas Windows.

Os ficheiros de Ajuda Compilada fornecem índice, indexação, pesquisa e links de palavras-chave nas páginas. Pode usar o parameter argumento para fornecer um refinamento adicional do HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndex, ou HelpNavigator.AssociateIndex comando. Se o valor especificado no command argumento for HelpNavigator.TableOfContents, HelpNavigator.Index, ou HelpNavigator.Find, este valor deve ser uma cadeia vazia ("", ou String.Empty). Se o argumento command fizer referência HelpNavigator.Topica , HelpNavigator.TopicId, HelpNavigator.KeywordIndex, ou HelpNavigator.AssociateIndex, este valor deve ser uma cadeia que contenha o nome do tópico, ou a palavra-chave ou identificador numérico do tópico a mostrar.

Ver também

• ShowHelpIndex(Control, String)