Gets the help text for all the installers in the installer collection.
(in System.Configuration.Install.dll)
Visual Basic (Declaration)
Public Overridable ReadOnly Property HelpText As String
Dim instance As Installer
Dim value As String
value = instance.HelpText
public virtual string HelpText { get; }
public:
virtual property String^ HelpText {
String^ get ();
}
public function get HelpText () : String
Property Value
Type:
System..::.StringThe 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.
| Exception | Condition |
|---|
| NullReferenceException | One of the installers in the installer collection specifies a null reference instead of help text. A likely cause for this exception is that a field to contain the help text is defined but not initialized. |
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.
' 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
// 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'.
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.";
}
}
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Reference