< Back
New-BTSelectionBoxItem
Post
NAME New-BTSelectionBoxItem
SYNOPSIS
Creates a selection box item.
SYNTAX
New-BTSelectionBoxItem [-Id] <String> [-Content] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-BTSelectionBoxItem function creates a selection box item, for inclusion in a selection box created with
New-BTInput.
PARAMETERS
-Id <String>
Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with.
Can also be provided to a selection box to identify the default selection.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Content <String>
String that is displayed on the selection item. This is what the user sees.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
ToastSelectionBoxItem
NOTES
Credit for most of the help text for this function go to the authors of the UWPCommunityToolkit library that
this module relies upon.
Please see the originating repo here: https://github.com/Microsoft/UWPCommunityToolkit
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$Select1 = New-BTSelectionBoxItem -Id 'Item1' -Content 'First option in the list'
This command creates a new Selection Box Item object which can now be used with the New-BTInput function.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... BoxItem.md
SYNOPSIS
Creates a selection box item.
SYNTAX
New-BTSelectionBoxItem [-Id] <String> [-Content] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-BTSelectionBoxItem function creates a selection box item, for inclusion in a selection box created with
New-BTInput.
PARAMETERS
-Id <String>
Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with.
Can also be provided to a selection box to identify the default selection.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Content <String>
String that is displayed on the selection item. This is what the user sees.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
ToastSelectionBoxItem
NOTES
Credit for most of the help text for this function go to the authors of the UWPCommunityToolkit library that
this module relies upon.
Please see the originating repo here: https://github.com/Microsoft/UWPCommunityToolkit
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$Select1 = New-BTSelectionBoxItem -Id 'Item1' -Content 'First option in the list'
This command creates a new Selection Box Item object which can now be used with the New-BTInput function.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... BoxItem.md