ユーザーが指定した URL に配置されているヘルプ ファイルの内容を表示します。
Overloads Public Shared Sub ShowHelp( _
ByVal parent As Control, _ ByVal url As String, _ ByVal command As HelpNavigator, _ ByVal param As Object _)
[C#]
public static void ShowHelp(Controlparent,stringurl,HelpNavigatorcommand,objectparam);
[C++]
public: static void ShowHelp(Control* parent,String* url,HelpNavigatorcommand,Object* param);
[JScript]
public static function ShowHelp(
parent : Control,url : String,command : HelpNavigator,param : Object);
パラメータ
- parent
[ヘルプ] ダイアログ ボックスの親を識別する Control 。 - url
ヘルプ ファイルのパスと名前。 - command
HelpNavigator 値の 1 つ。 - param
表示するトピックの数値 ID。
解説
コンパイル済みヘルプ ファイルでは、目次、索引、検索、ページ内のキーワードのリンクなどの各機能が利用できます。 command に対して、 TableOfContents 、 Find 、 Index 、または Topic の値が使用できます。
param を使用すると、 Topic コマンドをさらに細かく設定できます。 command パラメータで指定される値が TableOfContents 、 Index 、または Find の場合、この値は null 参照 (Visual Basic では Nothing) である必要があります。 command パラメータが Topic を参照している場合、この値は表示するトピックの数値を格納しているオブジェクトを参照します。
url パラメータは、C:\path\sample.chm または/folder/file.htm の形式で指定できます。
使用例
[Visual Basic, C#, C++] mspaint.chm ヘルプ ファイルと対話するための 3 つのボタンが配置されたフォームを表示する例を次に示します。 Show Help Index ボタンをクリックすると、ヘルプ ファイルの Index タブが表示されます。 Show Help ボタンをクリックすると、 Help Navigator リスト内で選択されている値に基づいて、ヘルプ ファイルの内容が表示されます。 Show Keyword ボタンをクリックすると、 Keyword ボックスで指定されているキーワードに基づいて、ヘルプ ファイルの内容が表示されます。
[Visual Basic, C#, C++] たとえば、インデックス値から楕円についてのヘルプ ページを表示するには、 Help Navigator ドロップダウン リストから HelpNavigator.KeywordIndex 値を選択し、 Parameter テキスト ボックスに「楕円」と入力し、 Show Help ボタンをクリックします。"ブラシで描くには" ヘルプ トピックをキーワードを指定して表示するには、 Keyword ボックスに「mspaint.chm::/paint_brush.htm」と入力し、 Show Keyword ボタンをクリックします。
[Visual Basic, C#, C++] ShowHelp の呼び出しの部分の例を次に示します。コード例全体については、 Help クラスの概要を参照してください。
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 Not (navigatorCombo.SelectedItem Is Nothing) Then
navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
End If
Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub 'showHelp_Click
[C#]
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);
}
[C++]
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 != 0) {
navigator = *__try_cast<__box HelpNavigator*>(navigatorCombo->SelectedItem);
}
Help::ShowHelp(this, helpfile, navigator, parameterTextBox->Text);
}
[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン .gif)
をクリックします。
必要条件
プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ
.NET Framework セキュリティ:
- WebPermission (HTTP 要求を通じて HTML ヘルプ ファイルにアクセスするために必要な許可) NetworkAccess.Connect (関連する列挙体)
- SecurityPermission (HTTP サーバーからサービスを受けていない HTML ヘルプ ファイルにアクセスするために必要な許可) UnmanagedCode (関連する列挙体)
参照
Help クラス | Help メンバ | System.Windows.Forms 名前空間 | Help.ShowHelp オーバーロードの一覧 | ShowHelpIndex