HelpProvider.SetHelpNavigator メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

HelpProvider.SetHelpNavigator メソッド

指定したコントロールのヘルプファイルからヘルプを検索するときに使用する、ヘルプコマンドを指定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Overridable Sub SetHelpNavigator
 ( _
    ctl As Control, _
    navigator As HelpNavigator _
)

Visual Basic (使用法)

Dim instance As HelpProvider
Dim ctl As Control
Dim navigator As HelpNavigator

instance.SetHelpNavigator(ctl, navigator)

public virtual void SetHelpNavigator (
    Control ctl,
    HelpNavigator navigator
)

C++

public:
virtual void SetHelpNavigator (
    Control^ ctl, 
    HelpNavigator navigator
)

public void SetHelpNavigator (
    Control ctl, 
    HelpNavigator navigator
)

JScript

public function SetHelpNavigator (
    ctl : Control, 
    navigator : HelpNavigator
)

パラメータ

ctl: ヘルプキーワードの設定対象となる Control。

navigator: HelpNavigator 値の 1 つ。

例外

例外の種類	条件
InvalidEnumArgumentException	navigator の値が、HelpNavigator 値の 1 つではありません。

使用例

SetHelpNavigator メソッドの使用方法を示すコード例を次に示します。

この例を実行するには、HelpProvider1 という名前の HelpProvider と、TextBox1 という名前の TextBox が配置されているフォームを使用してください。この例では、C:\Windows ディレクトリに input.chm という名前のヘルプファイルがあることを前提としています。

Visual Basic

'Declare the HelpProvider.
Friend WithEvents HelpProvider1 As
 System.Windows.Forms.HelpProvider


Private Sub InitializeHelpProvider()

    ' Construct the HelpProvider Object.
    Me.HelpProvider1 = New System.Windows.Forms.HelpProvider

    ' Set the HelpNamespace property to the Help file for 
    ' HelpProvider1.
    Me.HelpProvider1.HelpNamespace = "c:\windows\input.chm"

    ' Specify that the Help provider should open to the table
    ' of contents of the Help file.
    Me.HelpProvider1.SetHelpNavigator(TextBox1, _
        HelpNavigator.TableOfContents)

End Sub

//Declare the HelpProvider.
internal System.Windows.Forms.HelpProvider HelpProvider1;


private void InitializeHelpProvider()
{
    // Construct the HelpProvider Object.
    this.HelpProvider1 = new System.Windows.Forms.HelpProvider();

    // Set the HelpNamespace property to the Help file for 
    // HelpProvider1.
    this.HelpProvider1.HelpNamespace = "c:\\windows\\input.chm";

    // Specify that the Help provider should open to the table
    // of contents of the Help file.
    this.HelpProvider1.SetHelpNavigator(TextBox1, 
        HelpNavigator.TableOfContents);
}

C++

   //Declare the HelpProvider.
internal:
   System::Windows::Forms::HelpProvider^ HelpProvider1;

private:
   void InitializeHelpProvider()
   {
      // Construct the HelpProvider Object.
      this->HelpProvider1 = gcnew System::Windows::Forms::HelpProvider;
      
      // Set the HelpNamespace property to the Help file for 
      // HelpProvider1.
      this->HelpProvider1->HelpNamespace = "c:\\windows\\input.chm";
      
      // Specify that the Help provider should open to the table
      // of contents of the Help file.
      this->HelpProvider1->SetHelpNavigator( TextBox1, HelpNavigator::TableOfContents
 );
   }

//Declare the HelpProvider.
private System.Windows.Forms.HelpProvider helpProvider1;

private void InitializeHelpProvider()
{
    // Construct the HelpProvider Object.
    this.helpProvider1 = new System.Windows.Forms.HelpProvider();
    // Set the HelpNamespace property to the Help file for 
    // helpProvider1.
    this.helpProvider1.set_HelpNamespace("c:\\windows\\input.chm");
    // Specify that the Help provider should open to the table
    // of contents of the Help file.
    this.helpProvider1.SetHelpNavigator(textBox1, 
        HelpNavigator.TableOfContents);
} //InitializeHelpProvider