API Reference
PromptLabels
Every built-in word the interactive layer shows: key hints in footers, button captions, validation messages, accessible-mode questions. They follow the prompt's language (TerminalProfile.Language, CONSOLEMONSTER_LANGUAGE or the current UI culture): English, Polish, German, Spanish, French and Italian are built in. Assign PromptLabels.Default to use your own everywhere, or pass labels in InteractiveOptions.Labels; start from PromptLabels.For and PromptLabels.Clone to change a few words. Format strings use String.Format placeholders.
Inheritance
- Object
- PromptLabels
Usage
Explore 12 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 4
- Property InteractiveOptions.Labels
- Method PromptLabels.Clone
- Method PromptLabels.For
- Property PromptLabels.Default
Accepted by parameters 8
- Method ChoiceField.Display
- Method Field.Display
- Method NumberField.Display
- Method PathField.Display
- Method SecretField.Display
- Method TextAreaField.Display
- Method TextField.Display
- Method ToggleField.Display
Constructors
public PromptLabels() #Methods
public static PromptLabels For(CultureInfo? language) #PromptLabelsThe labels for a language: the assigned PromptLabels.Default, otherwise the built-in translation (English when there is none).
Parameters
- language System.Globalization.CultureInfo?
- The language, or null for LabelLanguage.Default.
Returns
The labels; don't modify the shared instance, use PromptLabels.Clone.
public static String Format(String format, params Object?[] args) #StringFormats a label with arguments using the invariant culture.
Parameters
- format System.String
- The format string (one of this object's properties).
- args System.Object?[]
- The arguments.
Returns
The formatted text.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public static PromptLabels Default { get; set; } #The labels used when none are passed: the assigned ones, otherwise the translation for LabelLanguage.Default.
public String KeyNewLine { get; set; } #Key hint: a new line in a multi-line text box.
public String EndWithEmptyLine { get; set; } #The line-mode hint of a multi-line answer.
public String TextAreaCounter { get; set; } #The counter under a multi-line text box: {0} lines, {1} characters.
public String KeyFix { get; set; } #Footer label for Enter on a blocked Run button (it opens the item that fixes the first problem).
public String SelectedCount { get; set; } #The live selection count: {0} selected of {1}.
public String More { get; set; } #More items above or below the visible part of a list: {0}.
public String StillLoading { get; set; } #A page cannot move on while a field's options are still loading.
public String Minimum { get; set; } #The number is too small: {0} is the minimum.
public String Maximum { get; set; } #The number is too large: {0} is the maximum.
public String InvalidFormat { get; set; } #The answer does not match the expected pattern.
public String FileExpected { get; set; } #A folder was chosen where a file is expected.
public String FolderExpected { get; set; } #A file was chosen where a folder is expected.
public String Disabled { get; set; } #The focused item is disabled: {0} is the reason.
public String NonInteractiveNeedsValue { get; set; } #Non-interactive and no default: {0} the prompt, {1} the parameter.
public String NonInteractiveNeedsDefault { get; set; } #Non-interactive and no default, without a parameter: {0} the prompt.
public String Done { get; set; } #The finish button of a form without a review page.
public String TypeToConfirm { get; set; } #Typed confirmation: {0} is the text to type.
public String TypedMismatch { get; set; } #The typed confirmation does not match: {0} is the expected text.
public String AppCommands { get; set; } #The palette group of app commands (home, keys, exit).
public String OneProblem { get; set; } #The problem count on a blocked Run button when there is one problem.
public String AnyKeyCloses { get; set; } #The hint on dialogs that close on any key (the key map, action output).
public String Output { get; set; } #The title of the dialog that shows what an action wrote.
public String EarlierLines { get; set; } #The line above action output when older lines are not shown: {0} is how many.
public String DiscardFormChanges { get; set; } #The question when leaving a form opened from a menu with changes that were not saved.
public String Discard { get; set; } #The button that discards unsaved form changes.
public String ManyProblems { get; set; } #The problem count on a blocked Run button: {0} is the number of problems.
public String DiscardChanges { get; set; } #The question before leaving with unsaved changes.
public String PressEnterToRun { get; set; } #The press-enter hint of an action item.
public String EnterNumber { get; set; } #Accessible mode: the question for a numbered choice.
public String EnterNumbers { get; set; } #Accessible mode: the question for several numbered choices.
public String NotAChoice { get; set; } #Accessible mode: the answer was not one of the numbers: {0}.
public String AnswerYesNo { get; set; } #A yes/no answer was neither: {0} the yes key, {1} the no key.
public String DefaultHint { get; set; } #Accessible mode: default value hint: {0}.
public String SelectedHint { get; set; } #Accessible mode: currently selected: {0}.
public String GroupHeading { get; set; } #Group headings in accessible mode: {0}.
public String KeyMarker { get; set; } #Replay player key hint: jump to the next or previous marker.
public String KeyFailure { get; set; } #Replay player key hint: jump to the next or previous failure.
public String KeyWarning { get; set; } #Replay player key hint: jump to the next or previous warning.
public String KeyLogEntry { get; set; } #Replay player key hint: jump to the next or previous log entry.
public String ReplayNoMore { get; set; } #Replay player: nothing further in the requested direction.
public String ReplayNoMatch { get; set; } #Replay player: no log entry contains the search text {0}.
public String ReplaySearch { get; set; } #Replay player: placeholder of the log search box.