Help.ShowHelp Метод

Определение

Отображает содержимое файла справки.Displays the contents of a Help file.

Перегрузки

ShowHelp(Control, String)

Отображает содержимое файла справки по заданному URL-адресу.Displays the contents of the Help file at the specified URL.

ShowHelp(Control, String, String)

Отображает содержимое файла справки, найденное по заданному URL-адресу, для заданного слова.Displays the contents of the Help file found at the specified URL for a specific keyword.

ShowHelp(Control, String, HelpNavigator)

Отображает содержимое файла справки, найденного по заданному URL-адресу, для заданного раздела.Displays the contents of the Help file found at the specified URL for a specific topic.

ShowHelp(Control, String, HelpNavigator, Object)

Отображает содержимое файла справки, находящегося по URL-адресу, заданному пользователем.Displays the contents of the Help file located at the URL supplied by the user.

ShowHelp(Control, String)

Отображает содержимое файла справки по заданному URL-адресу.Displays the contents of the Help file at the specified 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, определяющий родительский объект диалогового окна справки.A Control that identifies the parent of the Help dialog box.

url
String

Путь и имя файла справки.The path and name of the Help file.

Примеры

В следующем примере кода демонстрируется ShowHelp метод.The following code example demonstrates the ShowHelp method. Чтобы выполнить этот пример, вставьте следующий код в форму, содержащую кнопку с именем Button1 .To run this example, paste the following code into a form that contains a button named 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Аргумент может иметь вид к:\пас\сампле.ЧМ или /Фолдер/file.htm.The url argument can be of the form C:\path\sample.chm or /folder/file.htm. Сведения о формате путей см. в разделе форматы путей к файлам в системах Windows.For information on the format of paths, see File path formats on Windows systems.

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

Применяется к

ShowHelp(Control, String, String)

Отображает содержимое файла справки, найденное по заданному URL-адресу, для заданного слова.Displays the contents of the Help file found at the specified URL for a specific keyword.

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, определяющий родительский объект диалогового окна справки.A Control that identifies the parent of the Help dialog box.

url
String

Путь и имя файла справки.The path and name of the Help file.

keyword
String

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

Примеры

В следующем примере кода отображается форма с тремя кнопками, которые можно использовать для взаимодействия с файлом справки Mspaint. chm.The following code example displays a form with three buttons that can be used to interact with the mspaint.chm Help file. Кнопка Показать указатель справки отображает вкладку индекс файла справки.The Show Help Index button displays the Index tab for the Help file. Кнопка Показать справку отображает содержимое файла справки в зависимости от значения, выбранного в списке справки .The Show Help button displays content in the Help file based on the value that is selected in the Help Navigator list. Кнопка Показать ключевое слово отображает содержимое файла справки на основе ключевого слова, указанного в текстовом поле ключевое слово .The Show Keyword button displays content in the Help file based on the keyword that is specified in the Keyword text box.

Например, чтобы отобразить страницу справки «овалы» по значению индекса, выберите HelpNavigator.KeywordIndex значение в раскрывающемся списке « Справка », введите « овалы » в текстовом поле « параметр », а затем нажмите кнопку « отображать справку ».For example, to show the Ovals Help page by the index value, select the HelpNavigator.KeywordIndex value in the Help Navigator drop-down list, type ovals in the Parameter text box, and then click the Show Help button. Чтобы отобразить раздел справки "Рисование с помощью кисти" по ключевому слову, введите Mspaint. chm::/paint_brush.htm в текстовом поле ключевое слово , а затем нажмите кнопку " Показывать ключевое слово ".To show the "To paint with a brush" Help topic by the keyword, type mspaint.chm::/paint_brush.htm in the Keyword text box, and then click the Show Keyword button.

В этом примере показан только вызов ShowHelp метода.This example shows only the call to the ShowHelp method. HelpПолный пример кода см. в обзоре класса.See the Help class overview for the complete code example.

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Аргумент может иметь вид к:\пас\сампле.ЧМ или /Фолдер/file.htm.The url argument can be of the form C:\path\sample.chm or /folder/file.htm. Сведения о формате путей см. в разделе форматы путей к файлам в системах Windows.For information on the format of paths, see File path formats on Windows systems.

Если keyword параметр имеет значение null , будет отображаться оглавление файла справки.If keyword is null, the table of contents for the Help file will be displayed.

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

Применяется к

ShowHelp(Control, String, HelpNavigator)

Отображает содержимое файла справки, найденного по заданному URL-адресу, для заданного раздела.Displays the contents of the Help file found at the specified URL for a specific topic.

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, определяющий родительский объект диалогового окна справки.A Control that identifies the parent of the Help dialog box.

url
String

Путь и имя файла справки.The path and name of the Help file.

navigator
HelpNavigator

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

Примеры

