BurntToast

https://github.com/windos/burnttoast
Admin
BurntToast is a PowerShell module for displaying Toast Notifications on Windows 10 and Windows...
Tokens:22,518
Snippets:257
Trust Score:9.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install BurntToast via PowerShell Gallery

Source: https://github.com/windos/burnttoast/blob/main/README.md

Use this command to install the BurntToast module from the PowerShell Gallery.

```powershell
Install-Module -Name BurntToast
```

--------------------------------

### Install BurntToast via Chocolatey

Source: https://github.com/windos/burnttoast/blob/main/README.md

Use this command to install the BurntToast module using the Chocolatey package manager.

```powershell
choco install burnttoast-psmodule
```

--------------------------------

### Get headers by Title

Source: https://github.com/windos/burnttoast/blob/main/Help/Get-BTHeader.md

Filters and returns headers that match the specified title.

```powershell
Get-BTHeader -Title "Stack Overflow Questions"
```

--------------------------------

### Create a single column with New-BTColumn

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTColumn.md

Creates a single column containing a text element and passes it to New-BTBinding. Note that the column is also passed as a child to the binding, which may be redundant but is shown in the example.

```powershell
$label = New-BTText -Text 'Now Playing'
$col = New-BTColumn -Children $label
New-BTBinding -Children $label -Column $col
```

--------------------------------

### Get all toast notification headers

Source: https://github.com/windos/burnttoast/blob/main/Help/Get-BTHeader.md

Returns all unique toast notification headers currently present in the Action Center.

```powershell
Get-BTHeader
```

--------------------------------

### Get headers by Id

Source: https://github.com/windos/burnttoast/blob/main/Help/Get-BTHeader.md

Returns the header that matches the specified header ID.

```powershell
Get-BTHeader -Id "001"
```

--------------------------------

### New-BTButton -ImageUri

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTButton.md

Creates a button with a picture to the left that launches the image file when clicked.

```powershell
$pic = 'C:\temp\example.png'
New-BTButton -Content 'View Picture' -Arguments $pic -ImageUri $pic
```

--------------------------------

### Create a context menu item for a URL

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTContextMenuItem.md

Creates a menu item labeled "Website" that opens a URL on right-click.

```powershell
New-BTContextMenuItem -Content 'Website' -Arguments 'https://example.com' -ActivationType Protocol
```

--------------------------------

### New-BTAction with button and context menu item

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTAction.md

Creates an action set with both a clickable button and a context menu item using New-BTButton and New-BTContextMenuItem.

```powershell
$Button = New-BTButton -Content 'Google' -Arguments 'https://google.com'
$ContextMenuItem = New-BTContextMenuItem -Content 'Bing' -Arguments 'https://bing.com'
New-BTAction -Buttons $Button -ContextMenuItems $ContextMenuItem
```

--------------------------------

### Create a toast header with ID and arguments

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTHeader.md

Creates a header with ID '001' and links activation to a URL.

```powershell
New-BTHeader -Id '001' -Title 'Stack Overflow Questions' -Arguments 'http://stackoverflow.com/'
```

--------------------------------

### Create a basic ToastContent object

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTContent.md

Demonstrates the creation of a basic toast content object by defining a binding with text and a visual container.

```powershell
$binding = New-BTBinding -Children (New-BTText -Content 'Title')
$visual = New-BTVisual -BindingGeneric $binding
New-BTContent -Visual $visual
```

--------------------------------

### Get headers by ToastUniqueIdentifier

Source: https://github.com/windos/burnttoast/blob/main/Help/Get-BTHeader.md

Returns headers associated with a specific toast notification unique identifier.

```powershell
Get-BTHeader -ToastUniqueIdentifier 'Toast001'
```

--------------------------------

### Create a ToastContent with Protocol activation

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTContent.md

Configures a toast to open a specific URL in a browser when the user clicks the toast body.

```powershell
$content = New-BTContent -Visual $visual -ActivationType Protocol -Launch 'https://example.com'
```

--------------------------------

### New-BTButton -Content -Arguments

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTButton.md

Creates a regular button that opens a URL when clicked.

```powershell
New-BTButton -Content 'Blog' -Arguments 'https://king.geek.nz'
```

--------------------------------

### New-BTAction with single button (New-BTButton)

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTAction.md

Creates an action set with a single button that opens the specified Google URL.

