Installer.HelpText Property

Gets the help text for all the installers in the installer collection.

[Visual Basic]
Public Overridable ReadOnly Property HelpText As String
[C#]
public virtual string HelpText {get;}
[C++]
public: __property virtual String* get_HelpText();
[JScript]
public function get HelpText() : String;

Property Value

The help text for all the installers in the installer collection, including the description of what the installer does and the command line options for the installation executable, such as the InstallUtil.exe utility, that can be passed to and understood by this installer.

Example

[Visual Basic, C#, C++] The following example demonstrates the HelpText property. This property is defined in the Installer class, which, when called, returns the description of the Installer and the command line options for the installation executable, such as the Installutil.exe utility, that can be passed to and understood by the Installer.

[Visual Basic] 
' 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

[C#] 
// 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.";
   }
}

[C++] 
// Override the property 'HelpText'.
__property String* get_HelpText() {
    return S"Installer Description : This is a sample Installer\n"
           S"HelpText is used to provide useful information about the installer.";
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries From Partially Trusted Code

See Also

Installer Class | Installer Members | System.Configuration.Install Namespace | Installers