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...

Inheritance diagram for CommandLine.Text.SentenceBuilder:

Classes
class	DefaultSentenceBuilder

Static Public Member Functions
static SentenceBuilder	Create ()
	Create instance of CommandLine.Text.SentenceBuilder,.

Properties
static Func< SentenceBuilder >	Factory = () => new DefaultSentenceBuilder() [get, set]
	Factory to allow custom SentenceBuilder injection.
Func< string >	RequiredWord [get]
	Gets a delegate that returns the word 'required'.
Func< string >	OptionGroupWord [get]
	Gets a delegate that returns the word 'group'.
Func< string >	ErrorsHeadingText [get]
	Gets a delegate that returns that errors block heading text.
Func< string >	UsageHeadingText [get]
	Gets a delegate that returns usage text block heading text.
Func< bool, string >	HelpCommandText [get]
	Get a delegate that returns the help text of help command. The delegates must accept a boolean that is equal truefor options; otherwise falsefor verbs.
Func< bool, string >	VersionCommandText [get]
	Get a delegate that returns the help text of vesion command. The delegates must accept a boolean that is equal truefor options; otherwise falsefor verbs.
Func< Error, string >	FormatError [get]
	Gets a delegate that handles singular error formatting. The delegates must accept an Error and returns a string.
Func< IEnumerable< MutuallyExclusiveSetError >, string >	FormatMutuallyExclusiveSetErrors [get]
	Gets a delegate that handles mutually exclusive set errors formatting. The delegates must accept a sequence of MutuallyExclusiveSetError and returns a string.

Detailed Description

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

Definition at line 16 of file SentenceBuilder.cs.

Member Function Documentation

Create()

static SentenceBuilder CommandLine.Text.SentenceBuilder.Create ( )

static

Create instance of CommandLine.Text.SentenceBuilder,.

Returns

The CommandLine.Text.SentenceBuilder instance.

Definition at line 79 of file SentenceBuilder.cs.

        {
            return Factory();
        }

Property Documentation

ErrorsHeadingText

Func<string> CommandLine.Text.SentenceBuilder.ErrorsHeadingText

getabstract

Gets a delegate that returns that errors block heading text.

Definition at line 36 of file SentenceBuilder.cs.

{ get; }

Factory

Func<SentenceBuilder> CommandLine.Text.SentenceBuilder.Factory = () => new DefaultSentenceBuilder()

staticgetset

Factory to allow custom SentenceBuilder injection.

Definition at line 21 of file SentenceBuilder.cs.

{ get; set; } = () => new DefaultSentenceBuilder();

FormatError

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

getabstract

Gets a delegate that handles singular error formatting. The delegates must accept an Error and returns a string.

Definition at line 67 of file SentenceBuilder.cs.

{ get; }

FormatMutuallyExclusiveSetErrors

Func<IEnumerable<MutuallyExclusiveSetError>, string> CommandLine.Text.SentenceBuilder.FormatMutuallyExclusiveSetErrors

getabstract

Gets a delegate that handles mutually exclusive set errors formatting. The delegates must accept a sequence of MutuallyExclusiveSetError and returns a string.

Definition at line 73 of file SentenceBuilder.cs.

{ get; }

HelpCommandText

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

getabstract

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

Definition at line 51 of file SentenceBuilder.cs.

{ get; }

OptionGroupWord

Func<string> CommandLine.Text.SentenceBuilder.OptionGroupWord

getabstract

Gets a delegate that returns the word 'group'.

Definition at line 31 of file SentenceBuilder.cs.

{ get; }

RequiredWord

Func<string> CommandLine.Text.SentenceBuilder.RequiredWord

getabstract

Gets a delegate that returns the word 'required'.

Definition at line 26 of file SentenceBuilder.cs.

{ get; }

UsageHeadingText

Func<string> CommandLine.Text.SentenceBuilder.UsageHeadingText

getabstract

Gets a delegate that returns usage text block heading text.

Definition at line 41 of file SentenceBuilder.cs.

{ get; }

VersionCommandText

Func<bool, string> CommandLine.Text.SentenceBuilder.VersionCommandText

getabstract

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

Definition at line 61 of file SentenceBuilder.cs.

{ get; }

---

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

• deps/commandlineparser/src/CommandLine/Text/SentenceBuilder.cs