Class BaseCliArguments

The base class which must be derived from for a CliArguments implementation

Inheritance
System.Object
BaseCliArguments
Syntax
public abstract class BaseCliArguments : IHelpable, IUserFacingExceptionHandler

Constructors

| Improve this Doc

BaseCliArguments(String)

The base class which must be derived from for CliArguments implementation

Declaration
public BaseCliArguments(string utilityName)
Parameters
Type Name Description
System.String utilityName

The name of your utility or application

Properties

| Improve this Doc

HelpInvoked

Declaration
[Help("Displays Help information about arguments when set")]
public bool HelpInvoked { get; set; }
Property Value
Type Description
System.Boolean
Implements
| Improve this Doc

Operands

All trailing arguments left after any Options and OptionParameters defined in CliArguments

Declaration
public string[] Operands { get; }
Property Value
Type Description
System.String[]
| Improve this Doc

UserFacingExceptionThrown

Declaration
public bool UserFacingExceptionThrown { get; set; }
Property Value
Type Description
System.Boolean
Implements

Methods

| Improve this Doc

OnHelpInvoked(String)

Declaration
public virtual void OnHelpInvoked(string helpText)
Parameters
Type Name Description
System.String helpText
Implements
| Improve this Doc

OnUserFacingException(UserFacingException, String)

Declaration
public virtual void OnUserFacingException(UserFacingException e, string message)
Parameters
Type Name Description
UserFacingException e
System.String message
Implements