getopt.net.HelpTextConfig Class Reference

A class that contains configuration options for the help text generator. More...

Static Public Member Functions
static HelpTextConfig	GnuConfig ()
	Gets a configuration for the GNU/POSIX convention.
static HelpTextConfig	WindowsConfig ()
	Gets a configuration for the Windows convention.
static HelpTextConfig	PowershellConfig ()
	Gets a configuration for the Powershell convention.

Properties
bool	ShowSupportedConventions = false [get, set]
	Whether to show the supported conventions in the help text.
int	MaxWidth = 100 [get, set]
	The maximum width of the help text.
OptionConvention	OptionConvention = OptionConvention.GnuPosix [get, set]
	The option convention to use.
string?	ApplicationName [get, set]
	The name of the application.
string?	ApplicationVersion [get, set]
	The version of the application.
string?	FooterText [get, set]
	A footer text to be displayed under the help text.
DateTime?	CopyrightDate [get, set]
	The date of the copyright.
string?	CopyrightHolder [get, set]
	The holder of the copyright.
static HelpTextConfig	Default [get]
	Gets a default configuration.

Detailed Description

A class that contains configuration options for the help text generator.

Definition at line 8 of file HelpTextConfig.cs.

Member Function Documentation

GnuConfig()

static HelpTextConfig getopt.net.HelpTextConfig.GnuConfig ( )

static

Gets a configuration for the GNU/POSIX convention.

References getopt.net.HelpTextConfig.ApplicationName, getopt.net.HelpTextConfig.ApplicationVersion, getopt.net.HelpTextConfig.FooterText, and getopt.net.HelpTextConfig.MaxWidth.

PowershellConfig()

static HelpTextConfig getopt.net.HelpTextConfig.PowershellConfig ( )

static

Gets a configuration for the Powershell convention.

References getopt.net.HelpTextConfig.ApplicationName, getopt.net.HelpTextConfig.ApplicationVersion, getopt.net.HelpTextConfig.FooterText, and getopt.net.HelpTextConfig.MaxWidth.

WindowsConfig()

static HelpTextConfig getopt.net.HelpTextConfig.WindowsConfig ( )

static

Gets a configuration for the Windows convention.

References getopt.net.HelpTextConfig.ApplicationName, getopt.net.HelpTextConfig.ApplicationVersion, getopt.net.HelpTextConfig.FooterText, and getopt.net.HelpTextConfig.MaxWidth.

Property Documentation

ApplicationName

string? getopt.net.HelpTextConfig.ApplicationName

getset

The name of the application.

Definition at line 28 of file HelpTextConfig.cs.

{ get; set; }

Referenced by getopt.net.HelpTextConfig.GnuConfig(), getopt.net.HelpTextConfig.PowershellConfig(), and getopt.net.HelpTextConfig.WindowsConfig().

ApplicationVersion

string? getopt.net.HelpTextConfig.ApplicationVersion

getset

The version of the application.

Definition at line 33 of file HelpTextConfig.cs.

{ get; set; }

Referenced by getopt.net.HelpTextConfig.GnuConfig(), getopt.net.HelpTextConfig.PowershellConfig(), and getopt.net.HelpTextConfig.WindowsConfig().

CopyrightDate

DateTime? getopt.net.HelpTextConfig.CopyrightDate

getset

The date of the copyright.

Definition at line 43 of file HelpTextConfig.cs.

{ get; set; }

CopyrightHolder

string? getopt.net.HelpTextConfig.CopyrightHolder

getset

The holder of the copyright.

Definition at line 48 of file HelpTextConfig.cs.

{ get; set; }

Default

HelpTextConfig getopt.net.HelpTextConfig.Default

staticget

Gets a default configuration.

Definition at line 53 of file HelpTextConfig.cs.

Referenced by getopt.net.Extensions.GenerateHelpText().

FooterText

string? getopt.net.HelpTextConfig.FooterText

getset

A footer text to be displayed under the help text.

Definition at line 38 of file HelpTextConfig.cs.

{ get; set; }

Referenced by getopt.net.HelpTextConfig.GnuConfig(), getopt.net.HelpTextConfig.PowershellConfig(), and getopt.net.HelpTextConfig.WindowsConfig().

MaxWidth

int getopt.net.HelpTextConfig.MaxWidth = 100

getset

The maximum width of the help text.

Definition at line 18 of file HelpTextConfig.cs.

{ get; set; } = 100;

Referenced by getopt.net.HelpTextConfig.GnuConfig(), getopt.net.HelpTextConfig.PowershellConfig(), and getopt.net.HelpTextConfig.WindowsConfig().

OptionConvention

OptionConvention getopt.net.HelpTextConfig.OptionConvention = OptionConvention.GnuPosix

getset

The option convention to use.

Definition at line 23 of file HelpTextConfig.cs.

{ get; set; } = OptionConvention.GnuPosix;

ShowSupportedConventions

bool getopt.net.HelpTextConfig.ShowSupportedConventions = false

getset

Whether to show the supported conventions in the help text.

Definition at line 13 of file HelpTextConfig.cs.

{ get; set; } = false;

---

The documentation for this class was generated from the following file:

• HelpTextConfig.cs