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

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

示例

以下示例演示 了 HelpText 属性。 此属性在 类中 Installer 定义，当类被调用时，该类返回安装可执行文件（如 Installutil.exe 实用工具）的说明 Installer 和命令行选项，这些选项可以传递给 并由 其 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