Installer.HelpText Property

Reference

Definition

Namespace:: System.Configuration.Install

Assembly:: System.Configuration.Install.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

Property Value

String

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.

Exceptions

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.

Examples

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

Applies to

Delen via