M_CommandLine_Text_HelpText_AutoBuild__1_1

HelpText.AutoBuild(T) Method (ParserResult(T), Int32)

Creates a new instance of the HelpText class, automatically handling verbs or options scenario.

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

Syntax

C#

public static HelpText AutoBuild<T>(
	ParserResult<T> parserResult,
	int maxDisplayWidth = 80
)

VB

Public Shared Function AutoBuild(Of T) ( 
	parserResult As ParserResult(Of T),
	Optional maxDisplayWidth As Integer = 80
) As HelpText

C++

public:
generic<typename T>
static HelpText^ AutoBuild(
	ParserResult<T>^ parserResult, 
	int maxDisplayWidth = 80
)

F#

static member AutoBuild : 
        parserResult : ParserResult<'T> * 
        ?maxDisplayWidth : int 
(* Defaults:
        let _maxDisplayWidth = defaultArg maxDisplayWidth 80
*)
-> HelpText 

Parameters

 

parserResult

Type: CommandLine.ParserResult(T)
The ParserResult(T) containing the instance that collected command line arguments parsed with Parser class.

maxDisplayWidth (Optional)

Type: System.Int32
The maximum width of the display.

Type Parameters

 

T

Return Value

Type: HelpText
An instance of HelpText class.

Remarks

This feature is meant to be invoked automatically by the parser, setting the HelpWriter property of ParserSettings.

See Also

Reference

HelpText Class
AutoBuild Overload
CommandLine.Text Namespace