28. Asociar Ayuda en VB.

NET

DEG

Asociar Ayuda en VB .NET

1.- Asistencia para una aplicacin
Un aspecto esencial de la generacin de aplicaciones para Windows, que a menudo se pasa por alto, es el sistema de Ayuda, al que recurren los usuarios en momentos de confusin. Los formularios Windows Forms admiten dos tipos de Ayuda distintos, cada uno de ellos ofrecido a travs del componente HelProvider. El primero implica indicar al usuario un archivo de Ayuda de formato HTML o HTMLHelp 1.x o superior. El segundo puede mostrar Ayuda breve de tipo "Qu es esto?" sobre controles individuales que resulta especialmente til en los cuadros de dilogo. Cada uno de estos tipos de Ayuda tiene sus puntos fuertes y sus puntos dbiles, y es posible utilizar ambos en un mismo formulario. Finalmente, el componente ToolTip se puede utilizar para proporcionar Ayuda individual para los controles de los formularios Windows Forms.

2.- Proporcionar ayuda en una aplicacin para Windows.

Mediante el uso del componente HelpProvider pueden asociar temas de Ayuda de un archivo de Ayuda (en formato HTML o HTMLHelp 1.x o superior) a controles especficos en formularios Windows Forms. Para proporcionar Ayuda

Establecer propiedades al control HelpProvider. 1. El archivo (.chm) se copiar en la misma carpeta donde est el archivo (*.exe).

2. Arrastrar un componente HelpProvider al formulario desde el cuadro de herramientas.

Se alojar en la bandeja que se encuentra en la parte inferior del Diseador de formularios Windows Forms.

Dpto. Informtica

M Luz Snchez Rubio

28. Asociar Ayuda en VB. NET

DEG

3. En la ventana Propiedades, establezca la propiedad HelpNamespace archivo de Ayuda

.chm.

Establecer propiedades a un control para visualizar la Ayuda.

Vamos a establecer las propiedades al formulario para que al pulsar F1, se visualice el archivo pagina1.htm.

1. Establecer la propiedad ShowHelp a True, para poder mostrar el archivo de ayuda. 2. Seleccione el control (en nuestro caso ser el formulario) y establezca la propiedad
HelpKeyword en la ventana Propiedades con el valor pagina1.htm. Esta es la cadena que se pasa al archivo de Ayuda a travs del componente HelpProvider para abrir el tema de Ayuda apropiado.

3. En la ventana Propiedades, establezca la propiedad HelpNavigator un valor de la

enumeracin HelpNavigator. En nuestro ejemplo se seleccionar Topic, ya que en la propiedad HelpKeyword hemos asignado una pgina a visualizar. Esto determina de qu forma se pasa la propiedad HelpKeyword al sistema de Ayuda. A continuacin se muestra una tabla de posibles configuraciones y sus descripciones.

Nombre de miembro AssociateIndex Find Index KeywordIndex

Descripcin El archivo de ayuda se abre en la entrada de ndice por la primera letra de un tema especificado. El archivo de ayuda se abre en la pgina de bsqueda. El archivo de ayuda se abre en el ndice. El archivo de ayuda se abre en el tema con la entrada de ndice especificada, si existe alguna; en caso contrario, se muestra la entrada de ndice ms prxima a la palabra clave especificada. El archivo de ayuda se abre en la tabla de contenido. El archivo de ayuda se abre en un tema especificado, si existe. El archivo de ayuda se abre en un tema indicado por un identificador numrico del tema.

TableOfContents Topic TopicId

En tiempo de ejecucin, si se presiona F1 cuando el control (del que se han establecido las propiedades HelpKeyword y HelpNavigator) tiene el foco, se abrir el archivo de Ayuda asociado con ese componente HelpProvider.

Dpto. Informtica

M Luz Snchez Rubio

28. Asociar Ayuda en VB. NET

DEG

3.- Mostrar ayuda emergente.

