API Reference
Class
NumberPrompt
A number: whole or decimal, with a minimum and maximum shown as a hint, Up/Down stepping by NumberPrompt.Step (PgUp/PgDn by ten steps), and an inline error for text that is not a number or out of range.
Inheritance
- Prompt<Decimal>
- NumberPrompt
Constructors
public NumberPrompt(String title) #Creates a number prompt.
Parameters
- title System.String
- The question.
Methods
public override String Describe(Decimal value) #Returns:
StringThe answer as text, for the summary line left in the scrollback.
Parameters
- value System.Decimal
- The answer.
Returns
The text.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public Decimal Show(InteractiveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
DecimalInherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameters
- options InteractiveOptions? = null
- cancellationToken CancellationToken = default
public Task<Decimal> ShowAsync(InteractiveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<Decimal>Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameters
- options InteractiveOptions? = null
- cancellationToken CancellationToken = default
public Boolean TryShow(out Decimal value, InteractiveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
BooleanInherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameters
- value Decimal
- options InteractiveOptions? = null
- cancellationToken CancellationToken = default
Properties
public Boolean WholeNumber { get; set; } #Whether only whole numbers are accepted.
public CultureInfo? Culture { get; set; } #The culture that parses and formats the number; null uses the current culture.
public Func<Decimal, String?>? Validator { get; set; } #A validator after range checks: returns an error message, or null.
Inherited Properties
public String Title { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public String? Description { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public String? ParameterName { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public Boolean HasDefault { get; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public Decimal Default { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]