通过

Installer.HelpText 属性

  • 项目

获取安装程序集合中所有安装程序的帮助文字。

**命名空间:**System.Configuration.Install
**程序集:**System.Configuration.Install（在 system.configuration.install.dll 中）

语法

声明
Public Overridable ReadOnly Property HelpText As String
用法
Dim instance As Installer
Dim value As String

value = instance.HelpText

public virtual string HelpText { get; }

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

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

public function get HelpText () : String

属性值

安装程序集合中所有安装程序的帮助文本，包括安装程序的用途说明以及可执行安装文件（如 InstallUtil.exe 实用工具）的命令行选项，这些选项可以传递给该安装程序并为其所识别。

异常

异常类型 条件

NullReferenceException

安装程序集合中的安装程序之一指定了一个空引用，而不是帮助文本。此异常的一个可能原因是定义了要包含帮助文本的字段，但未对其进行初始化。

示例

下面的示例阐释了 HelpText 属性。该属性在 Installer 类中被定义，该类在调用时将返回 Installer 的说明和可执行安装文件（例如 Installutil.exe 实用工具）的命令行选项，返回的内容可传递到 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

// 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'.
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'.
/** @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