Help.ShowHelp Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Отображает содержимое файла справки.
Перегрузки
| Имя | Описание |
|---|---|
| ShowHelp(Control, String) |
Отображает содержимое файла справки по указанному URL-адресу. |
| ShowHelp(Control, String, String) |
Отображает содержимое файла справки, найденного по указанному URL-адресу для определенного ключевого слова. |
| ShowHelp(Control, String, HelpNavigator) |
Отображает содержимое файла справки, найденного по указанному URL-адресу для определенного раздела. |
| ShowHelp(Control, String, HelpNavigator, Object) |
Отображает содержимое файла справки, расположенного по URL-адресу, предоставленному пользователем. |
ShowHelp(Control, String)
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
Отображает содержимое файла справки по указанному URL-адресу.
public:
static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url);
public static void ShowHelp(System.Windows.Forms.Control parent, string url);
public static void ShowHelp(System.Windows.Forms.Control? parent, string? url);
static member ShowHelp : System.Windows.Forms.Control * string -> unit
Public Shared Sub ShowHelp (parent As Control, url As String)
Параметры
- url
- String
Путь и имя файла справки.
Примеры
В следующем примере кода демонстрируется ShowHelp метод. Чтобы запустить этот пример, вставьте следующий код в форму, содержащую кнопку с именем Button1.
// Open the Help file for the Character Map topic.
void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
Help::ShowHelp( TextBox1, "file://c:\\charmap.chm" );
}
// Open the Help file for the Character Map topic.
private void Button1_Click(System.Object sender, System.EventArgs e)
{
Help.ShowHelp(TextBox1, "file://c:\\charmap.chm");
}
' Open the Help file for the Character Map topic.
Private Sub Button1_Click(ByVal sender As System.Object, _
ByVal e As System.EventArgs) Handles Button1.Click
Help.ShowHelp(TextBox1, "file://c:\charmap.chm")
End Sub
Комментарии
Аргумент url может иметь форму C:\path\sample.chm или /folder/file.htm. Сведения о формате путей см. в форматах пути File в системах Windows.
См. также раздел
Применяется к
ShowHelp(Control, String, String)
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
Отображает содержимое файла справки, найденного по указанному URL-адресу для определенного ключевого слова.
public:
static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::String ^ keyword);
public static void ShowHelp(System.Windows.Forms.Control parent, string url, string keyword);
public static void ShowHelp(System.Windows.Forms.Control? parent, string? url, string? keyword);
static member ShowHelp : System.Windows.Forms.Control * string * string -> unit
Public Shared Sub ShowHelp (parent As Control, url As String, keyword As String)
Параметры
- url
- String
Путь и имя файла справки.
- keyword
- String
Ключевое слово для отображения справки.
Примеры
В следующем примере кода отображается форма с тремя кнопками, которые можно использовать для взаимодействия с файлом справки mspaint.chm. Кнопка "Показать индекс справки " отображает вкладку "Индекс" для файла справки. Кнопка "Показать справку" отображает содержимое в файле справки на основе значения, выбранного в списке справки. Кнопка "Показать ключевое слово " отображает содержимое в файле справки на основе ключевого слова, указанного в текстовом поле "Ключевое слово".
Например, чтобы отобразить страницу справки по овалам по значению индекса, выберите HelpNavigator.KeywordIndex значение в раскрывающемся списке Help Navigator , введите овалы в текстовом поле "Параметр " и нажмите кнопку "Показать справку ". Чтобы отобразить раздел справки "Нарисовать с помощью кисти" ключевого слова, введите mspaint.chm::/paint_brush.htm в текстовом поле "Ключевое слово", а затем нажмите кнопку "Показать ключевое слово ".
В этом примере показан только вызов ShowHelp метода. Ознакомьтесь с общими сведениями о Help классе для полного примера кода.
void showKeyword_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
// Display help using the provided keyword.
Help::ShowHelp( this, helpfile, keyword->Text );
}
private void showKeyword_Click(object sender, System.EventArgs e)
{
// Display help using the provided keyword.
Help.ShowHelp(this, helpfile, keyword.Text);
}
Private Sub showKeyword_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showKeyword.Click
' Display Help using the provided keyword.
Help.ShowHelp(Me, helpfile, keyword.Text)
End Sub
Комментарии
Аргумент url может иметь форму C:\path\sample.chm или /folder/file.htm. Сведения о формате путей см. в форматах пути File в системах Windows.
Если keyword это nullтак, будет отображаться оглавление файла справки.
См. также раздел
Применяется к
ShowHelp(Control, String, HelpNavigator)
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
Отображает содержимое файла справки, найденного по указанному URL-адресу для определенного раздела.
public:
static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator navigator);
public static void ShowHelp(System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator navigator);
public static void ShowHelp(System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator navigator);
static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator -> unit
Public Shared Sub ShowHelp (parent As Control, url As String, navigator As HelpNavigator)
Параметры
- url
- String
Путь и имя файла справки.
- navigator
- HelpNavigator
Одно из значений HelpNavigator .
Примеры
В следующем примере кода показано, как использовать ShowHelp метод для открытия файла справки на его страницу индекса. Чтобы запустить этот пример, вставьте следующий код в форму, содержащую кнопку с именем Button2.
// Open the Help file for the Character Map topic and
// display the Index page.
void Button2_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
Help::ShowHelp( TextBox1, "file://c:\\charmap.chm", HelpNavigator::Index );
}
// Open the Help file for the Character Map topic and
// display the Index page.
private void Button2_Click(System.Object sender, System.EventArgs e)
{
Help.ShowHelp(TextBox1, "file://c:\\charmap.chm",
HelpNavigator.Index);
}
' Open the Help file for the Character Map topic and
' display the Index page.
Private Sub Button2_Click(ByVal sender As System.Object, _
ByVal e As System.EventArgs) Handles Button2.Click
Help.ShowHelp(TextBox1, "file://c:\charmap.chm", HelpNavigator.Index)
End Sub
Комментарии
Аргумент url может иметь форму C:\path\sample.chm или /folder/file.htm. Сведения о формате путей см. в форматах пути File в системах Windows.
Скомпилированные файлы справки предоставляют ссылки на содержимое, индекс, поиск и ключевые слова на страницах. Для аргумента navigator можно использовать следующие значения: HelpNavigator.TableOfContents, , HelpNavigator.FindHelpNavigator.Indexили HelpNavigator.Topic.
См. также раздел
Применяется к
ShowHelp(Control, String, HelpNavigator, Object)
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
- Исходный код:
- Help.cs
Отображает содержимое файла справки, расположенного по URL-адресу, предоставленному пользователем.
public:
static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ param);
public:
static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ parameter);
public static void ShowHelp(System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator command, object param);
public static void ShowHelp(System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator command, object parameter);
public static void ShowHelp(System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator command, object? parameter);
static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator * obj -> unit
static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator * obj -> unit
Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, param As Object)
Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)
Параметры
- url
- String
Путь и имя файла справки.
- command
- HelpNavigator
Одно из значений HelpNavigator .
- paramparameter
- Object
Строка, содержащая идентификатор раздела.
Исключения
parameter — целое число.
Примеры
В следующем примере кода отображается форма с тремя кнопками, которые можно использовать для взаимодействия с файлом справки mspaint.chm. Кнопка "Показать индекс справки " отображает вкладку "Индекс" для файла справки. Кнопка "Показать справку" отображает содержимое в файле справки на основе значения, выбранного в списке справки. Кнопка "Показать ключевое слово " отображает содержимое в файле справки на основе ключевого слова, указанного в текстовом поле "Ключевое слово".
Например, чтобы отобразить страницу справки по овалам по значению индекса, выберите HelpNavigator.KeywordIndex значение в раскрывающемся списке Help Navigator , введите овалы в текстовом поле "Параметр " и нажмите кнопку "Показать справку ". Чтобы отобразить раздел справки "Нарисовать с помощью кисти" ключевого слова, введите mspaint.chm::/paint_brush.htm в текстовом поле "Ключевое слово", а затем нажмите кнопку "Показать ключевое слово ".
В этом примере показан только вызов ShowHelp метода. Ознакомьтесь с общими сведениями о Help классе для полного примера кода.
void showHelp_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
// Display Help using the Help navigator enumeration
// that is selected in the combo box. Some enumeration
// values make use of an extra parameter, which can
// be passed in through the Parameter text box.
HelpNavigator navigator = HelpNavigator::TableOfContents;
if ( navigatorCombo->SelectedItem != nullptr )
{
navigator = *safe_cast<HelpNavigator^>(navigatorCombo->SelectedItem);
}
Help::ShowHelp( this, helpfile, navigator, parameterTextBox->Text );
}
private void showHelp_Click(object sender, System.EventArgs e)
{
// Display Help using the Help navigator enumeration
// that is selected in the combo box. Some enumeration
// values make use of an extra parameter, which can
// be passed in through the Parameter text box.
HelpNavigator navigator = HelpNavigator.TableOfContents;
if (navigatorCombo.SelectedItem != null)
{
navigator = (HelpNavigator)navigatorCombo.SelectedItem;
}
Help.ShowHelp(this, helpfile, navigator, parameterTextBox.Text);
}
Private Sub showHelp_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showHelp.Click
' Display Help using the Help navigator enumeration
' that is selected in the combo box. Some enumeration
' values make use of an extra parameter, which can
' be passed in through the Parameter text box.
Dim navigator As HelpNavigator = HelpNavigator.TableOfContents
If (navigatorCombo.SelectedItem IsNot Nothing) Then
navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
End If
Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub
Комментарии
Аргумент url может иметь форму C:\path\sample.chm или /folder/file.htm. Сведения о формате путей см. в форматах пути File в системах Windows.
Скомпилированные файлы справки предоставляют ссылки на ключевые слова на страницах с оглавлением, индексом, поиском и ключевыми словами. Аргумент можно использовать parameter для предоставления дополнительного HelpNavigator.Topicуточнения команды , HelpNavigator.TopicIdHelpNavigator.KeywordIndexили HelpNavigator.AssociateIndex команды. Если значение, указанное в аргументеcommand, равно HelpNavigator.TableOfContentsилиHelpNavigator.IndexHelpNavigator.Find, это значение должно быть пустой строкой (", или String.Empty).
command Если аргумент ссылается HelpNavigator.Topic, HelpNavigator.TopicIdHelpNavigator.KeywordIndexили , это значение должно быть строкой, содержащей имя раздела, или HelpNavigator.AssociateIndexключевое слово или числовый идентификатор темы для отображения.