```powershell
New-BTAction -Buttons (New-BTButton -Content 'Google' -Arguments 'https://google.com')
```

--------------------------------

### New-BTImage -HeroImage

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTImage.md

Creates a hero image for the toast header. Uses the HeroImage switch to mark the image as prominently displayed.

```powershell
$image3 = New-BTImage -Source 'C:\Media\BurntToast.png' -HeroImage
```

--------------------------------

### New-BTAction with input (New-BTText)

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTAction.md

Creates an action set allowing user textual input in the notification.

```powershell
New-BTAction -Inputs (New-BTText -Content "Add comment")
```

--------------------------------

### New-BTAudio with custom audio file

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTAudio.md

Creates an audio object that plays a custom audio file for a Toast Notification. Use this when you want a specific song or audio file.

```powershell
New-BTAudio -Source 'C:\Music\FavSong.mp3'
```

--------------------------------

### Create shortcut with custom AppId and icon

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTShortcut.md

Creates a PowerShell shortcut with a custom AppId and icon on the Desktop. Prefers pwsh.exe if available.

```powershell
New-BTShortcut -AppId "Acme.MyApp" -DisplayName "My App PowerShell" -IconPath "C:\Path\To\MyIcon.ico"
```

--------------------------------

### Create a selection input with New-BTInput

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTInput.md

Creates a selection (dropdown) input with two options. Uses the Selection parameter set with DefaultSelectionBoxItemId and Items.

```powershell
New-BTInput -Id 'Choice' -DefaultSelectionBoxItemId 'Item2' -Items $Sel1, $Sel2
```

--------------------------------

### New-BTImage -AppLogoOverride -Crop Circle

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTImage.md

Creates a cropped circular app logo for the toast. Requires the AppLogoOverride switch and uses the Crop parameter set to Circle.

```powershell
$image2 = New-BTImage -Source 'C:\Media\BurntToast.png' -AppLogoOverride -Crop Circle
```

--------------------------------

### Create a text element with content

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTText.md

Creates a text element that will show the specified string in a Toast Notification.

```powershell
New-BTText -Content 'This is a line with text!'
```

--------------------------------

### New-BTImage -Source (standard image)

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTImage.md

Creates a standard image element for a toast body. The Source parameter accepts a local file path or URI.

```powershell
$image1 = New-BTImage -Source 'C:\Media\BurntToast.png'
```

--------------------------------

### Create a progress bar with custom label

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTProgressBar.md

Creates a progress bar at 20% completion with a custom label string instead of the default percentage.

```powershell
New-BTProgressBar -Status 'Copying files' -Value 0.2 -ValueDisplay '4/20 files complete'
```

--------------------------------

### Create a simple toast header

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTHeader.md

Creates a header with the title 'First Category' for categorizing toasts.

```powershell
New-BTHeader -Title 'First Category'
```

--------------------------------

### Create a text input field with New-BTInput

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTInput.md

Creates a text input field on the toast. Uses the Text parameter set with Id and Title.

```powershell
New-BTInput -Id 'Reply001' -Title 'Type a reply:'
```

--------------------------------

### New-BTContent

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTContent.md

Creates a new Toast Content object (base element for displaying a toast). This function is the root config for a toast, containing the toast's visual, actions, audio, header, scenario, etc.

