Show-UDToast

Résumé

Affiche un message toast à l'utilisateur.

Syntaxe

Show-UDToast [-Message] <String> [-MessageColor <DashboardColor>] [-MessageSize <String>] [-Duration <Int32>] [-Title <String>] [-TitleColor <DashboardColor>] [-TitleSize <String>] [-Id <String>] [-BackgroundColor <DashboardColor>] [-Theme <String>] [-Icon <Object>] [-IconColor <DashboardColor>] [-Position <String>] [-HideCloseButton] [-CloseOnClick] [-CloseOnEscape] [-ReplaceToast] [-RightToLeft] [-Balloon] [-Overlay] [-OverlayClose] [-OverlayColor <DashboardColor>] [-TransitionIn <String>] [-TransitionOut <String>] [-Broadcast] [-Persistent] [<CommonParameters>]

Description

Affiche un message toast à l'utilisateur.

Paramètres

-Message

Le message à afficher.

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

-MessageColor

La couleur du texte du message.

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

-MessageSize

La taille du message.

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

-Duration

La durée en millisecondes avant que le message disparaisse.

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

-Title

Le titre à afficher.

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

-TitleColor

La couleur du texte du titre.

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

-TitleSize

La taille du titre.

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

-Id

L'ID du toast. À utiliser avec Hide-UDToast.

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

-BackgroundColor

La couleur d'arrière-plan du toast.

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

-Theme

Thème clair ou foncé.

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

-Icon

L'icône à afficher dans le toast.

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

-IconColor

La couleur de l'icône.

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

-Position

Où afficher le toast.

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

-HideCloseButton

Masque le bouton de fermeture.

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

-CloseOnClick

Ferme le toast lorsqu'on clique dessus.

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

-CloseOnEscape

Ferme le toast lorsque la touche échap est enfoncée.

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

-ReplaceToast

Remplace un toast existant si un toast est déjà affiché.

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

-RightToLeft

Texte de droite à gauche.

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

-Balloon

Crée un toast en forme de bulle.

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

-Overlay

Affiche une superposition derrière le toast.

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

-OverlayClose

Permet à l'utilisateur de fermer la superposition.

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

-OverlayColor

La couleur de la superposition.

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

-TransitionIn

L'effet de transition d'entrée.

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

-TransitionOut

L'effet de transition de sortie.

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

-Broadcast

Diffuse le toast à tous les utilisateurs connectés.

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

-Persistent

Empêche le toast de se fermer en raison de la durée.

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

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!'
} -Id 'toast1'

Toast de base Affiche un message toast.

Exemple 2 : Durée

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Duration 5000
} -Id 'toast2'

Affiche un message toast avec une durée plus longue.

Exemple 3 : Titre

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Title 'Toast Title'
} -Id 'toast3'

Affiche un message toast avec un titre.

Exemple 4 : Couleur du titre

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Title 'Toast Title' -TitleColor 'red'
} -Id 'toast4'

Affiche un message toast avec un titre et une couleur de titre rouge.

Exemple 5 : Taille du titre

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Title 'Toast Title' -TitleColor 'red' -TitleSize 'large'
} -Id 'toast5'

Affiche un message toast avec un titre, une couleur de titre rouge et une grande taille de titre.

Exemple 6 : Couleur du message

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -MessageColor 'blue'
} -Id 'toast6'

Affiche un message toast avec une couleur de message bleue.

Exemple 7 : Taille du message

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -MessageSize 'large'
} -Id 'toast7'

Affiche un message toast avec une grande taille de message.

Exemple 8 : Icône

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Icon 'check'
} -Id 'toast8'

Affiche un message toast avec une icône de coche.

Exemple 9 : Persistant

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Persistent -Id 'MyToast'
} -Id 'toast9'
New-UDButton -Text 'Hide Toast' -OnClick {
   Hide-UDToast -Id 'MyToast'
} -Id 'toast10'

Affiche un message toast qui ne se fermera pas. La commande Hide-UDToast peut être utilisée pour fermer le toast.

Exemple 10 : Position

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Position 'bottomRight'
} -Id 'toast11'

Affiche un message toast en bas à droite de l'écran.

Exemple 11 : Masquer le bouton de fermeture

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -HideCloseButton
} -Id 'toast12'

Affiche un message toast sans bouton de fermeture.

Exemple 12 : Fermer au clic

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -CloseOnClick
} -Id 'toast13'

Affiche un message toast qui se fermera lorsqu'on clique dessus.

Exemple 13 : Fermer avec la touche échap

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -CloseOnEscape
} -Id 'toast14'

Affiche un message toast qui se fermera lorsque la touche échap est enfoncée.

Exemple 14 : Remplacer le toast

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -ReplaceToast -Id "toastId"
} -Id 'toast15'

Affiche un message toast qui remplacera un toast existant. -Id est requis.

Exemple 15 : De droite à gauche

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -RightToLeft
} -Id 'toast16'

Affiche un message toast avec du texte de droite à gauche.

Exemple 16 : Bulle

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Balloon
} -Id 'toast17'

Affiche un message toast sous forme de bulle.

Exemple 17 : Superposition

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Overlay
} -Id 'toast18'

Affiche un message toast sous forme de superposition.

Exemple 18 : Thème

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -Theme 'dark'
} -Id 'toast19'

Affiche un message toast avec un thème foncé.

Exemple 19 : Couleur d'arrière-plan

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -BackgroundColor 'red'
} -Id 'toast20'

Affiche un message toast avec une couleur d'arrière-plan rouge.

Exemple 20 : Transition

New-UDButton -Text 'Show Toast' -OnClick {
   Show-UDToast -Message 'Hello, World!' -TransitionIn 'bounceInLeft' -TransitionOut 'bounceInRight'
} -Id 'toast21'

Affiche un message toast avec une transition d'entrée par rebond à gauche et une transition de sortie par rebond à droite.