Prise en charge de l'aide pour les utilisateurs de Visual Basic 6.0

Article
08/21/2008

Mise à jour : novembre 2007

Cette rubrique compare la prise en charge de l'implémentation de l'aide dans Visual Basic 6.0 avec son équivalent dans Visual Basic 2008.

La plupart des applications fournissent une aide pour les utilisateurs dans le formulaire d'un fichier d'aide, dans l'aide contextuelle et / ou dans les info-bulles. Bien que Visual Basic 6.0 et Visual Basic 2008 prennent tous deux en charge les trois mécanismes d'aide, les méthodes d'implémentation de ces mécanismes diffèrent considérablement.

Différences conceptuelles

Dans Visual Basic 6.0, l'aide pouvait être fournie via l'aide HTML ou l'ancien format d'aide Windows. Dans Visual Basic 2008, seule l'aide HTML est prise en charge.

Dans Visual Basic 6.0, la prise en charge de l'aide était implémentée par projet. Pour cela, vous deviez spécifier un nom de fichier d'aide dans la boîte de dialogue Propriétés du projet. Chaque formulaire et chaque contrôle possédaient une propriété HelpContextID qui pouvait être utilisée pour créer un lien vers une rubrique spécifique du fichier d'aide.

La prise en charge de l'aide dans Visual Basic 2008 est implémentée par formulaire, en ajoutant un ou plusieurs composants HelpProvider à un formulaire. Chaque formulaire et chaque contrôle possèdent des propriétés HelpKeyword et HelpNavigator utilisées pour créer un lien vers une rubrique spécifique. Pour plus d'informations, consultez Comment : fournir de l'aide dans une application Windows.

Aide contextuelle

Dans Visual Basic 6.0, l'aide contextuelle était implémentée à l'aide des propriétés WhatsThisButton et WhatsThisHelp d'un formulaire. Le bouton Qu'est-ce que c'est apparaissait si WhatsThisButton était True et si les propriétés MaxButton et MinButton étaient toutes deux False. La définition de la propriété WhatsThisMode dans le code activait le bouton.

Dans Visual Basic 2008, l'aide contextuelle est implémentée à l'aide de la propriété HelpButton d'un formulaire. Le bouton Aide apparaît uniquement si la propriété HelpButton a la valeur True et si les propriétés MaximizeBox et MinimizeBox ont toutes deux la valeur False ; le bouton est activé automatiquement. Pour plus d'informations, consultez Comment : afficher l'aide contextuelle.

Info-bulles

Dans Visual Basic 6.0, les info-bulles étaient implémentées à l'aide de la propriété ToolTipText d'un contrôle.

Dans Visual Basic 2008, les info-bulles sont implémentées en ajoutant un composant ToolTip à un formulaire. Pour plus d'informations, consultez Prise en charge des info-bulles pour les utilisateurs de Visual Basic 6.0.

Méthode ShowHelp

Dans Visual Basic 6.0, l'aide pourrait également être affichée à l'aide d'une méthode ShowHelp d'un contrôle CommonDialog pour ouvrir l'aide Windows. L'aide Windows n'est plus prise en charge dans Visual Basic 2008 et il n'existe aucun contrôle équivalent pour afficher l'aide.

Modifications apportées au code de prise en charge de l'aide

Le code suivant illustre les différences dans les techniques de codage entre Visual Basic 6.0 et Visual Basic 2008 pour quelques exemples communs d'utilisation des propriétés d'aide.

Spécification d'un fichier d'aide

L'exemple suivant illustre comment spécifier un fichier d'aide pour votre application, en supposant que votre formulaire a deux contrôles OptionButton qui permettent à l'utilisateur de choisir entre les fichiers d'aide anglais et français.

' 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

Affichage d'une info-bulle

Les éléments suivants décrivent le code d'affichage d'une info-bulle.

' 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

Équivalences de prise en charge de l'aide

Visual Basic 6.0	Visual Basic 2008
Propriété App.HelpFile	Composant HelpProvider
Propriété HelpContextID	Méthode SetHelpKeyword. Pour plus d'informations, consultez Comment : fournir de l'aide dans une application Windows.
Propriété ToolTipText	Méthode SetToolTip. Pour plus d'informations, consultez Prise en charge des info-bulles pour les utilisateurs de Visual Basic 6.0.
Propriété WhatsThisButton	Propriété HelpButton
Propriété WhatsThisHelp	Propriété HelpButton
Propriété WhatsThisHelpID	Propriété HelpString
Propriété WhatsThisMode	Pas d'équivalent. Activé par défaut.

Mettre à niveau des remarques

Lorsqu'un projet Visual Basic 6.0 est mis à niveau à l'aide de l'Assistant Mise à niveau dans Visual Basic 2008, aucune propriété liée à l'aide ou au code n'est mise à niveau. Vous devez réimplémenter la prise en charge de l'aide de votre application après la mise à niveau. Si le fichier d'aide a été écrit via l'aide HTML, vous pouvez réutiliser le fichier d'aide ; s'il a été écrit via l'aide Windows, il devra être réécrit.

Voir aussi