```APIDOC
## New-BTContent

### Description
Creates a new Toast Content object (base element for displaying a toast). This function is the root config for a toast, containing the toast's visual, actions, audio, header, scenario, etc.

### Syntax
```powershell
New-BTContent [-Visual] <ToastVisual> [[-Actions] <IToastActions>] [[-ActivationType] <ToastActivationType>] [[-Audio] <ToastAudio>] [[-Duration] <ToastDuration>] [[-Header] <ToastHeader>] [[-Launch] <String>] [[-Scenario] <ToastScenario>] [[-ToastPeople] <ToastPeople>] [[-CustomTimestamp] <DateTime>]
```

### Parameters
- **Visual** (Microsoft.Toolkit.Uwp.Notifications.ToastVisual) - Required - ToastVisual object, created by `New-BTVisual`, representing the core content of the toast.
- **Actions** (Microsoft.Toolkit.Uwp.Notifications.IToastActions) - Optional - Contains one or more custom actions (buttons, context menus, input fields), created via `New-BTAction`.
- **ActivationType** (Microsoft.Toolkit.Uwp.Notifications.ToastActivationType) - Optional - Enum. Specifies what activation type is used when the user clicks the toast body.
- **Audio** (Microsoft.Toolkit.Uwp.Notifications.ToastAudio) - Optional - Adds audio properties for the toast, as created by `New-BTAudio`.
- **Duration** (Microsoft.Toolkit.Uwp.Notifications.ToastDuration) - Optional - Enum. How long the toast notification is displayed (Short/Long).
- **Header** (Microsoft.Toolkit.Uwp.Notifications.ToastHeader) - Optional - ToastHeader object, created via `New-BTHeader`, categorizing the toast in Action Center.
- **Launch** (String) - Optional - Data passed to the activation context when a toast is clicked.
- **Scenario** (Microsoft.Toolkit.Uwp.Notifications.ToastScenario) - Optional - Enum. Tells Windows to treat the toast as an alarm, reminder, or more (`ToastScenario`). If the `IncomingCall` scenario is used, any main body text (no longer than a single line) will be center aligned. Will be ignored if toast is submitted with `-Urgent` switch on the `Submit-BTNotification` function, as the Urgent scenario takes precedence but cannot be set via this parameter.
- **ToastPeople** (Microsoft.Toolkit.Uwp.Notifications.ToastPeople) - Optional - ToastPeople object, representing recipient/persons (optional, used for group chat/etc).
- **CustomTimestamp** (DateTime) - Optional - Optional timestamp for when the toast is considered created (affects Action Center sort order).

### Inputs
None. You cannot pipe input to this function.

### Outputs
Microsoft.Toolkit.Uwp.Notifications.ToastContent

### Examples
#### Example 1
```powershell
$binding = New-BTBinding -Children (New-BTText -Content 'Title')
$visual = New-BTVisual -BindingGeneric $binding
New-BTContent -Visual $visual
```

#### Example 2
```powershell
$content = New-BTContent -Visual $visual -ActivationType Protocol -Launch 'https://example.com'
```
Toast opens a browser to a URL when clicked.

### Related Links
- [New-BTAction](New-BTAction.md)
- [New-BTAudio](New-BTAudio.md)
- [New-BTHeader](New-BTHeader.md)
- [New-BTVisual](New-BTVisual.md)
- [New-BTBinding](New-BTBinding.md)
```

--------------------------------

### Create default shortcut with AppId

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTShortcut.md

Creates a default shortcut with AppUserModelID, desktop location, and default icon. Prefers pwsh.exe if available.

```powershell
New-BTShortcut -AppId "Acme.MyApp"
```

--------------------------------

### Create weighted columns with New-BTColumn

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTColumn.md

Creates two columns with different weights (4 and 6) and passes them to New-BTBinding for side-by-side layout. Use when you need to control the relative width of columns in a toast notification.

```powershell
$labels = New-BTText -Text 'Title:' -Style Base
$values = New-BTText -Text 'Example' -Style BaseSubtle
$col1 = New-BTColumn -Children $labels -Weight 4
$col2 = New-BTColumn -Children $values -Weight 6
New-BTBinding -Column $col1, $col2
```

--------------------------------

### Create a progress bar with title

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTProgressBar.md

Creates a progress bar that includes an optional title above the status text.

```powershell
New-BTProgressBar -Title 'File Copy' -Status 'Copying files' -Value 0.2
```

--------------------------------

### New-BTBinding

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTBinding.md

Creates a new Generic Toast Binding object with configurable children, columns, and visual options.