В следующем примере кода показано, как использовать ShowHelp метод, чтобы открыть файл справки на странице индекса.The following code example demonstrates how to use the ShowHelp method to open a Help file to its index page. Чтобы выполнить этот пример, вставьте следующий код в форму, содержащую кнопку с именем Button2 .To run this example, paste the following code into a form that contains a button named 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Аргумент может иметь вид к:\пас\сампле.ЧМ или /Фолдер/file.htm.The url argument can be of the form C:\path\sample.chm or /folder/file.htm. Сведения о формате путей см. в разделе форматы путей к файлам в системах Windows.For information on the format of paths, see File path formats on Windows systems.

Скомпилированные файлы справки содержат оглавление, индекс, Поиск и ссылки на ключевые слова на страницах.Compiled Help files provide table of contents, index, search, and keyword links in pages. Для аргумента можно использовать следующие значения navigator : HelpNavigator.TableOfContents , HelpNavigator.Find , HelpNavigator.Index или HelpNavigator.Topic .You can use the following values for the navigator argument: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Index, or HelpNavigator.Topic.

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

Применяется к

ShowHelp(Control, String, HelpNavigator, Object)

Отображает содержимое файла справки, находящегося по URL-адресу, заданному пользователем.Displays the contents of the Help file located at the URL supplied by the user.

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, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::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 param);
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, parameter As Object)
Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, param As Object)

Параметры

parent
Control

Объект Control, определяющий родительский объект диалогового окна справки.A Control that identifies the parent of the Help dialog box.

url
String

Путь и имя файла справки.The path and name of the Help file.

command
HelpNavigator

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

parameterparam
Object

Строка, содержащая идентификатор раздела.A string that contains the topic identifier.

Исключения

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

Примеры

В следующем примере кода отображается форма с тремя кнопками, которые можно использовать для взаимодействия с файлом справки Mspaint. chm.The following code example displays a form with three buttons that can be used to interact with the mspaint.chm Help file. Кнопка Показать указатель справки отображает вкладку индекс файла справки.The Show Help Index button displays the Index tab for the Help file. Кнопка Показать справку отображает содержимое файла справки в зависимости от значения, выбранного в списке справки .The Show Help button displays content in the Help file based on the value that is selected in the Help Navigator list. Кнопка Показать ключевое слово отображает содержимое файла справки на основе ключевого слова, указанного в текстовом поле ключевое слово .The Show Keyword button displays content in the Help file based on the keyword that is specified in the Keyword text box.

Например, чтобы отобразить страницу справки «овалы» по значению индекса, выберите HelpNavigator.KeywordIndex значение в раскрывающемся списке « Справка », введите « овалы » в текстовом поле « параметр », а затем нажмите кнопку « отображать справку ».For example, to show the Ovals Help page by the index value, select the HelpNavigator.KeywordIndex value in the Help Navigator drop-down list, type ovals in the Parameter text box, and then click the Show Help button. Чтобы отобразить раздел справки "Рисование с помощью кисти" по ключевому слову, введите Mspaint. chm::/paint_brush.htm в текстовом поле ключевое слово , а затем нажмите кнопку " Показывать ключевое слово ".To show the "To paint with a brush" Help topic by the keyword, type mspaint.chm::/paint_brush.htm in the Keyword text box, and then click the Show Keyword button.

В этом примере показан только вызов ShowHelp метода.This example shows only the call to the ShowHelp method. HelpПолный пример кода см. в обзоре класса.See the Help class overview for the complete code example.

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Аргумент может иметь вид к:\пас\сампле.ЧМ или /Фолдер/file.htm.The url argument can be of the form C:\path\sample.chm or /folder/file.htm. Сведения о формате путей см. в разделе форматы путей к файлам в системах Windows.For information on the format of paths, see File path formats on Windows systems.

Скомпилированные файлы справки содержат оглавление, индекс, Поиск и ссылки на ключевые слова на страницах.Compiled Help files provide table-of-contents, index, search, and keyword links in pages. Аргумент можно использовать parameter для дополнительного уточнения HelpNavigator.Topic HelpNavigator.TopicId команды,, HelpNavigator.KeywordIndex или HelpNavigator.AssociateIndex .You can use the parameter argument to provide additional refinement of the HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndex, or HelpNavigator.AssociateIndex command. Если значение, указанное в command аргументе HelpNavigator.TableOfContents , равно, HelpNavigator.Index или HelpNavigator.Find , это значение должно быть пустой строкой ("" или String.Empty ).If the value specified in the command argument is HelpNavigator.TableOfContents, HelpNavigator.Index, or HelpNavigator.Find, this value should be an empty string ("", or String.Empty). Если command аргумент ссылается на HelpNavigator.Topic , HelpNavigator.TopicId , HelpNavigator.KeywordIndex или HelpNavigator.AssociateIndex , это значение должно быть строкой, содержащей имя раздела, или ключевым словом или числовым идентификатором раздела для вывода.If the command argument references HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndex, or HelpNavigator.AssociateIndex, this value should be a string that contains the topic name, or the keyword or numeric identifier of the topic to display.

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

Применяется к