Compartir a través de

Procedimiento para proporcionar ayuda en una aplicación Windows

  • Artículo

Puede usar el componente HelpProvider para asociar los temas de la ayuda de un archivo de la ayuda a controles específicos en Windows Forms. El archivo de ayuda puede ser HTML, HTMLHelp 1.x o superior.

Cómo proporcionar ayuda

  1. En Visual Studio, desde el Cuadro de herramientas, arrastre un componente HelpProvider al formulario.

    El componente estará en la bandeja, en la parte inferior del Diseñador de Windows Forms.

  2. En la ventana Propiedades, establezca la propiedad HelpNamespace en el archivo de ayuda .chm, .col o .htm.

  3. Seleccione otro control que tenga en el formulario y, en la ventana Propiedades, establezca la propiedad SetHelpKeyword.

    Esta es la cadena que se ha pasado mediante el componente HelpProvider al archivo de ayuda para invocar el tema de ayuda adecuado.

  4. En la ventana Propiedades, establezca la propiedad SetHelpNavigator en un valor de la enumeración HelpNavigator.

    Esto determina la forma en la que la propiedad HelpKeyword pasa al sistema de ayuda. La siguiente tabla muestra los valores posibles y sus descripciones.

    Nombre de miembro Descripción
    AssociateIndex Especifica que el índice de un tema determinado se realiza en la dirección URL especificada.
    Buscar Especifica que se muestre la página de búsqueda de una dirección URL especificada.
    Índice Especifica que se muestre el índice de una dirección URL especificada.
    KeywordIndex Especifica una palabra clave que buscar y la acción que se realizará en la dirección URL especificada.
    TableOfContents Especifica que se muestra la tabla de contenidos del archivo de ayuda HTML 1.0.
    Tema Especifica que se muestra el tema al que hace referencia la dirección URL especificada.

En tiempo de ejecución, al presionar F1 cuando el control para el que haya establecido las propiedades HelpKeyword y HelpNavigator tenga foco, se abrirá el archivo de ayuda asociado con ese componente HelpProvider.

Actualmente, la propiedad HelpNamespace admite archivos de ayuda en los tres formatos siguientes: HTMLHelp 1.x, HTMLHelp 2.0 y HTML. Por lo tanto, puede establecer la propiedad HelpNamespace en una dirección http://, como una página web. Si esto sucede, se abrirá el explorador predeterminado en la página web con la cadena especificada en la propiedad HelpKeyword utilizada como delimitador. El delimitador se utiliza para saltar a una parte específica de una página HTML.

Importante

Tenga cuidado de comprobar cualquier información que se envíe desde un cliente antes de utilizarla en su aplicación. Los usuarios malintencionados podrían intentar enviar o inyectar scripts ejecutables, instrucciones SQL u otro código. Antes de mostrar la entrada del usuario, almacénela en una base de datos o trabaje con ella, y compruebe que no contiene información potencialmente insegura. Una forma habitual de comprobación es utilizar una expresión regular para buscar palabras clave como "SCRIPT" cuando se recibe la entrada de un usuario.

También puede usar el componente HelpProvider para mostrar la ayuda emergente, aunque se haya configurado para mostrar archivos de ayuda para los controles de Windows Forms. Para más información, consulte Cómo: Mostrar ayuda emergente.

Consulte también