System.Object
  CommandLine.Text.HelpText
Namespace: CommandLine.Text
Assembly: CommandLine (in CommandLine.dll) Version: 0.0.0

C#

public class HelpText

VB

Public Class HelpText

C++

public ref class HelpText

F#

type HelpText =  class end

The HelpText type exposes the following members.

	Name	Description
	HelpText
	HelpText()	Initializes a new instance of the HelpText class.
	HelpText(String)	Initializes a new instance of the HelpText class specifying heading string.
	HelpText(SentenceBuilder)	Initializes a new instance of the HelpText class specifying the sentence builder.
	HelpText(String, String)	Initializes a new instance of the HelpText class specifying heading and copyright strings.
	HelpText(SentenceBuilder, String)	Initializes a new instance of the HelpText class specifying the sentence builder and heading string.
	HelpText(SentenceBuilder, String, String)	Initializes a new instance of the HelpText class specifying heading and copyright strings.

	Name	Description
	AddDashesToOption	Gets or sets a value indicating whether the format of options should contain dashes. It modifies behavior of AddOptions(T)(ParserResult(T)) method.
	AddEnumValuesToHelpText	Gets or sets a value indicating whether to add the values of an enum after the description of the specification.
	AdditionalNewLineAfterOption	Gets or sets a value indicating whether to add an additional line after the description of the specification.
	AutoHelp	Gets or sets a value indicating whether implicit option or verb 'help' should be supported.
	AutoVersion	Gets or sets a value indicating whether implicit option or verb 'version' should be supported.
	Copyright	Gets or sets the copyright string. You can directly assign a CopyrightInfo instance.
	Heading	Gets or sets the heading string. You can directly assign a HeadingInfo instance.
	MaximumDisplayWidth	Gets or sets the maximum width of the display. This determines word wrap when displaying the text.
	OptionComparison
	SentenceBuilder	Gets the SentenceBuilder instance specified in constructor.

	Name	Description
	AdaptVerbsToSpecifications
	AddLine(StringBuilder, String)
	AddLine(StringBuilder, String, Int32)
	AddOption
	AddOptionName
	AddOptions(T)(ParserResult(T))	Adds a text block with options usage string.
	AddOptions(T)(Int32, ParserResult(T))	Adds a text block with options usage string.
	AddOptionsImpl
	AddPostOptionsLine	Adds a text line at the bottom, after options usage string.
	AddPostOptionsLines	Adds text lines at the bottom, after options usage string.
	AddPostOptionsText	Adds a text block of lines at the bottom, after options usage string.
	AddPreOptionsLine(String)	Adds a text line after copyright and before options usage strings.
	AddPreOptionsLine(String, Int32)
	AddPreOptionsLines	Adds text lines after copyright and before options usage strings.
	AddPreOptionsText	Adds a text block of lines after copyright and before options usage strings.
	AddValueName
	AddVerbs(Type[])	Adds a text block with verbs usage string.
	AddVerbs(Int32, Type[])	Adds a text block with verbs usage string.
	AutoBuild(T)(ParserResult(T), Int32)	Creates a new instance of the HelpText class, automatically handling verbs or options scenario.
	AutoBuild(T)(ParserResult(T), Func(HelpText, HelpText), Func(Example, Example), Boolean, Int32)	Creates a new instance of the HelpText class using common defaults.
	DefaultParsingErrorsHandler(T)	Supplies a default parsing error handler implementation.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FormatDefaultValue(T)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMaxLength
	GetMaxOptionLength
	GetMaxValueLength
	GetSpecificationsFromType
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUsageFromType
	MakeHelpEntry
	MakeVersionEntry
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RenderParsingErrorsText(T)	Builds a string that contains a parsing error message.
	RenderParsingErrorsTextAsLines(T)	Builds a sequence of string that contains a parsing error message.
	RenderUsageText(T)(ParserResult(T))	Builds a string with usage text block created using UsageAttribute data and metadata.
	RenderUsageText(T)(ParserResult(T), Func(Example, Example))	Builds a string with usage text block created using UsageAttribute data and metadata.
	RenderUsageTextAsLines(T)	Builds a string sequence with usage text block created using UsageAttribute data and metadata.
	ToComparableOption
	ToString	Returns the help screen as a String. (Overrides Object.ToString().)

	Name	Description
	Implicit(HelpText to String)	Converts the help instance to a String.

	Name	Description
	RequiredThenAlphaComparison

	Name	Description
	IsEmpty	(Defined by UnParserExtensions.)
	NormalizeValue	(Defined by UnParserExtensions.)

CommandLine.Text Namespace