Cmdlet

New-ConsoleMenuPreset

Module ConsoleMonster

Inputs

None

Outputs

ConsoleMonster.Interactive.MenuPreset

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

Syntax

New-ConsoleMenuPreset [-Description <String>] [-Form <Form>] [-Item <MenuItem>] [-Name] <String> [-Preview <Object>] [-Selection <Object[]>] [-Values <IDictionary>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

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

Give the presets to New-ConsoleMenu (-Preset, or emit them in its scriptblock) and add a New-ConsoleMenuItem -Presets item: it lists them first, marked as built in, before the presets people save; they cannot be overwritten or deleted. Applying one sets the values it names and keeps the rest. -Form with -Values fills in a form opened from the menu (a list for a multi-choice field; a value for a field whose choices load is chosen once they arrive). -Item with -Selection selects values in a selection item. -Preview is shown beside the list while the preset has focus: a scriptblock (run once, now), widgets, text or objects.

Examples

Authored help example

EXAMPLE 1

$form = New-ConsoleForm 'Backup' -Command 'Start-AppBackup' {
    New-ConsoleField Target 'Target' -Type Select -Choices 'Daily', 'Weekly' -Parameter Target
    New-ConsoleField Compress 'Compress' -Type Toggle -Parameter Compress
}
$menu = New-ConsoleMenu 'Backup helper' {
    New-ConsoleMenuPreset 'Weekly · compressed' -Description 'The Sunday backup.' -Form $form -Values @{ Target = 'Weekly'; Compress = $true } -Preview {
        New-ConsoleKeyValue -Data ([ordered] @{ Target = 'Weekly'; Compress = 'yes' })
    }
    New-ConsoleMenuItem 'Presets' -Presets
    New-ConsoleMenuItem 'Back up' -Form $form
    New-ConsoleMenuItem -Exit
}

A preset that fills in a form, with what it sets as the preview

EXAMPLE 2

$targets = New-ConsoleMenuItem 'Targets' -MultiSelect 'SRV01', 'SRV02', 'SRV03'
$menu = New-ConsoleMenu 'Patch' -Item $targets -Preset (New-ConsoleMenuPreset 'First wave' -Item $targets -Selection 'SRV01', 'SRV02') {
    New-ConsoleMenuItem 'Presets' -Presets
}

A preset that selects servers in a selection item

Parameters

-Description String optional: A sentence shown while the preset has focus in the list.
-Form Form optional: A form opened from the menu whose fields the preset fills in (with -Values).
-Item MenuItem optional: A selection item of the menu (New-ConsoleMenuItem -Select or -MultiSelect) whose values the preset selects (with -Selection).
-Name String requiredposition: 0: The name; a preset people save cannot take it.
-Preview Object optional: Content shown beside the list (below it when narrow) while the preset has focus: a scriptblock run once now, widgets, text (markup) or objects (as a list).
-Selection Object[] optional: The values to select in -Item: the choice objects or their texts; values the item does not offer are skipped.
-Values IDictionary optional: The values for -Form by field name: a string, a number, a bool, or a list for a multi-choice field. Values that name a choice (the object, its title or its text) take that choice.

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.