```APIDOC
## New-BTBinding

### Description
Creates a new Generic Toast Binding object, in which you provide text, images, columns, progress bars, and more, controlling the visual appearance of the notification.

### Syntax
New-BTBinding [-Children] <IToastBindingGenericChild[]> [-Column] <AdaptiveSubgroup[]> [-AddImageQuery] [-AppLogoOverride] [-Attribution] [-BaseUri] [-HeroImage] [-Language]

### Parameters
#### Children
- Type: Microsoft.Toolkit.Uwp.Notifications.IToastBindingGenericChild[]
- Mandatory: No
- Description: Array of binding children elements to include, such as Text, Image, Group, or Progress Bar objects, created by other BurntToast functions (New-BTText, New-BTImage, New-BTProgressBar, etc.).

#### Column
- Type: Microsoft.Toolkit.Uwp.Notifications.AdaptiveSubgroup[]
- Mandatory: No
- Description: Array of AdaptiveSubgroup elements (columns), created via New-BTColumn, to display content side by side.

#### AddImageQuery
- Type: Switch
- Mandatory: No
- Description: Allows Windows to append a query string to image URIs for scale/language support; only needed for remote images.

#### AppLogoOverride
- Type: Microsoft.Toolkit.Uwp.Notifications.ToastGenericAppLogo
- Mandatory: No
- Description: Optional override for the logo displayed, created with New-BTImage using the AppLogoOverride switch.

#### Attribution
- Type: Microsoft.Toolkit.Uwp.Notifications.ToastGenericAttributionText
- Mandatory: No
- Description: Optional attribution text. Only supported on modern Windows versions.

#### BaseUri
- Type: Uri
- Mandatory: No
- Description: A URI that is combined with relative image URIs for images in the notification.

#### HeroImage
- Type: Microsoft.Toolkit.Uwp.Notifications.ToastGenericHeroImage
- Mandatory: No
- Description: Optional hero image object, created with New-BTImage using the HeroImage switch.

#### Language
- Type: String
- Mandatory: No
- Description: Specifies the locale (e.g. "en-US" or "fr-FR") for the binding and contained text.

### Inputs
None. You cannot pipe input to this function.

### Outputs
Microsoft.Toolkit.Uwp.Notifications.ToastBindingGeneric

### Examples
#### Example 1
```powershell
$text1 = New-BTText -Content 'This is a test'
$image1 = New-BTImage -Source 'C:\BurntToast\Media\BurntToast.png'
$binding = New-BTBinding -Children $text1, $image1
```
Combines text and image into a binding for use in a visual toast.

#### Example 2
```powershell
$progress = New-BTProgressBar -Title 'Updating' -Status 'Running' -Value 0.4
$binding = New-BTBinding -Children $progress
```
Includes a progress bar element in the binding.

#### Example 3
```powershell
$col1 = New-BTColumn -Children (New-BTText -Text 'a')
$col2 = New-BTColumn -Children (New-BTText -Text 'b')
$binding = New-BTBinding -Column $col1, $col2
```
Uses two columns to display content side by side.

### Related Links
- New-BTText
- New-BTImage
- New-BTColumn
- New-BTProgressBar
```

--------------------------------

### New-BTInput

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTInput.md

Creates an input element (text box or selection box) for a Toast notification. Use the Text parameter set for a type-in input, and the Selection parameter set with a set of options for pick list behavior.

```APIDOC
## New-BTInput

### Description
Creates an input element (text box or selection box) for a Toast notification. Use the Text parameter set for a type-in input, and the Selection parameter set with a set of options for pick list behavior.

### Syntax
```powershell
New-BTInput [-Id] <String> [-Title <String>] [-PlaceholderContent <String>] [-DefaultInput <String>] [<CommonParameters>]

New-BTInput [-Id] <String> [-Title <String>] [-DefaultSelectionBoxItemId <String>] -Items <ToastSelectionBoxItem[]> [<CommonParameters>]
```

### Parameters
#### Id (String) - Mandatory
Developer-provided ID for referencing this input/result.

#### Title (String) - Optional
Text to display above the input box or selection.

#### PlaceholderContent (String) - Optional (Text set only)
String placeholder to show when the text box is empty.

#### DefaultInput (String) - Optional
Default text to pre-fill in the text box.

#### DefaultSelectionBoxItemId (String) - Optional
ID of the default selection item (must match one of the provided SelectionBoxItems).

#### Items (Microsoft.Toolkit.Uwp.Notifications.ToastSelectionBoxItem[]) - Mandatory (when using 'Selection' set)
Array of ToastSelectionBoxItem objects to populate the pick list.

### Inputs
None. You cannot pipe input to this function.

### Outputs
- Microsoft.Toolkit.Uwp.Notifications.ToastTextBox
- Microsoft.Toolkit.Uwp.Notifications.ToastSelectionBox

### Examples
#### Example 1
```powershell
New-BTInput -Id 'Reply001' -Title 'Type a reply:'
```
Creates a text input field on the toast.

#### Example 2
```powershell
New-BTInput -Id 'Choice' -DefaultSelectionBoxItemId 'Item2' -Items $Sel1, $Sel2
```
Creates a selection (dropdown) input with two options.

### Links
- [New-BTAction](New-BTAction.md)
- [New-BTSelectionBoxItem](New-BTSelectionBoxItem.md)
- [New-BTText](New-BTText.md)
```

