< Back
New-BTBinding
Post
NAME New-BTBinding
SYNOPSIS
Creates a new Generic Toast Binding object.
SYNTAX
New-BTBinding [[-Children] <IToastBindingGenericChild[]>] [-AddImageQuery] [[-AppLogoOverride]
<ToastGenericAppLogo>] [[-Attribution] <ToastGenericAttributionText>] [[-BaseUri] <Uri>] [[-HeroImage]
<ToastGenericHeroImage>] [[-Language] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-BTBinding function creates a new Generic Toast Binding, where you provide text, images, and other visual
elements for your Toast notification.
PARAMETERS
-Children <IToastBindingGenericChild[]>
The contents of the body of the Toast, which can include Text (New-BTText), Image (New-BTImage), Group (not
yet implemented), and Progress Bar (New-BTProgressBar).
Also, Text elements must come before any other elements. If a Text element is placed after any other element,
an exception will be thrown when you try to retrieve the Toast XML content.
And finally, certain Text properties like HintStyle aren't supported on the root children text elements, and
only work inside a Group. If you use Group on devices without the Anniversary Update, the group content will
simply be dropped.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AddImageQuery [<SwitchParameter>]
Set to "true" 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
-AppLogoOverride <ToastGenericAppLogo>
An optional override of the logo displayed on the Toast notification.
Created using the New-BTImage function with the 'AppLogoOverride' switch.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Attribution <ToastGenericAttributionText>
New in Anniversary Update: An optional text element that is displayed as attribution text.
On devices without the Anniversary Update, this text will appear as if it's another Text element at the end of
your Children list.
Required? false
Position? 3
Default value
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? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HeroImage <ToastGenericHeroImage>
New in Anniversary Update: An optional hero image (a visually impactful image displayed on the Toast
notification).
On devices without the Anniversary Update, the hero image will simply be ignored.
Required? false
Position? 5
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? 6
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
ToastBindingGeneric
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:\\>$text1 = New-BTText -Content 'This is a test'
$text2 = New-BTText
$text3 = New-BTText -Content 'This more testing'
$progress = New-BTProgressBar -Title 'Things are happening' -Status 'Working on it' -Value 0.01
$image1 = New-BTImage -Source 'C:\\BurntToast\\Media\\BurntToast.png'
$image2 = New-BTImage -Source 'C:\\BurntToast\\Media\\BurntToast.png' -AppLogoOverride -Crop Circle
$image3 = New-BTImage -Source 'C:\\BurntToast\\Media\\BurntToast.png' -HeroImage
$binding1 = New-BTBinding -Children $text1, $text2, $text3, $image1, $progress -AppLogoOverride $image2 -HeroImage
$image3
This example uses various BurntToast functions to create a number of objects, and then create a Generic Toast
Binding using them as inputs.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... Binding.md
SYNOPSIS
Creates a new Generic Toast Binding object.
SYNTAX
New-BTBinding [[-Children] <IToastBindingGenericChild[]>] [-AddImageQuery] [[-AppLogoOverride]
<ToastGenericAppLogo>] [[-Attribution] <ToastGenericAttributionText>] [[-BaseUri] <Uri>] [[-HeroImage]
<ToastGenericHeroImage>] [[-Language] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-BTBinding function creates a new Generic Toast Binding, where you provide text, images, and other visual
elements for your Toast notification.
PARAMETERS
-Children <IToastBindingGenericChild[]>
The contents of the body of the Toast, which can include Text (New-BTText), Image (New-BTImage), Group (not
yet implemented), and Progress Bar (New-BTProgressBar).
Also, Text elements must come before any other elements. If a Text element is placed after any other element,
an exception will be thrown when you try to retrieve the Toast XML content.
And finally, certain Text properties like HintStyle aren't supported on the root children text elements, and
only work inside a Group. If you use Group on devices without the Anniversary Update, the group content will
simply be dropped.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AddImageQuery [<SwitchParameter>]
Set to "true" 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
-AppLogoOverride <ToastGenericAppLogo>
An optional override of the logo displayed on the Toast notification.
Created using the New-BTImage function with the 'AppLogoOverride' switch.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Attribution <ToastGenericAttributionText>
New in Anniversary Update: An optional text element that is displayed as attribution text.
On devices without the Anniversary Update, this text will appear as if it's another Text element at the end of
your Children list.
Required? false
Position? 3
Default value
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? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HeroImage <ToastGenericHeroImage>
New in Anniversary Update: An optional hero image (a visually impactful image displayed on the Toast
notification).
On devices without the Anniversary Update, the hero image will simply be ignored.
Required? false
Position? 5
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? 6
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
ToastBindingGeneric
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:\\>$text1 = New-BTText -Content 'This is a test'
$text2 = New-BTText
$text3 = New-BTText -Content 'This more testing'
$progress = New-BTProgressBar -Title 'Things are happening' -Status 'Working on it' -Value 0.01
$image1 = New-BTImage -Source 'C:\\BurntToast\\Media\\BurntToast.png'
$image2 = New-BTImage -Source 'C:\\BurntToast\\Media\\BurntToast.png' -AppLogoOverride -Crop Circle
$image3 = New-BTImage -Source 'C:\\BurntToast\\Media\\BurntToast.png' -HeroImage
$binding1 = New-BTBinding -Children $text1, $text2, $text3, $image1, $progress -AppLogoOverride $image2 -HeroImage
$image3
This example uses various BurntToast functions to create a number of objects, and then create a Generic Toast
Binding using them as inputs.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... Binding.md