T_CommandLine_Text_SentenceBuilder

SentenceBuilder Class

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

Inheritance Hierarchy

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

Syntax

C#

public abstract class SentenceBuilder

VB

Public MustInherit Class SentenceBuilder

C++

public ref class SentenceBuilder abstract

F#

[<AbstractClassAttribute>]
type SentenceBuilder =  class end

The SentenceBuilder type exposes the following members.

Constructors

 

	Name	Description
	SentenceBuilder
	SentenceBuilder	Initializes a new instance of the SentenceBuilder class

  Back to Top

Properties

 

	Name	Description
	ErrorsHeadingText	Gets a delegate that returns that errors block heading text.
	Factory	Factory to allow custom SentenceBuilder injection
	FormatError	Gets a delegate that handles singular error formatting. The delegates must accept an Error and returns a string.
	FormatMutuallyExclusiveSetErrors	Gets a delegate that handles mutually exclusive set errors formatting. The delegates must accept a sequence of MutuallyExclusiveSetError and returns a string.
	HelpCommandText	Get a delegate that returns the help text of help command. The delegates must accept a boolean that is equal Field Value Type: true for options; otherwise Field Value Type: false for verbs.
	RequiredWord	Gets a delegate that returns the word 'required'.
	UsageHeadingText	Gets a delegate that returns usage text block heading text.
	VersionCommandText	Get a delegate that returns the help text of vesion command. The delegates must accept a boolean that is equal Field Value Type: true for options; otherwise Field Value Type: false for verbs.

  Back to Top

Methods

 

	Name	Description
	Create	Create instance of SentenceBuilder,
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

  Back to Top

Extension Methods

 

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

  Back to Top

See Also

Reference

CommandLine.Text Namespace