--------------------------------

### Create a Toast Visual with a generic binding

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTVisual.md

Creates a Toast Visual object using a mandatory ToastBindingGeneric object.

```powershell
New-BTVisual -BindingGeneric $Binding1
```

--------------------------------

### New-BTAudio with built-in sound

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTAudio.md

Creates an audio object that plays the standard Microsoft 'SMS' sound for a Toast Notification. Use this when you want a built-in notification sound.

```powershell
New-BTAudio -Source ms-winsoundevent:Notification.SMS
```

--------------------------------

### New-BTButton -Dismiss

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTButton.md

Creates a button that mimics swiping away the toast when clicked.

```powershell
New-BTButton -Dismiss
```

--------------------------------

### New-BTShortcut

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTShortcut.md

Creates a Windows shortcut with a custom AppUserModelID for toast notification branding. Supports optional icon, display name, and custom executable.

```APIDOC
## New-BTShortcut

### Description
Creates a Windows shortcut for launching PowerShell or a compatible host with a custom AppUserModelID, enabling full toast notification branding (name & icon).

### Syntax
New-BTShortcut -AppId <String> [-ShortcutPath <String>] [-DisplayName <String>] [-IconPath <String>] [-ForceWindowsPowerShell] [-ExecutablePath <String>]

### Parameters
- **AppId** (String) - Required - The AppUserModelID to set on the shortcut (should match the value registered with New-BTAppId).
- **ShortcutPath** (String) - Optional - Path where the shortcut (.lnk) will be created. Defaults to Desktop.
- **DisplayName** (String) - Optional - Friendly display name/description for the shortcut.
- **IconPath** (String) - Optional - Path to the icon image to use for the shortcut (should match icon registered for AppId).
- **ForceWindowsPowerShell** (Switch) - Optional - Forces the shortcut to use Windows PowerShell (powershell.exe), even if PowerShell 7+ (pwsh.exe) is available. Cannot be used with ExecutablePath.
- **ExecutablePath** (String) - Optional - The absolute path to a custom executable (pwsh.exe, powershell.exe, or another PowerShell host). Cannot be used with ForceWindowsPowerShell.

### Inputs
None. You cannot pipe input to this function.

### Outputs
System.IO.FileInfo (Returns the path to the created shortcut file).

### Examples
#### Example 1
```powershell
New-BTShortcut -AppId "Acme.MyApp" -DisplayName "My App PowerShell" -IconPath "C:\Path\To\MyIcon.ico"
```
Creates a PowerShell shortcut with custom AppId and icon on the Desktop. Prefers pwsh.exe if available.

#### Example 2
```powershell
New-BTShortcut -AppId "Acme.MyApp"
```
Creates a default shortcut with AppUserModelID, desktop location, and default icon. Prefers pwsh.exe if available.

#### Example 3
```powershell
New-BTShortcut -AppId "Acme.MyApp" -ForceWindowsPowerShell
```
Forces the shortcut to always launch Windows PowerShell (powershell.exe).

#### Example 4
```powershell
New-BTShortcut -AppId "Acme.MyApp" -ExecutablePath "C:\CustomHost\CustomHost.exe"
```
Uses the specified executable as the shortcut target.

### Notes
After creating the shortcut, launch PowerShell exclusively via this shortcut to guarantee Windows uses your custom name and icon for actionable toast notifications. This works for pwsh.exe (PowerShell 7+), powershell.exe (Windows PowerShell), or any compatible host.

### Related Links
- New-BTAppId
```

--------------------------------

### New-BTButton -Color Green

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTButton.md

Creates a 'Success' style (green) button intended for positive actions.

```powershell
New-BTButton -Content 'Approve' -Arguments 'approve' -Color Green
```

--------------------------------

### New-BTAction

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTAction.md

Creates a Toast action set for a Toast Notification. Supports custom buttons, context menu items, inputs, or a system-handled Snooze and Dismiss set.

