Installer.HelpText プロパティ

.NET Framework クラス ライブラリ リファレンス

Installer.HelpText プロパティ

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

名前空間: System.Configuration.Install
アセンブリ: System.Configuration.Install (system.configuration.install.dll 内)
構文

Visual Basic (宣言)

Public Overridable ReadOnly
 Property HelpText As String

Visual Basic (使用法)

Dim instance As Installer
Dim value As String

value = instance.HelpText

C#

public virtual string HelpText { get;
 }

C++

public:
virtual property String^ HelpText {
    String^ get ();
}

J#

/** @property */
public String get_HelpText ()

JScript

public function get HelpText
 () : String

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

例外

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

使用例

HelpText プロパティの例を次に示します。このプロパティは、Installer クラスで定義されています。このプロパティは、呼び出されると、Installer の説明、および Installutil.exe ユーティリティなど、インストールの実行可能ファイルに対するコマンド ライン オプションを返します。これらのオプションは Installer に渡されて認識されます。

Visual Basic

' 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

C#

// 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.";
   }
}

C++

   // 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.";
   }
}

J#

// 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

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
Installer クラス
Installer メンバ
System.Configuration.Install 名前空間
Installers