CommandLine.Text.SentenceBuilder Class Reference

Exposes standard delegates to provide a mean to customize part of help screen generation. This type is consumed by CommandLine.Text.HelpText. More...

Static Public Member Functions
static SentenceBuilder	CreateDefault ()
	Create the default instance of CommandLine.Text.SentenceBuilder, localized in English. More...

Properties
abstract Func< string >	RequiredWord [get]
	Gets a delegate that returns the word 'required'. More...
abstract Func< string >	ErrorsHeadingText [get]
	Gets a delegate that returns that error heading text. More...
abstract Func< bool, string >	HelpCommandText [get]
	Get a delegate that returns the help text of helo command. The delegates should accept a boolean that is equal truefor options; otherwise falsefor verbs. More...
abstract Func< Error, string >	FormatError [get]
	Gets a delegate that handle singular error formatting. The delegates should accept an Error instance as input. More...

Detailed Description

Exposes standard delegates to provide a mean to customize part of help screen generation. This type is consumed by CommandLine.Text.HelpText.

Member Function Documentation

static SentenceBuilder CommandLine.Text.SentenceBuilder.CreateDefault ( )

inlinestatic

Create the default instance of CommandLine.Text.SentenceBuilder, localized in English.

Returns

The default CommandLine.Text.SentenceBuilder instance.

Property Documentation

abstract Func<string> CommandLine.Text.SentenceBuilder.ErrorsHeadingText

get

Gets a delegate that returns that error heading text.

abstract Func<Error, string> CommandLine.Text.SentenceBuilder.FormatError

get

Gets a delegate that handle singular error formatting. The delegates should accept an Error instance as input.

abstract Func<bool, string> CommandLine.Text.SentenceBuilder.HelpCommandText

get

Get a delegate that returns the help text of helo command. The delegates should accept a boolean that is equal truefor options; otherwise falsefor verbs.

abstract Func<string> CommandLine.Text.SentenceBuilder.RequiredWord

get

Gets a delegate that returns the word 'required'.

---

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

• src/CommandLine/Text/SentenceBuilder.cs