```APIDOC
## New-BTAction

### Description
Creates a Toast action set for a Toast Notification. The function returns an IToastActions object defining the controls displayed at the bottom of the notification.

### Syntax
New-BTAction [-Buttons <IToastButton[]>] [-ContextMenuItems <ToastContextMenuItem[]>] [-Inputs <IToastInput[]>] [-SnoozeAndDismiss <Switch>]

### Parameters
#### Buttons
- **Type**: Microsoft.Toolkit.Uwp.Notifications.IToastButton[]
- **Mandatory**: No
- **Description**: Button objects created with New-BTButton. Up to five may be included, or fewer if context menu items are also included.

#### ContextMenuItems
- **Type**: Microsoft.Toolkit.Uwp.Notifications.ToastContextMenuItem[]
- **Mandatory**: No
- **Description**: Right-click context menu item objects created with New-BTContextMenuItem. Up to five may be included, or fewer if Buttons are included.

#### Inputs
- **Type**: Microsoft.Toolkit.Uwp.Notifications.IToastInput[]
- **Mandatory**: No
- **Description**: Input objects created via New-BTText and New-BTSelectionBoxItem. Up to five can be included.

#### SnoozeAndDismiss
- **Type**: Switch
- **Mandatory**: Yes (when using 'SnoozeAndDismiss' set)
- **Description**: Creates a system-handled set of Snooze and Dismiss buttons. Only available in the 'SnoozeAndDismiss' parameter set. Cannot be used with custom actions.

### Inputs
None. You cannot pipe input to this function.

### Outputs
Microsoft.Toolkit.Uwp.Notifications.IToastActions

### Examples
#### Example 1
```powershell
New-BTAction -SnoozeAndDismiss
```
Creates an action set using the system handled snooze and dismiss modal.

#### Example 2
```powershell
New-BTAction -Buttons (New-BTButton -Content 'Google' -Arguments 'https://google.com')
```
Creates an action set with a single button that opens Google.

#### Example 3
```powershell
$Button = New-BTButton -Content 'Google' -Arguments 'https://google.com'
$ContextMenuItem = New-BTContextMenuItem -Content 'Bing' -Arguments 'https://bing.com'
New-BTAction -Buttons $Button -ContextMenuItems $ContextMenuItem
```
Creates an action set with both a clickable button and a context menu item.

#### Example 4
```powershell
New-BTAction -Inputs (New-BTText -Content "Add comment")
```
Creates an action set allowing user textual input in the notification.

### Links
- [New-BTButton](New-BTButton.md)
- [New-BTContextMenuItem](New-BTContextMenuItem.md)
- [New-BTText](New-BTText.md)
- [New-BTSelectionBoxItem](New-BTSelectionBoxItem.md)
```

--------------------------------

### New-BTContextMenuItem

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTContextMenuItem.md

Creates a context menu item for a Toast Notification. The function returns a ToastContextMenuItem object.

```APIDOC
## New-BTContextMenuItem

### Description
Creates a context menu item (ToastContextMenuItem) for a Toast Notification, typically added via New-BTAction.

### Syntax
New-BTContextMenuItem -Content <String> -Arguments <String> [-ActivationType <ToastActivationType>]

### Parameters
- **Content** (String) - Required - The text string to display to the user for this menu item.
- **Arguments** (String) - Required - App-defined string that is returned if the context menu item is selected. Routinely a URI, file path, or app context string.
- **ActivationType** (Microsoft.Toolkit.Uwp.Notifications.ToastActivationType) - Optional - Controls the type of activation for this menu item. Defaults to Foreground if not specified.

### Inputs
None. You cannot pipe input to this function.

### Outputs
Microsoft.Toolkit.Uwp.Notifications.ToastContextMenuItem

### Example
```powershell
New-BTContextMenuItem -Content 'Website' -Arguments 'https://example.com' -ActivationType Protocol
```

Creates a menu item labeled "Website" that opens a URL on right-click.
```

--------------------------------

### Use custom executable in shortcut

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTShortcut.md

Uses the specified executable as the shortcut target.

```powershell
New-BTShortcut -AppId "Acme.MyApp" -ExecutablePath "C:\CustomHost\CustomHost.exe"
```

--------------------------------

### Create a binding with two columns

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTBinding.md

Creates a binding that uses two columns to display content side by side. The columns are created with New-BTColumn and passed to the -Column parameter.

```powershell
$col1 = New-BTColumn -Children (New-BTText -Text 'a')
$col2 = New-BTColumn -Children (New-BTText -Text 'b')
$binding = New-BTBinding -Column $col1, $col2
```

