Skip to content
ConsoleMonster
Class

ToggleFieldFluent

ConsoleMonster.Interactive

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

The fluent methods of ToggleField, 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
  • ToggleFieldFluent

Methods

AddDependsOn 3 overloads
public static ToggleField AddDependsOn(ToggleField toggleField, string item) #

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

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
item string required
The item.

Returns

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

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

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
items string[] required
The items, in order.

Returns

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

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

Parameters

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

Returns

ToggleField The same instance.
public static ToggleField Default(ToggleField toggleField, 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

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value object? required
The value.

Returns

ToggleField The same instance.

Examples

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

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

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value string? required
The value.

Returns

ToggleField The same instance.

Examples

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

Sets Field.Label: The label.

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value string required
The value.

Returns

ToggleField The same instance.

Examples

// C# initializer or property    // C# fluent
toggleField.Label = value;       toggleField.Label(value);
public static ToggleField OffText(ToggleField toggleField, string? value) #

Sets ToggleField.OffText: Text after the box when off; null uses "No".

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value string? required
The value.

Returns

ToggleField The same instance.

Examples

// C# initializer or property    // C# fluent
toggleField.OffText = value;     toggleField.OffText(value);
public static ToggleField OnText(ToggleField toggleField, string? value) #

Sets ToggleField.OnText: Text after the box when on; null uses "Yes".

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value string? required
The value.

Returns

ToggleField The same instance.

Examples

// C# initializer or property    // C# fluent
toggleField.OnText = value;      toggleField.OnText(value);
public static ToggleField ParameterName(ToggleField toggleField, 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

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value string? required
The value.

Returns

ToggleField The same instance.

Examples

// C# initializer or property         // C# fluent
toggleField.ParameterName = value;    toggleField.ParameterName(value);
Remember 2 overloads
public static ToggleField Remember(ToggleField toggleField, bool value) #

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

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value bool required
The value.

Returns

ToggleField The same instance.

Examples

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

Sets Field.Remember to true.

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance to configure.

Returns

ToggleField The same instance.
Required 2 overloads
public static ToggleField Required(ToggleField toggleField, bool value) #

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

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value bool required
The value.

Returns

ToggleField The same instance.

Examples

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

Sets Field.Required to true.

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance to configure.

Returns

ToggleField The same instance.
public static ToggleField Value(ToggleField toggleField, object? value) #

Sets Field.Value: The current value.

Parameters

toggleField ConsoleMonster.Interactive.ToggleField required
The instance.
value object? required
The value.

Returns

ToggleField The same instance.

Examples

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