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

Определение

Отображает индекс заданного файла справки.Displays the index of the specified Help file.

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

url
String

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

Примеры

В следующем примере кода отображается форма с тремя кнопками, которые можно использовать для взаимодействия с файлом справки 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.

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

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Параметр может иметь вид к:\пас\сампле.ЧМ или/фолдер/file.htm.The url parameter can be of the form C:\path\sample.chm or /folder/file.htm.

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

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