Поддержка справки (для пользователей Visual Basic 6.0)
Обновлен: Ноябрь 2007
В этом разделе сравнивается поддержка реализации справки в Visual Basic 6.0 с соответствующим эквивалентом в Visual Basic 2008.
В большинстве приложений справка предоставляется пользователям в форме файла справки, всплывающей справки и/или всплывающих подсказок. Хотя обе версии, Visual Basic 6.0 и Visual Basic 2008, поддерживают все три механизма справки, методы их реализации существенно отличаются.
Концептуальные различия
В Visual Basic 6.0 справка могла предоставляться как в формате справки HTML, так и в старом формате справки Windows. В Visual Basic 2008 поддерживается только справка HTML.
В Visual Basic 6.0 поддержка справки была реализована на уровне проекта путем задания имени файла справки в диалоговом окне Свойства проекта. Для каждой формы и элемента управления было предусмотрено свойство HelpContextID, которое могло использоваться для ссылки на определенный раздел файла справки.
В Visual Basic 2008 поддержка справки реализуется на уровне формы путем добавления к форме одного или нескольких компонентов HelpProvider. У каждой формы и элемента управления имеются свойства HelpKeyword и HelpNavigator, использовавшиеся для ссылки на определенный раздел справки. Дополнительные сведения см. в разделе Руководство: предоставление справки в приложении Windows.
Всплывающая справка
В Visual Basic 6.0 всплывающая справка была реализована с помощью свойств формы WhatsThisButton и WhatsThisHelp. Кнопка Что это такое появлялась, если свойство WhatsThisButton имело значение True, а оба свойства MaxButton и MinButton имели значение False. Эта кнопка включалась при задании свойства WhatsThisMode в коде программы.
Всплывающая справка в Visual Basic 2008 реализуется с помощью свойства HelpButton формы. Кнопка Справка появляется, только если свойство HelpButton имеет значение True, а оба свойства MaximizeBox и MinimizeBox имеют значение False; кнопка включается автоматически. Дополнительные сведения см. в разделе Практическое руководство. Отображение всплывающей справки.
Всплывающие подсказки
В Visual Basic 6.0 всплывающие подсказки были реализованы с помощью свойства ToolTipText элемента управления.
Всплывающие подсказки в Visual Basic 2008 реализуются путем добавления в форму компонента ToolTip. Дополнительные сведения см. в разделе Поддержка подсказок (для пользователей Visual Basic 6.0).
Метод ShowHelp
В Visual Basic 6.0 справка могла также отображаться с помощью метода ShowHelp элемента управления CommonDialog для открытия справки Windows. Справка Windows в Visual Basic 2008 больше не поддерживается, а также нет эквивалентного элемента управления для отображения справки.
Изменения кода для поддержки справки
Следующий пример кода иллюстрирует различия приемов кодирования между Visual Basic 6.0 и Visual Basic 2008 в некоторых распространенных случаях использования свойств справки.
Указание файла справки
В следующем примере демонстрируется, как указать файл справки для вашего приложения, если в форме есть два элемента управления OptionButton, позволяющих пользователю выбирать между английским и французским файлом справки.
' 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
Отображение всплывающей подсказки
Ниже приведен код, отображающий всплывающую подсказку.
' 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
Эквиваленты поддержки справки
Visual Basic 6.0 |
Visual Basic 2008 |
|---|---|
Свойство App.HelpFile |
Компонент HelpProvider |
Свойство HelpContextID |
Метод SetHelpKeyword. Дополнительные сведения см. в разделе Руководство: предоставление справки в приложении Windows. |
Свойство ToolTipText |
Метод SetToolTip. Дополнительные сведения см. в разделе Поддержка подсказок (для пользователей Visual Basic 6.0). |
Свойство WhatsThisButton |
Свойство HelpButton |
Свойство WhatsThisHelp |
Свойство HelpButton |
Свойство WhatsThisHelpID |
Свойство HelpString |
Свойство WhatsThisMode |
Эквивалента нет. По умолчанию включено. |
Замечания по обновлению
При обновлении проекта Visual Basic 6.0 с помощью мастера обновления в Visual Basic 2008 все связанные со справкой свойства и код не будут обновлены. Необходимо заново реализовать поддержку справки приложения после обновления. Если файл справки был написан с помощью HTML, то можно использовать этот файл; если файл был написан с помощью справки Windows, его необходимо переписать.
См. также
Задачи
Руководство: предоставление справки в приложении Windows
Практическое руководство. Отображение всплывающей справки
Основные понятия
Поддержка подсказок (для пользователей Visual Basic 6.0)