Skip to content
ConsoleMonster
Class

PathFieldFluent

ConsoleMonster.Interactive

Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Modifiers
static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of PathField, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • PathFieldFluent

Methods

AddDependsOn 3 overloads
public static PathField AddDependsOn(PathField pathField, string item) #

Adds an item to Field.DependsOn: Fields whose change resets this field (and reloads its options).

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
item string required
The item.

Returns

PathField The same instance.
public static PathField AddDependsOn(PathField pathField, params string[] items) #

Adds items to Field.DependsOn: Fields whose change resets this field (and reloads its options).

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
items string[] required
The items, in order.

Returns

PathField The same instance.
public static PathField AddDependsOn(PathField pathField, IEnumerable<string> items) #

Adds items to Field.DependsOn: Fields whose change resets this field (and reloads its options).

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

PathField The same instance.
public static PathField AddExtension(PathField pathField, string item) #

Adds an item to PathField.Extensions: Extensions offered as suggestions.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
item string required
The item.

Returns

PathField The same instance.
AddExtensions 2 overloads
public static PathField AddExtensions(PathField pathField, params string[] items) #

Adds items to PathField.Extensions: Extensions offered as suggestions.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
items string[] required
The items, in order.

Returns

PathField The same instance.
public static PathField AddExtensions(PathField pathField, IEnumerable<string> items) #

Adds items to PathField.Extensions: Extensions offered as suggestions.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

PathField The same instance.
public static PathField Default(PathField pathField, object? value) #

Sets Field.Default: The declared default: the starting value until a value is set, and values equal to it are left out of the equivalent command.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value object? required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.Default = value;       pathField.Default(value);
public static PathField Help(PathField pathField, string? value) #

Sets Field.Help: Help shown while the field has focus.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value string? required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.Help = value;          pathField.Help(value);
public static PathField Label(PathField pathField, string value) #

Sets Field.Label: The label.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value string required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.Label = value;         pathField.Label(value);
MustExist 2 overloads
public static PathField MustExist(PathField pathField, bool value) #

Sets PathField.MustExist: Whether the path must exist.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value bool required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.MustExist = value;     pathField.MustExist(value);
public static PathField MustExist(PathField pathField) #

Sets PathField.MustExist to true.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance to configure.

Returns

PathField The same instance.
public static PathField ParameterName(PathField pathField, string? value) #

Sets Field.ParameterName: The command-line parameter this field supplies (Domain, -Domain, --domain); null leaves the field out of the equivalent command.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value string? required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property       // C# fluent
pathField.ParameterName = value;    pathField.ParameterName(value);
public static PathField PathKind(PathField pathField, PathKind value) #

Sets PathField.PathKind: What is accepted.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value ConsoleMonster.Interactive.PathKind required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.PathKind = value;      pathField.PathKind(value);
Remember 2 overloads
public static PathField Remember(PathField pathField, bool value) #

Sets Field.Remember: Whether the value is kept in presets and remembered choices (never for secrets).

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value bool required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.Remember = value;      pathField.Remember(value);
public static PathField Remember(PathField pathField) #

Sets Field.Remember to true.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance to configure.

Returns

PathField The same instance.
Required 2 overloads
public static PathField Required(PathField pathField, bool value) #

Sets Field.Required: Whether an empty value is refused.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value bool required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.Required = value;      pathField.Required(value);
public static PathField Required(PathField pathField) #

Sets Field.Required to true.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance to configure.

Returns

PathField The same instance.
public static PathField Value(PathField pathField, object? value) #

Sets Field.Value: The current value.

Parameters

pathField ConsoleMonster.Interactive.PathField required
The instance.
value object? required
The value.

Returns

PathField The same instance.

Examples

// C# initializer or property    // C# fluent
pathField.Value = value;         pathField.Value(value);