Installer.HelpText Eigenschaft

Definition

Namespace:

System.Configuration.Install

Assembly:

System.Configuration.Install.dll

Ruft den Hilfetext für alle in der entsprechenden Auflistung enthaltenen Installationsprogramme ab.

public:
 virtual property System::String ^ HelpText { System::String ^ get(); };

public virtual string HelpText { get; }

member this.HelpText : string

Public Overridable ReadOnly Property HelpText As String

Eigenschaftswert

String

Der Hilfetext für alle Installationsprogramme in der entsprechenden Auflistung, einschließlich der Beschreibung der vom jeweiligen Installationsprogramm ausgeführten Vorgänge sowie der Befehlszeilenoptionen für das Installationsprogramm (z. B. InstallUtil.exe), die an das Programm übergeben und von diesem verarbeitet werden können.

Ausnahmen

NullReferenceException

Eines der Installationsprogramme in der Auflistung von Installationsprogrammen gibt anstelle des Hilfetexts einen NULL-Verweis an. Ein wahrscheinlicher Grund für diese Ausnahme ist, dass ein Feld, das den Hilfetext enthalten soll, zwar definiert, aber nicht initialisiert wurde.

Beispiele

Im folgenden Beispiel wird die HelpText -Eigenschaft veranschaulicht. Diese Eigenschaft wird in der Installer -Klasse definiert, die beim Aufruf die Beschreibung der Installer und der Befehlszeilenoptionen für die ausführbare Installationsdatei zurückgibt, z. B. das Hilfsprogramm Installutil.exe, die an übergeben und von Installerverstanden werden können.

   // Override the property 'HelpText'.
property String^ HelpText 
{
   virtual String^ get() override
   {
      return "Installer Description : This is a sample Installer\n"
           + "HelpText is used to provide useful information about the "
           + "installer.";
   }
}

// Override the property 'HelpText'.
public override string HelpText
{
   get
   {
      return "Installer Description : This is a sample Installer\n"
           + "HelpText is used to provide useful information about the "
           + "installer.";
   }
}

' Override the property 'HelpText'.
Public Overrides ReadOnly Property HelpText() As String
   Get
      Return _
      "Installer Description : This is a sample Installer" + ControlChars.NewLine + _
      "HelpText is used to provide useful information about the installer."
   End Get
End Property

Weitere Informationen

• Installers