HelpProvider.SetHelpNavigator(Control, HelpNavigator) Methode

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll
Quelle:
HelpProvider.cs
Quelle:
HelpProvider.cs
Quelle:
HelpProvider.cs
Quelle:
HelpProvider.cs
Quelle:
HelpProvider.cs

Gibt den Hilfebefehl an, der beim Abrufen der Hilfe aus der Hilfedatei für das angegebene Steuerelement verwendet werden soll.

public:
 virtual void SetHelpNavigator(System::Windows::Forms::Control ^ ctl, System::Windows::Forms::HelpNavigator navigator);
public virtual void SetHelpNavigator(System.Windows.Forms.Control ctl, System.Windows.Forms.HelpNavigator navigator);
abstract member SetHelpNavigator : System.Windows.Forms.Control * System.Windows.Forms.HelpNavigator -> unit
override this.SetHelpNavigator : System.Windows.Forms.Control * System.Windows.Forms.HelpNavigator -> unit
Public Overridable Sub SetHelpNavigator (ctl As Control, navigator As HelpNavigator)

Parameter

ctl
Control

A Control , für die das Hilfeschlüsselwort festgelegt werden soll.

navigator
HelpNavigator

Einer der HelpNavigator Werte.

Ausnahmen

InvalidEnumArgumentException

Der Wert von navigator ist nicht einer der HelpNavigator Werte.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der SetHelpNavigator Methode veranschaulicht.

Wenn Sie dieses Beispiel ausführen möchten, platzieren Sie es in einem Formular, das einen HelpProvider Benannten HelpProvider1 und einen TextBox benannten Namen TextBox1enthält. Für das Beispiel ist das Vorhandensein einer Hilfedatei mit dem Namen "input.chm" im Verzeichnis "C:\Windows" erforderlich.

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

Gilt für:

Weitere Informationen