HelpProvider.SetHelpNavigator 方法

  • 项目

指定在从帮助文件中检索指定控件的帮助信息时使用的帮助命令。

**命名空间:**System.Windows.Forms
**程序集:**System.Windows.Forms（在 system.windows.forms.dll 中）

语法

声明
Public Overridable Sub SetHelpNavigator ( _
    ctl As Control, _
    navigator As HelpNavigator _
)
用法
Dim instance As HelpProvider
Dim ctl As Control
Dim navigator As HelpNavigator

instance.SetHelpNavigator(ctl, navigator)

public virtual void SetHelpNavigator (
    Control ctl,
    HelpNavigator navigator
)

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

public void SetHelpNavigator (
    Control ctl, 
    HelpNavigator navigator
)

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

参数

  • ctl
    要为其设置帮助关键字的 Control。

异常

异常类型 条件

InvalidEnumArgumentException

该 navigator 值不是 HelpNavigator 值之一。

示例

下面的代码示例演示 SetHelpNavigator 方法的用法。

若要运行此示例，请将它放到一个包含一个 HelpProvider（名为 HelpProvider1）和一个 TextBox（名为 TextBox1）的窗体中。该示例要求在 C:\Windows 目录中存在一个名为 input.chm 的帮助文件。

'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);
}

   //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

平台

Windows 98、Windows 2000 SP4、Windows CE、Windows Millennium Edition、Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows Server 2003、Windows XP Media Center Edition、Windows XP Professional x64 Edition、Windows XP SP2、Windows XP Starter Edition

.NET Framework 并不是对每个平台的所有版本都提供支持。有关受支持版本的列表，请参见系统要求。

版本信息

.NET Framework

受以下版本支持：2.0、1.1、1.0

请参见

参考

HelpProvider 类
HelpProvider 成员
System.Windows.Forms 命名空间
GetHelpString
GetHelpKeyword
GetShowHelp
SetHelpString
SetHelpKeyword