Export (0) Print
Expand All

Installer.HelpText Property

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

Namespace: System.Configuration.Install
Assembly: System.Configuration.Install (in system.configuration.install.dll)

public virtual string HelpText { get; }
/** @property */
public String get_HelpText ()

public function get HelpText () : String

Not applicable.

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.

Exception typeCondition

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 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
 */
public String get_HelpText()
{
    return "Installer Description : This is a sample Installer\n" 
            + "HelpText is used to provide useful information about the "
            + "installer.";
}//get_HelpText

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft