Cmdlet

New-ConsoleFormPreset

Module ConsoleMonster

Inputs

None

Outputs

ConsoleMonster.Interactive.FormPreset

Creates a preset a form comes with: field values under one name, with a description and a preview.

Syntax

New-ConsoleFormPreset [-Description <String>] [-Name] <String> [-Preview <Object>] [-Values] <IDictionary> [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Creates a preset a form comes with: field values under one name, with a description and a preview.

Give the presets to New-ConsoleForm (-Preset, or emit them in its scriptblock next to the fields). They are listed before the presets people save, marked as built in, and cannot be overwritten or deleted; applying one (Read-ConsoleForm -Preset, or the menu's command palette) sets the fields it names the way a saved preset does. -Values maps field names to values: a string, a number, a bool, or a list for a multi-choice field; a value that names a choice (the object, its title or its text) takes that choice, and a value for a field whose choices load is chosen once they arrive.

Examples

Authored help example

EXAMPLE 1

$form = New-ConsoleForm 'Report' -Command 'Export-AppReport' {
    New-ConsoleField Period 'Period' -Type Select -Choices 'Day', 'Week', 'Month' -Parameter Period
    New-ConsoleField Path 'Folder' -Type Path -Kind Folder -Parameter Path
    New-ConsoleFormPreset 'Weekly' -Values @{ Period = 'Week'; Path = 'D:\Reports\Weekly' } -Description 'Every Monday.'
    New-ConsoleFormPreset 'Monthly' -Values @{ Period = 'Month'; Path = 'D:\Reports\Monthly' }
}
Read-ConsoleForm $form -Preset Weekly

A form with two built-in presets

Parameters

-Description String optional: A sentence about the preset, shown with it.
-Name String requiredposition: 0: The name; a preset people save cannot take it.
-Preview Object optional: Content describing what the preset fills in, for lists that preview a preset while it has focus: a scriptblock run once now, widgets, text (markup) or objects (as a list).
-Values IDictionary requiredposition: 1: Field values by field name (ignoring case): a string, a number, a bool, or a list for a multi-choice field.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.