< Back
New-BTVisual
Post
NAME New-BTVisual
SYNOPSIS
Creates a new visual element for toast notifications.
SYNTAX
New-BTVisual [-BindingGeneric] <ToastBindingGeneric> [[-BindingShoulderTap] <ToastBindingShoulderTap>]
[-AddImageQuery] [[-BaseUri] <Uri>] [[-Language] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-BTVisual function creates a new visual element for toast notifications, which defines all of the visual
aspects of a toast.
PARAMETERS
-BindingGeneric <ToastBindingGeneric>
The generic Toast binding, which can be rendered on all devices. This binding is created using the
New-BTBinding function.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BindingShoulderTap <ToastBindingShoulderTap>
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AddImageQuery [<SwitchParameter>]
Specify this switch to allow Windows to append a query string to the image URI supplied in the Toast
notification. Use this attribute if your server hosts images and can handle query strings, either by
retrieving an image variant based on the query strings or by ignoring the query string and returning the image
as specified without the query string. This query string specifies scale, contrast setting, and language.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-BaseUri <Uri>
A default base URI that is combined with relative URIs in image source attributes.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Language <String>
The target locale of the XML payload, specified as BCP-47 language tags such as "en-US" or "fr-FR". This
locale is overridden by any locale specified in binding or text. If this value is a literal string, this
attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to
the locale chosen by Windows Runtime in resolving the string.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
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).
INPUTS
None
OUTPUTS
ToastVisual
NOTES
Credit for most of the help text for this function go to the authors of the UWPCommunityToolkit library that
this module relies upon.
Please see the originating repo here: https://github.com/Microsoft/UWPCommunityToolkit
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-BTVisual -BindingGeneric $Binding1
This command creates a new Visual element taking a previously configured binding element as input.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... TVisual.md
SYNOPSIS
Creates a new visual element for toast notifications.
SYNTAX
New-BTVisual [-BindingGeneric] <ToastBindingGeneric> [[-BindingShoulderTap] <ToastBindingShoulderTap>]
[-AddImageQuery] [[-BaseUri] <Uri>] [[-Language] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-BTVisual function creates a new visual element for toast notifications, which defines all of the visual
aspects of a toast.
PARAMETERS
-BindingGeneric <ToastBindingGeneric>
The generic Toast binding, which can be rendered on all devices. This binding is created using the
New-BTBinding function.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BindingShoulderTap <ToastBindingShoulderTap>
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AddImageQuery [<SwitchParameter>]
Specify this switch to allow Windows to append a query string to the image URI supplied in the Toast
notification. Use this attribute if your server hosts images and can handle query strings, either by
retrieving an image variant based on the query strings or by ignoring the query string and returning the image
as specified without the query string. This query string specifies scale, contrast setting, and language.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-BaseUri <Uri>
A default base URI that is combined with relative URIs in image source attributes.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Language <String>
The target locale of the XML payload, specified as BCP-47 language tags such as "en-US" or "fr-FR". This
locale is overridden by any locale specified in binding or text. If this value is a literal string, this
attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to
the locale chosen by Windows Runtime in resolving the string.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
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).
INPUTS
None
OUTPUTS
ToastVisual
NOTES
Credit for most of the help text for this function go to the authors of the UWPCommunityToolkit library that
this module relies upon.
Please see the originating repo here: https://github.com/Microsoft/UWPCommunityToolkit
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-BTVisual -BindingGeneric $Binding1
This command creates a new Visual element taking a previously configured binding element as input.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... TVisual.md