Skip to content

New-UDCheckbox

SYNOPSIS

Creates a checkbox.

SYNTAX

New-UDCheckbox [[-Id] <String>] [[-Label] <Object>] [-Checked] [-FilledIn] [-Disabled] [[-OnChange] <Object>]
 [<CommonParameters>]

DESCRIPTION

Creates a checkbox.

EXAMPLES

Checked

New-UDCheckbox -Label "Checkbox" -Checked

A checked checkbox

Disabled

New-UDCheckbox -Label "Checkbox" -Disabled

A disabled checkbox

OnChange

New-UDCheckbox -Label "Checkbox" -OnChange {
    Show-UDToast -Message $EventData
}

Displays a toast message when clicked.

PARAMETERS

-Checked

Whether the default value of the checkbox is checked.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Disabled

Whether the checkbox is disabled.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-FilledIn

Applies a filled in style to checkbox.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Id

The ID for this checkbox.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Label

The text to display next to the checkbox.

Type: System.Object
Parameter Sets: (All)
Aliases:

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

-OnChange

A script block to invoke when the value of the checkbox changes. Use the $EventData variable to get the value of the checkbox in the script block.

Type: System.Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
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

OUTPUTS

System.Object

NOTES

Back to top