Help.ShowHelpIndex(Control, String) Метод

Определение

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

public:
 static void ShowHelpIndex(System::Windows::Forms::Control ^ parent, System::String ^ url);
public static void ShowHelpIndex(System.Windows.Forms.Control parent, string url);
public static void ShowHelpIndex(System.Windows.Forms.Control? parent, string? url);
static member ShowHelpIndex : System.Windows.Forms.Control * string -> unit
Public Shared Sub ShowHelpIndex (parent As Control, url As String)

Параметры

parent
Control

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

url
String

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

Примеры

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

Например, чтобы отобразить страницу справки по овалам по значению индекса, выберите HelpNavigator.KeywordIndex значение в раскрывающемся списке Help Navigator , введите овалы в текстовом поле "Параметр " и нажмите кнопку "Показать справку ". Чтобы отобразить раздел справки "Нарисовать с помощью кисти" ключевого слова, введите mspaint.chm::/paint_brush.htm в текстовом поле "Ключевое слово", а затем нажмите кнопку "Показать ключевое слово ".

В этом примере показан только вызов ShowHelpIndex метода. Ознакомьтесь с общими сведениями о Help классе для полного примера кода.

private:
   void showIndex_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      
      // Display the index for the help file.
      Help::ShowHelpIndex( this, helpfile );
   }
private void showIndex_Click(object sender, System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
}
Private Sub showIndex_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showIndex.Click
    ' Display the index for the Help file.
    Help.ShowHelpIndex(Me, helpfile)
End Sub

Комментарии

Параметр url может иметь форму C:\path\sample.chm или /folder/file.htm.

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

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