Compartir a través de

Información general sobre el componente HelpProvider (formularios Windows Forms)

  • Artículo

El componente HelpProvider de Windows Forms se utiliza para asociar un archivo de Ayuda HTML Help 1.x (ya sea un archivo .chm generado con HTML Help Workshop o un archivo .htm) con una aplicación basada en Windows. Puede proporcionar ayuda de varias maneras:

  • Ayuda contextual para controles de Windows Forms.

  • Ayuda contextual sobre un cuadro de diálogo determinado o controles específicos de un cuadro de diálogo.

  • Abrir un archivo de Ayuda en áreas específicas, como la página principal de una tabla de contenido, el índice o una función de búsqueda.

Uso de Help Provider

Agregar un componente HelpProvider al formulario de Windows Forms permite que los demás controles del formulario expongan las propiedades de Ayuda del componente HelpProvider. Esto le permite proporcionar ayuda para los controles del formulario de Windows Forms. Puede asociar un archivo de Ayuda al componente HelpProvider mediante la propiedad HelpNamespace. Para especificar el tipo de Ayuda proporcionado, llame a SetHelpNavigator y proporcione un valor de la enumeración HelpNavigator para el control especificado. Proporcione la palabra clave o el tema de Ayuda mediante la llamada al método SetHelpKeyword.

Opcionalmente, para asociar una cadena de Ayuda específica con otro control, use el método SetHelpString. La cadena que se asocia a un control mediante este método se muestra en una ventana emergente cuando el usuario presiona la tecla F1 mientras el control tiene el foco.

Si HelpNamespace no se ha establecido, debe usar SetHelpString para proporcionar el texto de Ayuda. Si ha establecido HelpNamespace y la cadena de Ayuda, tendrá prioridad la Ayuda basada en HelpNamespace.

Nota:

Es posible que encuentre problemas al usar la ruta de acceso relativa al especificar la ruta de acceso al archivo de Ayuda en el método ShowHelp o la propiedad HelpNamespace del control HelpProvider. Por lo tanto, asegúrese de usar la ruta de acceso absoluta del archivo para especificar el archivo de Ayuda.

Consulte también