Class VerbArgument

Namespace

RDCore.SDK.Platform.Commands

Assembly

RDCore.SDK.dll

One argument of a verb: what it is named, and what it is.

public sealed record VerbArgument : IEquatable<VerbArgument>

Inheritance

object

VerbArgument

Implements

IEquatable<VerbArgument>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

EvaluatedAt

For an Expression, the Name of the LineNumber argument of the same form that says where it is evaluated: before that line, in the procedure and the blocks of it - as the condition of a breakpoint is, where the program waits. An expression that is evaluated at no line (null), or at a line the module does not have, is evaluated in the module: its names, and the project's.

public string? EvaluatedAt { get; init; }

Property Value

string

Kind

What the argument is.

public VerbArgumentKind Kind { get; init; }

Property Value

VerbArgumentKind

Name

The name of the argument, as the verb's help names it: line, condition.

public string Name { get; init; }

Property Value

string

Settings

For a Setting, the settings it can be the key of, as the client has them: what it offers to set, and what each one is.

public IReadOnlyList<SettingDescriptor> Settings { get; init; }

Property Value

IReadOnlyList<SettingDescriptor>

TakesTheRest

Whether the argument takes the rest of the line: an expression, a path, text, and the value of a setting do - a space is in them, and does not end them.

public bool TakesTheRest { get; }

Property Value

bool

ValueOf

For a SettingValue, the Name of the Setting argument of the same form whose setting it is a value of.

public string? ValueOf { get; init; }

Property Value

string

Values

The values the argument can be, for a Keyword or a Choice.

public IReadOnlyList<VerbArgumentValue> Values { get; init; }

Property Value

IReadOnlyList<VerbArgumentValue>