--------------------------------

### Create a blank line

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTText.md

Creates a blank line in the Toast notification.

```powershell
New-BTText
```

--------------------------------

### Create a binding with text and image

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTBinding.md

Creates a binding that combines a text element and an image element using the -Children parameter. The resulting binding can be used in a visual toast.

```powershell
$text1 = New-BTText -Content 'This is a test'
$image1 = New-BTImage -Source 'C:\BurntToast\Media\BurntToast.png'
$binding = New-BTBinding -Children $text1, $image1
```

--------------------------------

### Create a selection box item with New-BTSelectionBoxItem

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTSelectionBoxItem.md

Creates a selection box item with Id 'Item1' and Content 'First option in the list' for use in a selection input element.

```powershell
$Select1 = New-BTSelectionBoxItem -Id 'Item1' -Content 'First option in the list'
```

--------------------------------

### New-BTButton -Snooze

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTButton.md

Creates a snooze button with the system default snooze duration.

```powershell
New-BTButton -Snooze
```

--------------------------------

### New-BTButton -Color Red

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTButton.md

Creates a 'Critical' style (red) button for destructive actions.

```powershell
New-BTButton -Content 'Delete' -Arguments 'delete' -Color Red
```

--------------------------------

### Get-BTHeader

Source: https://github.com/windos/burnttoast/blob/main/Help/Get-BTHeader.md

Returns all unique toast notification headers in the Action Center. Optionally filters by toast unique identifier, title, or id.

```APIDOC
## Get-BTHeader

### Description
Returns all unique toast notification headers currently present in the Action Center. Can be filtered by toast unique identifier, header title, or header id.

### Syntax
Get-BTHeader [-ToastUniqueIdentifier <String>] [-Title <String>] [-Id <String>]

### Parameters
#### ToastUniqueIdentifier
- Type: String
- Mandatory: Yes (when using 'ByToastId' set)
- Description: The unique identifier of a toast notification. Only headers belonging to the notification with this identifier will be returned.

#### Title
- Type: String
- Mandatory: Yes (when using 'ByTitle' set)
- Description: Filters headers by a specific title.

#### Id
- Type: String
- Mandatory: Yes (when using 'ById' set)
- Description: Filters headers to only those with the specified header id.

### Inputs
None. You cannot pipe input to this function.

### Outputs
Microsoft.Toolkit.Uwp.Notifications.ToastHeader

### Examples
#### Example 1
```powershell
Get-BTHeader
```
Returns all unique toast notification headers in the Action Center.

#### Example 2
```powershell
Get-BTHeader -ToastUniqueIdentifier 'Toast001'
```
Returns headers for toasts with the specified unique identifier.

#### Example 3
```powershell
Get-BTHeader -Title "Stack Overflow Questions"
```
Returns headers with a specific title.

#### Example 4
```powershell
Get-BTHeader -Id "001"
```
Returns the header with the matching id.

### Links
- [Get-BTHistory](Get-BTHistory.md)
- [New-BTHeader](New-BTHeader.md)
```

--------------------------------

### Create an indeterminate progress bar

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTProgressBar.md

Creates a progress bar displaying an indeterminate animation.

```powershell
New-BTProgressBar -Status 'Copying files' -Indeterminate
```

--------------------------------

### Create a determinate progress bar

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTProgressBar.md

Creates a progress bar at 20% completion with a status message.

```powershell
New-BTProgressBar -Status 'Copying files' -Value 0.2
```

--------------------------------

### New-BTProgressBar

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTProgressBar.md

Creates a new AdaptiveProgressBar element for Toast Notifications, visualizing completion via percentage or indeterminate animation.

