New-UDCheckBox

Synopsis

Crée une case à cocher.

Syntaxe

New-UDCheckBox [[-Label] <String>] [[-Icon] <Object>] [[-CheckedIcon] <Object>] [[-OnChange] <Endpoint>] [[-Style] <Hashtable>] [[-Disabled]] [[-Checked] <Boolean>] [[-ClassName] <String>] [[-LabelPlacement] <String>] [[-Id] <String>] [[-Size] <String>] [-Color <String>] [-Indeterminate] [<CommonParameters>]

Description

Crée une case à cocher. Les cases à cocher peuvent être utilisées dans des formulaires ou seules.

Paramètres

-Label

L'étiquette à afficher à côté de la case à cocher.

Required?                    false
Position?                    1
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Icon

L'icône à afficher au lieu de l'icône par défaut. Utilisez New-UDIcon pour créer une icône.

Required?                    false
Position?                    2
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-CheckedIcon

L'icône à afficher au lieu de l'icône cochée par défaut. Utilisez New-UDIcon pour créer une icône.

Required?                    false
Position?                    3
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-OnChange

Appelé lorsque la valeur de la case à cocher change. La variable $EventData contiendra la valeur actuelle de la case à cocher.

Required?                    false
Position?                    4
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Style

Une table de hachage de styles à appliquer à la case à cocher.

Required?                    false
Position?                    5
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Disabled

Indique si la case à cocher est désactivée.

Required?                    false
Position?                    6
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Checked

Indique si la case à cocher est cochée.

Required?                    false
Position?                    7
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ClassName

Une classe CSS à assigner à la case à cocher.

Required?                    false
Position?                    8
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-LabelPlacement

Où placer l'étiquette. Les valeurs valides sont : "top","start","bottom","end"

Required?                    false
Position?                    8
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Id

L'ID du composant. Il s'agit par défaut d'un GUID aléatoire.

Required?                    false
Position?                    9
Default value                ([Guid]::NewGuid()).ToString()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Size

La taille de la case à cocher. Les valeurs valides sont : "small", "medium"

Required?                    false
Position?                    10
Default value                medium
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Color

La couleur du thème à appliquer à ce composant

Required?                    false
Position?                    named
Default value                default
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Indeterminate

Indique si la case à cocher est dans un état indéterminé. Il s'agit uniquement d'un état visuel qui n'affecte pas la valeur de la case à cocher.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

Paramètres communs

Cette applet de commande prend en charge les paramètres communs : Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable et OutVariable. Pour plus d'informations, consultez about_CommonParameters.

Sorties

Exemples

Exemple 1 : Case à cocher de base

New-UDCheckbox -Label 'Demo' -Id 'checkbox1'

Une case à cocher de base.

Exemple 2 : Case à cocher désactivée

New-UDCheckbox -Label 'Demo' -Disabled -Id 'checkbox2'

Une case à cocher désactivée.

Exemple 3 : Case à cocher cochée

New-UDCheckbox -Label 'Demo' -Checked $true -Id 'checkbox3'

Une case à cocher cochée.

Exemple 4 : Case à cocher avec icônes personnalisées

New-UDCheckbox -Label 'Demo' -Icon (New-UDIcon -Icon 'user') -CheckedIcon (New-UDIcon -Icon 'check') -Id 'checkbox4'

Une case à cocher avec des icônes personnalisées.

Exemple 5 : Case à cocher avec OnChange

New-UDCheckbox -Label 'Demo' -OnChange {
    Show-UDToast -Title 'Checkbox' -Message $Body
} -Id 'checkbox5'

Une case à cocher avec un événement OnChange.

Exemple 6 : Case à cocher avec l'étiquette au-dessus

New-UDCheckbox -Label 'Demo' -LabelPlacement 'top' -Id 'checkbox6'

Une case à cocher avec l'étiquette au-dessus.

Exemple 7 : Case à cocher avec la couleur secondaire

New-UDCheckbox -Label 'Demo' -Color 'secondary' -Id 'checkbox7'

Une case à cocher avec la couleur secondaire.

Exemple 8 : Case à cocher dans un état indéterminé

New-UDCheckbox -Label 'Demo' -Id 'checkbox8' -Indeterminate

Une case à cocher dans un état indéterminé.