# New-BTButton

## SYNOPSIS

Creates a new clickable button for a Toast Notification.

## DESCRIPTION

The `New-BTButton` function creates a new button for a Toast Notification.
Up to five buttons can be added to a single Toast notification. Buttons may have display text, an icon, an optional activation type, argument string, or serve as system managed Dismiss/Snooze buttons.

## PARAMETERS

| Name           | Type                                                    | Description                                                                                                                                                                                                                  | Mandatory                                  |
|----------------|---------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
| `Snooze`       | Switch                                                  | Creates a system-handled snooze button. When paired with a selection box on the toast, the snooze time is customizable.                                                               | Yes (when using 'Snooze' set)               |
| `Dismiss`      | Switch                                                  | Creates a system-handled dismiss button.                                                                                                                                               | Yes (when using 'Dismiss' set)              |
| `Content`      | String                                                  | The text to display on this button. For system buttons, this overrides the default label.                                                                                              | Yes (when using 'Button' set')              |
| `Arguments`    | String                                                  | App-defined string to pass when the button is pressed. Often a URI or file path to open.                                                                                              | Yes (when using 'Button' set)               |
| `ActivationType`| Microsoft.Toolkit.Uwp.Notifications.ToastActivationType| Defines the activation type that triggers when the button is pressed. Defaults to Protocol.                                                                                            | No                                          |
| `ImageUri`     | String                                                  | Path or URI of an image icon to display next to the button label.                                                                                                                      | No                                          |
| `Id`           | String                                                  | Specifies an ID associated with another toast control (textbox or selection box). For standard buttons, this aligns the button next to a control; for snooze buttons, associates with a selection box.                      | No                                          |
| `Color`        | String (Green/Red)                                      | If specified as `Green` or `Red`, the button will be visually styled as "Success" (green) or "Critical" (red) where supported. Use for representing positive/primary or destructive actions.                                | No                                          |

## INPUTS

None. You cannot pipe input to this function.

## OUTPUTS

- Microsoft.Toolkit.Uwp.Notifications.ToastButton
- Microsoft.Toolkit.Uwp.Notifications.ToastButtonDismiss
- Microsoft.Toolkit.Uwp.Notifications.ToastButtonSnooze

## EXAMPLES

### Example 1

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

Creates a button which mimics the act of 'swiping away' the Toast when clicked.

### Example 2

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

Creates a snooze button with system default snooze duration.

### Example 3

```powershell
New-BTButton -Snooze -Content 'Sleep' -Id 'TimeSelection'
```

Snooze button using the label 'Sleep' and referencing a selection box control.

### Example 4

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

Regular button that opens a URL when clicked.

### Example 5

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

Button with a picture to the left, launches the image file.

## NOTES

To visually distinguish action buttons, you can set the `Color` parameter to `Green` or `Red`. This will render these buttons with a "Success" (green) or "Critical" (red) style in systems that support advanced toast button styling (Windows 11+). Useful for marking approve/submit (green) or destructive (red) actions.

## EXAMPLES

### Example 6

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

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

### Example 7

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

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

## LINKS

- [New-BTAction](New-BTAction.md)
- [New-BTContextMenuItem](New-BTContextMenuItem.md)
- [New-BTText](New-BTText.md)
- [New-BTSelectionBoxItem](New-BTSelectionBoxItem.md)