Compatibilidad con la Ayuda para usuarios de Visual Basic 6.0

Artículo
10/07/2008

Actualización: noviembre 2007

En este tema se compara la compatibilidad de implementación de la Ayuda en Visual Basic 6.0 con su equivalente en Visual Basic 2008.

La mayoría de las aplicaciones proporcionan ayuda a los usuarios en el formulario de un archivo de Ayuda, Ayuda emergente y/o información sobre herramientas. Aunque Visual Basic 6.0 y Visual Basic 2008 admiten los tres mecanismos de Ayuda, los métodos de implementación difieren considerablemente.

Diferencias conceptuales

En Visual Basic 6.0, la ayuda se proporcionaba mediante la Ayuda HTML o los formatos antiguos de Ayuda de Windows. En Visual Basic 2008, sólo se admite la Ayuda HTML.

En Visual Basic 6.0, la compatibilidad de la ayuda se implementaba objeto a objeto especificando un nombre de archivo de Ayuda en el cuadro de dialogo Propiedades del proyecto. Los formularios y los controles tenían una propiedad HelpContextID que se podía utilizar para establecer un vínculo a un tema especifico del archivo de Ayuda.

La compatibilidad con la Ayuda en Visual Basic 2008 se implementa en cada formulario agregando uno o varios componentes HelpProvider a un formulario. Los formularios y los controles tienen las propiedades HelpKeyword y HelpNavigator, que se utilizaban para establecer vínculos a temas específicos. Para obtener más información, vea Cómo: Proporcionar ayuda en una aplicación para Windows.

Ayuda emergente

En Visual Basic 6.0, la Ayuda emergente se implementaba mediante las propiedades de formulario WhatsThisButton y WhatsThisHelp. El botón Qué es esto aparecía si el valor de WhatsThisButton era True y si el valor de las propiedades MaxButton y MinButton era False. Cuando se establecía en el código la propiedad WhatsThisMode se habilitaba el botón.

La Ayuda emergente en Visual Basic 2008 se implementa utilizando la propiedad HelpButton de un formulario. El botón Ayuda sólo aparece si la propiedad HelpButton se establece en True y si las propiedades MaximizeBox y MinimizeBox se establecen en False; el botón se habilita automáticamente. Para obtener más información, vea Cómo: Mostrar ayuda emergente.

Información sobre herramientas

En Visual Basic 6,0, la información sobre herramientas se implementaba mediante la propiedad ToolTipText de un control.

La información sobre herramientas en Visual Basic 2008 se implementa agregando un componente ToolTip a un formulario. Para obtener más información, vea Compatibilidad de la información sobre herramientas para usuarios de Visual Basic 6.0.

ShowHelp (Método)

En Visual Basic 6.0, la Ayuda también podía mostrarse utilizando un método ShowHelp de un control CommonDialog para abrir la Ayuda de Windows. La Ayuda de Windows ya no se admite en Visual Basic 2008 y no hay ningún control equivalente para mostrar Ayuda.

Cambios de código para la compatibilidad con la Ayuda

En el código siguiente se muestran las diferencias entre las técnicas de codificación de Visual Basic 6.0 y Visual Basic 2008 para algunos usos habituales de las propiedades de Ayuda.

Especificar un archivo de Ayuda

En el ejemplo siguiente se muestra cómo se especifica un archivo de Ayuda en la aplicación; en el ejemplo se presupone que el formulario tiene dos controles OptionButton que permiten que el usuario elija entre los archivos de Ayuda para inglés o francés.

' Visual Basic 6.0

If Option1(0).Value = True Then

App.HelpFile = App.Path & "\EnglishHelp.chm"

Else

App.HelpFile = App.Path & "\FrenchHelp.chm"

End If

' Visual Basic
' Assumes a HelpProvider component has been added to the form.
If RadioButton1.Checked = True Then
    HelpProvider1.HelpNamespace = My.Application.Info.DirectoryPath & _
        "\EnglishHelp.chm"
Else
    HelpProvider1.HelpNamespace = My.Application.Info.DirectoryPath & _
        "\FrenchHelp.chm"
End If

Mostrar una información sobre herramientas

A continuación se incluye el código necesario para mostrar una información sobre herramientas.

' Visual Basic 6.0

Private Sub Text1_Change()

Text1.ToolTipText = "The text has changed"

End Sub

' Visual Basic
' Assumes a ToolTip component has been added to the form.
Private Sub TextBox1_TextChanged(ByVal sender As System.Object, _
ByVal e As System.EventArgs) Handles TextBox1.TextChanged
    ToolTip1.SetToolTip(TextBox1, "The text has changed")
End Sub

Equivalencias de la compatibilidad de la Ayuda

Visual Basic 6.0	Visual Basic 2008
Propiedad App.HelpFile	Componente HelpProvider
Propiedad HelpContextID	Método SetHelpKeyword. Para obtener más información, vea Cómo: Proporcionar ayuda en una aplicación para Windows.
Propiedad ToolTipText	Método SetToolTip. Para obtener más información, vea Compatibilidad de la información sobre herramientas para usuarios de Visual Basic 6.0.
Propiedad WhatsThisButton	Propiedad HelpButton
Propiedad WhatsThisHelp	Propiedad HelpButton
Propiedad WhatsThisHelpID	Propiedad HelpString
Propiedad WhatsThisMode	No hay equivalente. Se habilita de manera predeterminada.

Notas de actualización

Cuando un proyecto de Visual Basic 6.0 se actualiza con el Asistente para actualización en Visual Basic 2008, no se actualizará ningún código o propiedad relacionados con la Ayuda. Deberá implementar de nuevo la compatibilidad con la Ayuda en la aplicación después de la actualización. Si el archivo de Ayuda se ha escrito utilizando la Ayuda HTML, puede reutilizar este archivo; si se ha escrito utilizando la Ayuda de Windows, deberá escribirlo de nuevo.

Vea también