Skip to content
ConsoleMonster

API Reference

Class

TextAreaField

Edit on GitHub
Namespace ConsoleMonster.Interactive
Assembly ConsoleMonster
Source TextAreaField.cs:26
Base Field
Modifiers sealed

Several lines of text (notes, change reasons). In a form it shows the first line and the number of further lines; Enter opens the text in a dialog with soft wrap, where Ctrl+Enter saves and Esc keeps the old value.

Inheritance

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public TextAreaField(String name, String? label = null) #
TextAreaField.cs:26

Creates the field.

Parameters

name System.String requiredposition: 0
The key.
label System.String? = null optionalposition: 1
The label.

Methods

public override String Display(Object? value, PromptLabels labels) #
TextAreaField.cs:36
Returns: String

The value as shown in the form and on the review page.

Parameters

value System.Object? requiredposition: 0
The value.
labels ConsoleMonster.Interactive.PromptLabels requiredposition: 1
The labels.

Returns

The text.

Properties

public override FieldKind Kind { get; } #
TextAreaField.cs:17

The kind.

public String? Placeholder { get; set; } #
TextAreaField.cs:20

Muted text while empty.

public Int32 MinLength { get; set; } #
TextAreaField.cs:23

The fewest characters.

public Int32 MaxLength { get; set; } #
TextAreaField.cs:26

The most characters.

public Int32 MaxLines { get; set; } #
TextAreaField.cs:29

The most lines.

public Int32 Height { get; set; } #
TextAreaField.cs:32

The visible rows of the editor (default 8).