New-AMChoice

New-AMChoice

New-AMChoice

SYNOPSIS

Creates a choice object for use in a ChoiceSet.

SYNTAX

1

New-AMChoice [-Title] <String> [-Value] <String> [-Verbose <SwitchParameter>] [-Debug <SwitchParameter>] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-InformationAction <ActionPreference>] [-ProgressAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-InformationVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>] [-PipelineVariable <String>] [<CommonParameters>]

DESCRIPTION

The New-AMChoice function creates a choice option to be used in a ChoiceSetInput element. Each choice represents an individual option that can be selected by users in dropdown lists, radio buttons, or checkbox groups within an Adaptive Card.

Choice objects must be created using this function before being passed to the New-AMChoiceSetInput function as the -Choices parameter.

The Title parameter specifies the text displayed to the user, while the Value parameter specifies the data submitted when the choice is selected. This separation allows you to display user-friendly text while submitting more compact or standardized values in your form data.

EXAMPLES

EXAMPLE 1

1
2

# Create a single choice
$choice = New-AMChoice -Title "Red" -Value "red"

EXAMPLE 2

1
2
3
4
5
6
7

# Create multiple choices for a dropdown list
$colors = @(
    New-AMChoice -Title "Red" -Value "red"
    New-AMChoice -Title "Green" -Value "green"
    New-AMChoice -Title "Blue" -Value "blue"
)
$colorPicker = New-AMChoiceSetInput -Id "favoriteColor" -Label "Select your favorite color:" -Choices $colors

EXAMPLE 3

1
2
3
4
5
6
7

# Create yes/no choices
$yesNoChoices = @(
    New-AMChoice -Title "Yes, I approve" -Value "approve"
    New-AMChoice -Title "No, I reject" -Value "reject"
)
$approvalInput = New-AMChoiceSetInput -Id "approval" -Label "Do you approve this request?" `
    -Choices $yesNoChoices -Style "expanded" -IsMultiSelect $false

PARAMETERS

-Title

The text to display for this choice option in the user interface. This is what users will see in the dropdown list, checkbox, or radio button.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

The value to be submitted when this choice is selected. This is the data that will be sent back when the card is submitted and may be different from the displayed title.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None. You cannot pipe input to New-AMChoice.

OUTPUTS

System.Collections.Hashtable

Returns a hashtable with title and value properties that can be used in a choice set.

NOTES

  • The Title is what appears in the UI, while the Value is what gets submitted with the form data.
  • This separation allows you to display user-friendly text while submitting more compact or standardized values in your form data.
  • This function is typically used in conjunction with New-AMChoiceSetInput to create dropdowns, radio buttons, or checkbox groups.