Class ArgumentDescriptor

Namespace

OneImlx.Terminal.Commands

Assembly

OneImlx.Terminal.dll

The ArgumentDescriptor class defines the command argument identity, data type, and data validation behavior. We also refer to arguments as command arguments.

public sealed class ArgumentDescriptor : IKeyAsId

Inheritance

object

ArgumentDescriptor

Implements

IKeyAsId

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ArgumentDescriptor(int, string, string, string, ArgumentFlags)

Initializes a new instance of ArgumentDescriptor.

public ArgumentDescriptor(int order, string id, string dataType, string description, ArgumentFlags flags)

Parameters

order int

The argument order.

id string

The argument identifier.

dataType string

The argument data type.

description string

The argument description.

flags ArgumentFlags

The argument flags.

Properties

DataType

The argument data type.

public string DataType { get; }

Property Value

string

Description

The argument description.

public string Description { get; }

Property Value

string

Flags

The argument flags.

public ArgumentFlags Flags { get; }

Property Value

ArgumentFlags

Id

The argument identifier.

public string Id { get; }

Property Value

string

Order

The argument order.

public int Order { get; }

Property Value

int

ValueCheckers

The argument value checkers.

public IEnumerable<IValueChecker<Argument>>? ValueCheckers { get; set; }

Property Value

IEnumerable<IValueChecker<Argument>>

See Also

Argument