Skip to content

Commit bbe7da5

Browse files
cinnamon-msftcinnamon-msft
committed
start adding in helper classes
1 parent a043028 commit bbe7da5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+731
-27
lines changed

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/baseobservable.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: BaseObservable Class
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# BaseObservable Class
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions.toolkit.md)
14+
15+
Implements [INotifyPropChanged](../microsoft-commandpalette-extensions/inotifypropchanged.md)
16+
17+
## Events
18+
19+
| Event | Description |
20+
| :--- | :--- |
21+
| Windows.Foundation.TypedEventHandler<object, [IPropChangedEventArgs](../microsoft-commandpalette-extensions/ipropchangedeventargs.md)>? PropChanged | Notifies that a property value has changed. |
22+
23+
## Methods
24+
25+
| Method | Description |
26+
| :--- | :--- |
27+
| [OnPropertyChanged(String)](baseobservable_onpropertychanged.md) | Raises the `PropChanged` event to notify that a property value has changed. |

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/baseobservable_onpropertychanged.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: BaseObservable.OnPropertyChanged(String) Method
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# BaseObservable.OnPropertyChanged(String) Method
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
14+
15+
Raises the [PropChanged](baseobservable.md#events) event to notify that a property value has changed.
16+
17+
## Parameters
18+
19+
**`propertyName`** String

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/command.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Command Class
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# Command Class
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions.toolkit.md)
14+
15+
Inherits [BaseObservable](baseobservable.md)
16+
17+
Implements [ICommand](../microsoft-commandpalette-extensions/icommand.md)
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| :--- | :--- | :--- |
23+
| Icon | [IconInfo](iconinfo.md) | Gets or sets the icon for the command. |
24+
| Id | String | Gets or sets the ID of the command. |
25+
| Name | String | Gets or sets the name of the command. |

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandresult.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: CommandResult Class
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# CommandResult Class
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions.toolkit.md)
14+
15+
Implements [ICommandResult](../microsoft-commandpalette-extensions/icommandresult.md)
16+
17+
## Properties
18+
19+
| Property | Type | Description |
20+
| :--- | :--- | :--- |
21+
| Args | [ICommandResultArgs](../microsoft-commandpalette-extensions/icommandresultargs.md) | |
22+
| Kind | [CommandResultKind](../microsoft-commandpalette-extensions/commandresultkind.md) | Gets or sets the result of the command. Defaults to [CommandResultKind.Dismiss](../microsoft-commandpalette-extensions/commandresultkind.md#fields). |
23+
24+
## Methods
25+
26+
| Method | Description |
27+
| :--- | :--- |
28+
| [Confirm(ConfirmationArgs)](commandresult_confirm.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.Confirm](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to [ConfirmationArgs](confirmationargs.md). |
29+
| [Dismiss()](commandresult_dismiss.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.Dismiss](../microsoft-commandpalette-extensions/commandresultkind.md#fields). |
30+
| [GoBack()](commandresult_goback.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.GoBack](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to `null`. |
31+
| [GoHome()](commandresult_gohome.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.GoHome](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to `null`. |
32+
| [GoToPage(GoToPageArgs)](commandresult_gotopage.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.GoToPage](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to [GoToPageArgs](gotopageargs.md). |
33+
| [Hide()](commandresult_hide.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.Hide](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to `null`. |
34+
| [KeepOpen()](commandresult_keepopen.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.KeepOpen](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to `null`. |
35+
| [ShowToast(String)](commandresult_showtoast_string.md) | Creates a new [CommandResult](commandresult.md) instance with `Kind` set to [CommandResultKind.ShowToast](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to a new [ToastArgs](toastargs.md) object with its [Message](toastargs.md#properties) set to `String`. |
36+
| [ShowToast(ToastArgs)](commandresult_showtoast_toastargs.md) | Creates a new `CommandResult` instance with `Kind` set to [CommandResultKind.ShowToast](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and `Args` set to [ToastArgs](toastargs.md). |

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandresult_confirm.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: CommandResult.Confirm(ConfirmationArgs) Method
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# CommandResult.Confirm(ConfirmationArgs) Method
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
14+
15+
Creates a new [CommandResult](commandresult.md) instance with its [Kind](commandresult.md#properties) property set to [CommandResultKind.Confirm](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and its [Args](commandresult.md#properties) set to `args`.
16+
17+
## Parameters
18+
19+
**`args`** [ConfirmationArgs](confirmationargs.md)
20+
21+
## Returns
22+
23+
[CommandResult](commandresult.md)

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandresult_dismiss.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: CommandResult.Dismiss() Method
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# CommandResult.Dismiss() Method
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
14+
15+
Creates a new [CommandResult](commandresult.md) instance with its [Kind](commandresult.md#properties) property set to [CommandResultKind.Dismiss](../microsoft-commandpalette-extensions/commandresultkind.md#fields).
16+
17+
## Returns
18+
19+
[CommandResult](commandresult.md)

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandresult_goback.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: CommandResult.GoBack() Method
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# CommandResult.GoBack() Method
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
14+
15+
Creates a new [CommandResult](commandresult.md) instance with its [Kind](commandresult.md#properties) property set to [CommandResultKind.GoBack](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and its [Args](commandresult.md#properties) set to `null`.
16+
17+
## Returns
18+
19+
[CommandResult](commandresult.md)

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandresult_gohome.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: CommandResult.GoHome() Method
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# CommandResult.GoHome() Method
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
14+
15+
Creates a new [CommandResult](commandresult.md) instance with its [Kind](commandresult.md#properties) property set to [CommandResultKind.GoHome](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and its [Args](commandresult.md#properties) set to `null`.
16+
17+
## Returns
18+
19+
[CommandResult](commandresult.md)

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandresult_gotopage.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: CommandResult.GoToPage(GoToPageArgs) Method
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# CommandResult.GoToPage(GoToPageArgs) Method
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
14+
15+
Creates a new [CommandResult](commandresult.md) instance with its [Kind](commandresult.md#properties) property set to [CommandResultKind.GoToPage](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and its [Args](commandresult.md#properties) set to `args`.
16+
17+
## Parameters
18+
19+
**`args`** [GoToPageArgs](gotopageargs.md)
20+
21+
## Returns
22+
23+
[CommandResult](commandresult.md)

‎hub/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandresult_hide.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: CommandResult.Hide() Method
3+
description:
4+
ms.date: 2/10/2025
5+
ms.topic: reference
6+
no-loc: [PowerToys, Windows, Insider]
7+
---
8+
9+
# CommandResult.Hide() Method
10+
11+
## Definition
12+
13+
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
14+
15+
Creates a new [CommandResult](commandresult.md) instance with its [Kind](commandresult.md#properties) property set to [CommandResultKind.Hide](../microsoft-commandpalette-extensions/commandresultkind.md#fields) and its [Args](commandresult.md#properties) set to `null`.
16+
17+
## Returns
18+
19+
[CommandResult](commandresult.md)

0 commit comments

Comments
 (0)