Installer.HelpText Installer.HelpText Installer.HelpText Installer.HelpText Property

定義

インストーラー コレクション内のすべてのインストーラーに関するヘルプ テキストを取得します。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

プロパティ値

インストーラー コレクション内のすべてのインストーラーに関するヘルプ テキスト。たとえば、インストーラーの動作や、InstallUtil.exe ユーティリティなどのインストール実行可能ファイルの実行時にインストーラーに渡されて解釈されるコマンド ライン オプションなどの説明が含まれます。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.

例外

インストーラー コレクション内のインストーラーの 1 つが、ヘルプ テキストではなく null 参照を指定しています。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.

次の例で、HelpTextプロパティ。The following example demonstrates the HelpText property. このプロパティが定義されている、Installerクラスであり、呼び出されるの説明を返します、Installerに渡されで認識されることができる Installutil.exe ユーティリティなど、実行可能ファイルのインストールのコマンド ライン オプションと、Installer.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

適用対象

こちらもご覧ください