> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/powershell-commands/new-udswitch.md). # New-UDSwitch ### Synopsis Creates a new switch. ### Syntax ```powershell New-UDSwitch [[-Id] ] [-Disabled] [[-OnChange] ] [[-Checked] ] [[-ClassName] ] [[-Color] ] [[-Label] ] [[-LabelComponent] ] [[-CheckedLabel] ] [[-CheckedLabelComponent] ] [[-UncheckedLabel] ] [[-UncheckedLabelComponent] ] [[-Size] ] [[-LabelPlacement] ] [-CheckStyle] [[-Sx] ] [[-Style] ] [] ``` ### Description Creates a new switch. A switch behaves like a checkbox but looks a little different. ### Parameters #### -Id The ID of the component. It defaults to a random GUID. ``` Required? false Position? 1 Default value ([Guid]::NewGuid()) Accept pipeline input? false Aliases Accept wildcard characters? false -Disabled [] Whether this switch is disabled. Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -OnChange A script block that is called when this switch changes. The $EventData variable will contain the checked value ($true$false). ``` Required? false Position? 2 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Checked Whether this switch is checked. ``` Required? false Position? 3 Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -ClassName A CSS class to apply to the switch. ``` Required? false Position? 4 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Color The theme color to apply to this switch. ``` Required? false Position? 5 Default value default Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Label The label to display next to the switch ``` Required? false Position? 6 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -LabelComponent ``` Required? false Position? 7 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -CheckedLabel The label to display for when the switch is checked ``` Required? false Position? 8 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -CheckedLabelComponent ``` Required? false Position? 9 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -UncheckedLabel The label to display for when the switch is unchecked ``` Required? false Position? 10 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -UncheckedLabelComponent ``` Required? false Position? 11 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Size The size of the switch. Valid values are: "small", "medium" ``` Required? false Position? 12 Default value medium Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -LabelPlacement The placement of the label. Valid values are: "top", "start", "right", "bottom" ``` Required? false Position? 13 Default value Accept pipeline input? false Aliases Accept wildcard characters? false -CheckStyle [] Style switch with check and unchecked icons for the colorblind. Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Sx A hashtable of theme-based styles to apply to the switch. ``` Required? false Position? 14 Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Style A hashtable of styles to apply to the switch. ``` Required? false Position? 15 Default value Accept pipeline input? false Aliases Accept wildcard characters? false 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). ``` ### Outputs \-------------------------- EXAMPLE 1 -------------------------- ``` PS >New-UDSwitch -Id 'switch1' -Checked $true Basic switch|Creates a basic switch. -------------------------- EXAMPLE 2 -------------------------- PS >New-UDSwitch -Id 'switch2' -Checked $true -OnChange { PS > Show-UDToast -Message "Switch changed to $($EventData)" PS > } OnChange|Creates a switch with an OnChange script block. -------------------------- EXAMPLE 3 -------------------------- PS >New-UDSwitch -Id 'switch3' -Disabled Disabled|Creates a disabled switch. -------------------------- EXAMPLE 4 -------------------------- PS >New-UDSwitch -Id 'switch4' -Checked $true -Label 'On' -UncheckedLabel 'Off' Label|Creates a switch with a label. -------------------------- EXAMPLE 5 -------------------------- PS >New-UDSwitch -Id 'switch5' -Checked $true -Label 'On' -UncheckedLabel 'Off' -LabelPlacement 'bottom' Label Placement|Creates a switch with a label and a label placement. -------------------------- EXAMPLE 6 -------------------------- PS >New-UDSwitch -Id 'switch6' -Checked $true -Label 'On' -UncheckedLabel 'Off' -LabelPlacement 'bottom' -CheckStyle Check Style|Creates a switch with a label, a label placement, and a check style. ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/powershell-universal/powershell-commands/new-udswitch.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.