```APIDOC
## New-BTProgressBar

### Description
Creates a new AdaptiveProgressBar element for Toast Notifications, visualizing completion via percentage or indeterminate animation.

### Method
New-BTProgressBar

### Parameters
- **Title** (String) - Optional - Text displayed above the progress bar (optional context).
- **Status** (String) - Required - String describing the current operation status, shown below the bar.
- **Indeterminate** (Switch) - Required when using 'Indeterminate' set - When set, an indeterminate animation is shown (can't be used with Value).
- **Value** (Double 0-1) - Required when using 'Determinate' set - The percent complete (e.g. 0.45 = 45%).
- **ValueDisplay** (String) - Optional - Replaces default percentage label with a custom one.

### Inputs
None. You cannot pipe input to this function.

### Outputs
Microsoft.Toolkit.Uwp.Notifications.AdaptiveProgressBar

### Examples
#### Example 1
```powershell
New-BTProgressBar -Status 'Copying files' -Value 0.2
```
Creates a 20% full progress bar showing the status.

#### Example 2
```powershell
New-BTProgressBar -Status 'Copying files' -Indeterminate
```
Progress bar with indeterminate animation.

#### Example 3
```powershell
New-BTProgressBar -Status 'Copying files' -Value 0.2 -ValueDisplay '4/20 files complete'
```
Progress bar at 20%, overridden label text.

#### Example 4
```powershell
New-BTProgressBar -Title 'File Copy' -Status 'Copying files' -Value 0.2
```
Displays title and status.

#### Example 5
```powershell
$Progress = New-BTProgressBar -Status 'Copying files' -Value 0.2
New-BurntToastNotification -Text 'File copy script running', 'More details!' -ProgressBar $Progress
```
Toast notification includes a progress bar.

### Links
- [New-BTBinding](New-BTBinding.md)
- [New-BurntToastNotification](New-BurntToastNotification.md)
```

--------------------------------

### Get-BTHistory - Retrieve all toast notifications

Source: https://github.com/windos/burnttoast/blob/main/Help/Get-BTHistory.md

Returns all toast notifications currently in the Action Center that have not been dismissed by the user.

```powershell
Get-BTHistory
```

--------------------------------

### Create a binding with a progress bar

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTBinding.md

Creates a binding that includes a progress bar element using the -Children parameter. The progress bar is created with New-BTProgressBar.

```powershell
$progress = New-BTProgressBar -Title 'Updating' -Status 'Running' -Value 0.4
$binding = New-BTBinding -Children $progress
```

--------------------------------

### New-BTAudio

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BTAudio.md

Creates an audio object for Toast Notifications. Use this function to select a built-in notification sound, specify a custom audio file, or indicate that the notification should be silent.

```APIDOC
## New-BTAudio

### Description
Creates a new Audio object for Toast Notifications. Use this function to select a built-in notification sound (including alarms/calls), specify a custom audio file, or indicate that the notification should be silent.

### Syntax
```powershell
New-BTAudio [-Source] <Uri> [-Loop] [<CommonParameters>]
New-BTAudio [-Silent] [<CommonParameters>]
```

### Parameters
#### Source
- **Type**: Uri
- **Mandatory**: Yes (when using standard sound)
- **Description**: URI string. Specifies the sound to play with the Toast Notification. Accepts Microsoft notification sound URIs such as `ms-winsoundevent:Notification.IM` or a file path for custom audio.

#### Loop
- **Type**: Switch
- **Mandatory**: No
- **Description**: Specifies that the selected sound should loop, if its duration is shorter than the toast it accompanies.

#### Silent
- **Type**: Switch
- **Mandatory**: Yes (when using silent)
- **Description**: Makes the toast silent (no sound).

### Inputs
None. You cannot pipe input to this function.

### Outputs
Microsoft.Toolkit.Uwp.Notifications.ToastAudio

### Examples
#### Example 1
```powershell
New-BTAudio -Source ms-winsoundevent:Notification.SMS
```
Creates an audio object which will cause a Toast Notification to play the standard Microsoft 'SMS' sound.

#### Example 2
```powershell
New-BTAudio -Source 'C:\Music\FavSong.mp3'
```
Creates an audio object which will cause a Toast Notification to play the specified song or audio file.

#### Example 3
```powershell
New-BTAudio -Silent
```
Creates an audio object which will cause a Toast Notification to be silent.

### Related Links
- [New-BurntToastNotification](New-BurntToastNotification.md)
- [New-BTProgressBar](New-BTProgressBar.md)
- [New-BTAction](New-BTAction.md)
```

--------------------------------

### New-BurntToastNotification -Button - Toast with Action Button

Source: https://github.com/windos/burnttoast/blob/main/Help/New-BurntToastNotification.md

Displays a toast with a button that opens Google.

```powershell
$btn = New-BTButton -Content 'Google' -Arguments 'https://google.com'
New-BurntToastNotification -Text 'New Blog!' -Button $btn
```
Tokens:
Raw