Comment on page
Add-BTHeroImage
Adds a large hero image to the top of a toast notification.
Add-BTHeroImage -ContentBuilder <ToastContentBuilder> [[-Source] <String>] [-AlternateText <String>]
[-IgnoreCache] [-PassThru] [<CommonParameters>]
The Add-BTHeroImage function specifies an image to be displayed across the top of a toast notification.
$Builder = New-BTContentBuilder
Add-BTHeroImage -ContentBuilder $Builder -Source 'C:\Temp\LocalImage.png'
This example adds a local image as the hero image on the toast notification using a toast content builder object.
$Builder = New-BTContentBuilder
$Builder | Add-BTHeroImage -Source '\\\\FS01\Images$\NetworkImage.gif'
This example adds an image from a network share as the hero image on the toast notification being constructed.
$Builder = New-BTContentBuilder
$Builder | Add-BTHeroImage -Source 'https://example.com/OnlineImage.jpeg'
This example adds an image from the internet as the hero image on the toast notification being constructed.
Future invocations of this example will used a cached copy of the referenced image rather than going out to the internet again.
$Builder = New-BTContentBuilder
$Builder | Add-BTHeroImage -Source 'https://example.com/OnlineImage.jpeg' -IgnoreCache
This example adds an image from the internet as the hero image on the toast notification being constructed, it downloads the image from the internet regardless of if it has been previously cached.
$Builder = New-BTContentBuilder
$Builder | Add-BTHeroImage -Source 'C:\Temp\LocalImage.png' -AlternateText 'Picture of burnt toast, popped out of a toaster'
This example adds a local image as the hero image on the toast notification with supplied alt text to aid with accessibility e.g. the use of screen readers.
$Builder = New-BTContentBuilder
$Builder | Add-BTHeroImage -Source 'C:\Temp\LocalImage.png' -PassThru |
Add-BTText -Text 'First Line of Text' -PassThru |
Add-BTText -Text 'Second Line of Text'
This example adds a hero image followed by three custom text elements to a toast content builder object on the pipeline by passing through a refference to the builder object.
The toast content builder object that represents the toast notification being constructed.
Type: ToastContentBuilder
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
The URI of the image. Can be from your local computer, network location, or the internet. Online images will be downloaded and cached in the user's TEMP directory for future use.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
A description of the image, for users of assistive technologies.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify that the online images should be downloaded, regardless of if they have been cached to the TEMP directory. Used when the online resource has been updated and you need to ensure that users see the latest version.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Returns an object that represents the item with which you're working. By default, this cmdlet doesn't generate any output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe a toast content builder object to Add-BTHeroImage.
One image reference can be provided, this cannot be piped to Add-BTHeroImage.
The Add-BTHeroImage function does not provide any output by default.
You can optionally use the PassThru parameter to output the updated toast content builder object, which enables chaining functions together.
You can reference an image from your local computer, a network location, or the internet.
Online images will be downloaded and cached in the user's TEMP directory for future use.
Animated GIFs and images with transparent background are supported.
Last modified 6mo ago