Installer.HelpText プロパティ

定義

名前空間:

System.Configuration.Install

アセンブリ:

System.Configuration.Install.dll

インストーラー コレクション内のすべてのインストーラーに関するヘルプ テキストを取得します。

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

プロパティ値

String

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

例外

NullReferenceException

インストーラー コレクション内のインストーラーの 1 つが、ヘルプ テキストではなく null 参照を指定しています。 この例外の原因としては、ヘルプ テキストを含むフィールドが定義はされているが、初期化されていないことが考えられます。

例

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

こちらもご覧ください

• Installers