Skip to content
ConsoleMonster

API Reference

Class

SecretField

Edit on GitHub
Namespace ConsoleMonster.Interactive
Assembly ConsoleMonster
Source SecretField.cs:24
Base Field
Modifiers sealed

A secret: masked in the form, never shown on the review page, never stored, a placeholder in the command.

Inheritance

Usage

Explore 2 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 2

Constructors

public SecretField(String name, String? label = null) #
SecretField.cs:24

Creates a secret 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) #
SecretField.cs:30
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; } #
SecretField.cs:21

The kind.

public String CommandPlaceholder { get; set; } #
SecretField.cs:24

What stands in for the secret in the equivalent command (PowerShell: (Read-Host -AsSecureString)).

public Int32 MinLength { get; set; } #
SecretField.cs:27

The fewest characters.