Help.ShowHelp Método

Referencia

Definición

Espacio de nombres:: System.Windows.Forms

Ensamblado:: System.Windows.Forms.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Muestra el contenido de un archivo de Ayuda.

Sobrecargas

ShowHelp(Control, String)	Muestra el contenido del archivo de Ayuda en la dirección URL especificada.
ShowHelp(Control, String, String)	Muestra el contenido del archivo de Ayuda correspondiente a una palabra clave concreta que se encuentra en la dirección URL especificada.
ShowHelp(Control, String, HelpNavigator)	Muestra el contenido del archivo de Ayuda correspondiente a un tema concreto que se encuentra en la dirección URL especificada.
ShowHelp(Control, String, HelpNavigator, Object)	Muestra el contenido del archivo de Ayuda ubicado en la dirección URL proporcionada por el usuario.

ShowHelp(Control, String)

Muestra el contenido del archivo de Ayuda en la dirección 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

Control que identifica el elemento primario del cuadro de diálogo de Ayuda.

url: String

Ruta de acceso y nombre del archivo de Ayuda.

Ejemplos

En el ejemplo de código siguiente se muestra el ShowHelp método . Para ejecutar este ejemplo, pegue el código siguiente en un formulario que contenga un botón denominado 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

Comentarios

El url argumento puede tener el formato C:\path\sample.chm o /folder/file.htm. Para obtener información sobre el formato de las rutas de acceso, consulte Formatos de ruta de acceso de archivo en sistemas Windows.

Consulte también

ShowHelpIndex(Control, String)

Se aplica a

ShowHelp(Control, String, String)

Muestra el contenido del archivo de Ayuda correspondiente a una palabra clave concreta que se encuentra en la dirección URL especificada.

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

Control que identifica el elemento primario del cuadro de diálogo de Ayuda.

url: String

Ruta de acceso y nombre del archivo de Ayuda.

keyword: String

Palabra clave para la que se va a mostrar Ayuda.

Ejemplos

En el ejemplo de código siguiente se muestra un formulario con tres botones que se pueden usar para interactuar con el archivo de ayuda mspaint.chm. El botón Mostrar índice de ayuda muestra la pestaña Índice del archivo de Ayuda. El botón Mostrar ayuda muestra contenido en el archivo de Ayuda en función del valor seleccionado en la lista Navegador de ayuda . El botón Mostrar palabra clave muestra contenido en el archivo de Ayuda en función de la palabra clave especificada en el cuadro de texto Palabra clave .

Por ejemplo, para mostrar la página De ayuda ovaladas por el valor de índice, seleccione el HelpNavigator.KeywordIndex valor en la lista desplegable Navegador de ayuda , escriba ovales en el cuadro de texto Parámetro y, a continuación, haga clic en el botón Mostrar ayuda . Para mostrar el tema de ayuda "Para pintar con un pincel" por la palabra clave, escriba mspaint.chm::/paint_brush.htm en el cuadro de texto Palabra clave y, a continuación, haga clic en el botón Mostrar palabra clave .

En este ejemplo solo se muestra la llamada al ShowHelp método . Consulte la información general de la Help clase para obtener el ejemplo 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

Comentarios

Si keyword es null, se mostrará la tabla de contenido del archivo de Ayuda.

Consulte también

ShowHelpIndex(Control, String)

Se aplica a

ShowHelp(Control, String, HelpNavigator)

Muestra el contenido del archivo de Ayuda correspondiente a un tema concreto que se encuentra en la dirección URL especificada.

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

Control que identifica el elemento primario del cuadro de diálogo de Ayuda.

url: String

Ruta de acceso y nombre del archivo de Ayuda.

navigator: HelpNavigator

Uno de los valores de HelpNavigator.

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar el ShowHelp método para abrir un archivo de Ayuda en su página de índice. Para ejecutar este ejemplo, pegue el código siguiente en un formulario que contenga un botón denominado 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

Comentarios

Los archivos de Ayuda compilados proporcionan vínculos de tabla de contenido, índice, búsqueda y palabra clave en páginas. Puede usar los valores siguientes para el navigator argumento : HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexo HelpNavigator.Topic.

Consulte también

ShowHelpIndex(Control, String)

Se aplica a

ShowHelp(Control, String, HelpNavigator, Object)

Muestra el contenido del archivo de Ayuda ubicado en la dirección URL proporcionada por el usuario.

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

Control que identifica el elemento primario del cuadro de diálogo de Ayuda.

url: String

Ruta de acceso y nombre del archivo de Ayuda.

command: HelpNavigator

Uno de los valores de HelpNavigator.

paramparameter: Object

Cadena que contiene el identificador del tema.

Excepciones

ArgumentException

parameter es un entero.

Ejemplos

En este ejemplo solo se muestra la llamada al ShowHelp método . Consulte la información general de la Help clase para obtener el ejemplo 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

Comentarios

Los archivos de Ayuda compilados proporcionan vínculos de tabla de contenido, índice, búsqueda y palabra clave en páginas. Puede usar el parameter argumento para proporcionar un refinamiento adicional del HelpNavigator.Topiccomando , HelpNavigator.TopicId, HelpNavigator.KeywordIndexo HelpNavigator.AssociateIndex . Si el valor especificado en el command argumento es HelpNavigator.TableOfContents, HelpNavigator.Indexo HelpNavigator.Find, este valor debe ser una cadena vacía ("" o String.Empty). Si el command argumento hace referencia a HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndexo HelpNavigator.AssociateIndex, este valor debe ser una cadena que contenga el nombre del tema, o la palabra clave o el identificador numérico del tema que se va a mostrar.

Consulte también

ShowHelpIndex(Control, String)

Se aplica a

Help.ShowHelp Método

Definición

Sobrecargas

ShowHelp(Control, String)

Parámetros

Ejemplos

Comentarios

Consulte también

Se aplica a

ShowHelp(Control, String, String)

Parámetros

Ejemplos

Comentarios

Consulte también

Se aplica a

ShowHelp(Control, String, HelpNavigator)

Parámetros

Ejemplos

Comentarios

Consulte también

Se aplica a

ShowHelp(Control, String, HelpNavigator, Object)

Parámetros

Excepciones

Ejemplos

Comentarios

Consulte también

Se aplica a

Comentarios

Recursos adicionales