Skip to content

New-UDSwitch

SYNOPSIS

Creates a switch control.

SYNTAX

New-UDSwitch [[-Id] <String>] [[-OnText] <Object>] [[-OffText] <Object>] [-Disabled] [[-OnChange] <Object>]
 [-On] [<CommonParameters>]

DESCRIPTION

Creates a switch control. Switches are similar in function to checkboxes but use a different style.

EXAMPLES

Basic Switch

New-UDSwitch -OnText "yes" -OffText "No"

Creates a switch that has yes and no as options.

OnChange

New-UDSwitch -OnText "yes" -OffText "No" -OnChange { Show-UDToast -Message $EventData }

Shows a toast when the switch is changed.

PARAMETERS

-Disabled

Whether this switch 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

-Id

The ID of this switch.

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

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

-OffText

The text displayed when this switch is in the off position.

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

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

-On

Whether this switch is on.

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

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

-OnChange

OnChange script block handler for this control.

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

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

-OnText

The text displayed when this switch is in the on position.

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

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

OUTPUTS

System.Object

NOTES

Back to top