Help.ShowHelp Метод

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Отображает содержимое файла справки.

Перегрузки

ShowHelp(Control, String)	Отображает содержимое файла справки по заданному URL-адресу.
ShowHelp(Control, String, String)	Отображает содержимое файла справки, найденное по заданному URL-адресу, для заданного слова.
ShowHelp(Control, String, HelpNavigator)	Отображает содержимое файла справки, найденного по заданному URL-адресу, для заданного раздела.
ShowHelp(Control, String, HelpNavigator, Object)	Отображает содержимое файла справки, находящегося по URL-адресу, заданному пользователем.

ShowHelp(Control, String)

Отображает содержимое файла справки по заданному URL-адресу.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::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)

Параметры

parent

Control

Объект Control, определяющий родительский объект диалогового окна справки.

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. Сведения о формате путей см. в разделе Форматы путей к файлам в системах Windows.

См. также раздел

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Отображает содержимое файла справки, найденное по заданному 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);

static member ShowHelp : System.Windows.Forms.Control * string * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, keyword As String)

Параметры

parent

Control

Объект Control, определяющий родительский объект диалогового окна справки.

url

String

Путь и имя файла справки.

keyword

String

Ключевое слово, для которого нужно отобразить справку.

Примеры

В следующем примере кода показана форма с тремя кнопками, которые можно использовать для взаимодействия с файлом справки mspaint.chm. Кнопка Показать индекс справки отображает вкладку Индекс для файла справки. Кнопка Показать справку отображает содержимое файла справки в зависимости от значения, выбранного в списке Навигатор справки . Кнопка Показать ключевое слово отображает содержимое в файле справки на основе ключевое слово, указанного в текстовом поле Ключевое слово.

Например, чтобы отобразить страницу справки ovals по значению индекса, выберите HelpNavigator.KeywordIndex значение в раскрывающемся списке Навигатор справки , введите овалы в текстовом поле Параметр и нажмите кнопку Показать справку . Чтобы отобразить раздел справки "Рисование кистью" ключевое слово, введите 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. Сведения о формате путей см. в разделе Форматы путей к файлам в системах Windows.

Если keyword имеет значение null, будет отображаться оглавление файла справки.

См. также раздел

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Отображает содержимое файла справки, найденного по заданному 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);

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)

Параметры

parent

Control

Объект Control, определяющий родительский объект диалогового окна справки.

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. Сведения о формате путей см. в разделе Форматы путей к файлам в системах Windows.

Скомпилированные файлы справки содержат оглавление, индекс, поиск и ключевое слово ссылки на страницах. Для аргумента navigator можно использовать следующие значения: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexили HelpNavigator.Topic.

См. также раздел

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Отображает содержимое файла справки, находящегося по URL-адресу, заданному пользователем.

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? parameter);

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, parameter As Object)

Параметры

parent

Control

Объект Control, определяющий родительский объект диалогового окна справки.

url

String

Путь и имя файла справки.

command

HelpNavigator

Одно из значений перечисления HelpNavigator.

parameter

Object

Строка, содержащая идентификатор раздела.

Исключения

ArgumentException

Параметр parameter является целочисленным значением.

Примеры

В следующем примере кода показана форма с тремя кнопками, которые можно использовать для взаимодействия с файлом справки mspaint.chm. Кнопка Показать индекс справки отображает вкладку Индекс для файла справки. Кнопка Показать справку отображает содержимое файла справки в зависимости от значения, выбранного в списке Навигатор справки . Кнопка Показать ключевое слово отображает содержимое в файле справки на основе ключевое слово, указанного в текстовом поле Ключевое слово.

Например, чтобы отобразить страницу справки ovals по значению индекса, выберите HelpNavigator.KeywordIndex значение в раскрывающемся списке Навигатор справки , введите овалы в текстовом поле Параметр и нажмите кнопку Показать справку . Чтобы отобразить раздел справки "Рисование кистью" ключевое слово, введите 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. Сведения о формате путей см. в разделе Форматы путей к файлам в системах Windows.

Скомпилированные файлы справки содержат ссылки на оглавление, индекс, поиск и ключевое слово на страницах. Аргумент можно использовать для parameter дополнительного HelpNavigator.Topicуточнения команды , HelpNavigator.TopicId, HelpNavigator.KeywordIndexили HelpNavigator.AssociateIndex . Если в аргументе commandHelpNavigator.TableOfContentsуказано значение , HelpNavigator.Indexили HelpNavigator.Find, это значение должно быть пустой строкой ("" или String.Empty). command Если аргумент ссылается на HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndexили HelpNavigator.AssociateIndex, это значение должно быть строкой, содержащей имя раздела, или ключевое слово или числовым идентификатором отображаемого раздела.

См. также раздел

• ShowHelpIndex(Control, String)