Una de las formas de mostrar Ayuda en formularios Windows Forms es mediante el botn Ayuda, ubicado en el lado derecho de la barra de ttulo, al que se puede obtener acceso mediante la propiedad HelpButton. La presentacin de Ayuda por este medio resulta adecuada para utilizarla con cuadros de dilogo. En primer lugar, los cuadros de dilogo mostrados de forma modal (con el mtodo ShowDialog) tiene problemas para abrir sistemas de Ayuda externos, ya que los cuadros de dilogo modales deben cerrarse antes de poder pasar el foco a otra ventana. Adems, el uso del botn Ayuda requiere que no se muestren en la barra de ttulo los botones Minimizar y Maximizar. Se trata de una convencin estndar para cuadros de dilogo, mientras que los formularios suelen tener los botones Minimizar y Maximizar.

Tenga presente que tambin se puede utilizar el componente HelpProvider para enlazar controles en un sistema de Ayuda, incluso si se ha implementado Ayuda emergente. Para obtener ms informacin Para mostrar ayuda emergente

1. Seleccione el control para el que desea mostrar ayuda en el formulario, y establezca la propiedad
HelpString en la ventana Propiedades. Esta es la cadena de texto que se mostrar en una ventana similar a una ToolTip.

2. Presione F5. 3. Pulse el botn de Ayuda de la barra de ttulo, y haga clic en el control cuya propiedad HelpString
se ha establecido.

Dpto. Informtica

M Luz Snchez Rubio

28. Asociar Ayuda en VB. NET

DEG

4.- Controlar la ayuda mediante informacin sobre herramientas.

El componente ToolTip puede utilizar para mostrar un mensaje de Ayuda breve y especializado para los controles individuales de los formularios Windows Forms. El componente ToolTip incorpora una propiedad que especifica el texto que se muestra para cada uno de los controles del formulario. Para obtener ms informacin sobre cmo trabajar as con el componente ToolTip.

5.- Crear la ayuda mediante cdigo

En el siguiente ejemplo la ayuda se va asociar mediante cdigo y el objeto HelpProvider se crear tambin en ejecucin. Para mostrar la ayuda mediante un botn se utilizar la clase Help, mediante los mtodos ShowHelp y ShowHelpIndex:

El cdigo ser: Public Class Form1 'Crear el objeto HelpProvider Private oAyuda As New HelpProvider Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load 'Asociar a la propiedad HelpNamespace el archivo de ayuda oAyuda.HelpNamespace = "Ayuda1.chm" 'Indicar al formulario que se va ha mostrar la ayuda al pulsar F1. oAyuda.SetShowHelp(Me, True)

Dpto. Informtica

M Luz Snchez Rubio

28. Asociar Ayuda en VB. NET

DEG

'Mostrar el icono para la ayuda emergente Me.HelpButton = True Me.MaximizeBox = False Me.MinimizeBox = False 'especificar a las dos cajas de texto la ayuda emergente que se va a visualizar oAyuda.SetHelpString(txtCodigo, "Introducir el cdigo") oAyuda.SetHelpString(txtFecha, "formato (dd/mm/yy)") 'especificar a los controles de cajas de texto, que al pulsar F1, se mostrar una pgina Web de las especificadas en el archivo .chm oAyuda.SetHelpNavigator(txtCodigo, HelpNavigator.Topic) oAyuda.SetHelpKeyword(txtCodigo, "Pagina2.htm") oAyuda.SetHelpNavigator(txtFecha, HelpNavigator.Topic) oAyuda.SetHelpKeyword(txtFecha, "Pagina3.htm") End Sub Private Sub mnuContenido_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles mnuContenido.Click Help.ShowHelp(Me, oAyuda.HelpNamespace) End Sub Private Sub mnuIndice_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles mnuIndice.Click Help.ShowHelpIndex(Me, oAyuda.HelpNamespace) End Sub Private Sub mnuBuscar_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles mnuBuscar.Click Help.ShowHelp(Me, oAyuda.HelpNamespace, HelpNavigator.Find, "") End Sub

Dpto. Informtica

M Luz Snchez Rubio