Installer.HelpText Propriedade

Definição

Namespace:

System.Configuration.Install

Assembly:

System.Configuration.Install.dll

Obtém o texto de ajuda para todos os instaladores na coleção de instalador.

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

Valor da propriedade

String

O texto de ajuda para todos os instaladores na coleção de instalador, incluindo a descrição do que faz o instalador e as opções de linha de comando para a instalação executável, como o utilitário InstallUtil.exe, que pode ser passado para o instalador e compreendido por ele.

Exceções

NullReferenceException

Um dos instaladores na coleção de instaladores especifica uma referência nula em vez do texto de ajuda. Uma causa provável para essa exceção é que um campo para conter o texto da Ajuda está definido, mas não inicializado.

Exemplos

O exemplo a seguir demonstra a HelpText propriedade . Essa propriedade é definida na Installer classe , que, quando chamada, retorna a descrição das opções de linha de Installer comando e para o executável de instalação, como o utilitário Installutil.exe, que pode ser passado e compreendido pelo 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

Confira também

• Installers