Skip to content

Commit e4c22b1

Browse files
committed
Add another set of documented APIs
1 parent bee8495 commit e4c22b1

26 files changed

+177
-89
lines changed
Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ISettingsForm Interface
3-
description:
3+
description: The ISettingsForm interface is used to represent a settings form in the Command Palette Extensions Toolkit.
44
ms.date: 2/19/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,12 +12,14 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1414

15+
The **ISettingsForm** interface is used to represent a settings form in the Command Palette Extensions Toolkit. It provides methods for converting the form to different representations, such as a data identifier, dictionary, or state.
16+
1517
## Methods
1618

1719
| Method | Description |
1820
| :--- | :--- |
19-
| [ToDataIdentifier()](isettingsform_todataidentifier.md) | |
20-
| [ToDictionary()](isettingsform_todictionary.md) | |
21-
| [ToForm()](isettingsform_toform.md) | |
22-
| [ToState()](isettingsform_tostate.md) | |
23-
| [Update(JsonObject)](isettingsform_update.md) | |
21+
| [ToDataIdentifier()](isettingsform_todataidentifier.md) | Converts the settings form to a data identifier. |
22+
| [ToDictionary()](isettingsform_todictionary.md) | Converts the settings form to a dictionary representation. |
23+
| [ToForm()](isettingsform_toform.md) | Converts the settings form to a form representation. |
24+
| [ToState()](isettingsform_tostate.md) | Converts the settings form to a state representation. |
25+
| [Update(JsonObject)](isettingsform_update.md) | Updates the settings form with the specified JSON object. |

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ISettingsForm.ToDataIdentifier() Method
3-
description:
3+
description: The ISettingsForm.ToDataIdentifier method returns a string that represents the data identifier of the settings form.
44
ms.date: 2/19/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,8 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1414

15+
The `ToDataIdentifier` method returns a string that represents the data identifier of the settings form. This identifier is used to uniquely identify the settings form in the context of the command palette extension.
16+
1517
## Returns
1618

17-
String
19+
A **String** that contains the data identifier of the settings form.

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ISettingsForm.ToDictionary() Method
3-
description:
3+
description: The ISettingsForm.ToDictionary method returns a dictionary containing a representation of the settings form's data.
44
ms.date: 2/19/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,8 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1414

15+
The `ToDictionary` method returns a dictionary containing a representation of the settings form's data.
16+
1517
## Returns
1618

17-
Dictionary<String, Object>
19+
A **Dictionary\<String, Object\>** that contains the settings form's data. The keys in the dictionary are the names of the settings, and the values are the corresponding values of those settings.

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ISettingsForm.ToForm() Method
3-
description:
3+
description: The ISettingsForm.ToForm method converts the settings form to a state representation.
44
ms.date: 2/19/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,8 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1414

15+
The **ToForm** method converts the settings form to a state representation. This method is used to obtain a string representation of the settings form's state.
16+
1517
## Returns
1618

17-
String
19+
A **String** that represents the state of the settings form. This string can be used to save or transmit the state of the form.

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ISettingsForm.ToState() Method
3-
description:
3+
description: The ISettingsForm.ToState method converts the extension settings form to a state string representation.
44
ms.date: 2/19/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,8 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1414

15+
The **ToState** method converts the settings form to a state representation. This method is used to obtain a string representation of the settings form's state.
16+
1517
## Returns
1618

17-
String
19+
A **String** that represents the state of the settings form.

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ISettingsForm.Update(JsonObject) Method
3-
description:
3+
description: The Update method updates the settings form with the specified JSON object.
44
ms.date: 2/19/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,10 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1414

15+
The **Update** method updates the settings form with the specified JSON object. This method is used to apply changes to the settings form based on the provided JSON data.
16+
1517
## Parameters
1618

1719
**`payload`** JsonObject
20+
21+
The JSON object containing the data to update the settings form. This parameter is required and cannot be null.

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ItemsChangedEventArgs Class
3-
description:
3+
description: The ItemsChangedEventArgs class represents the event arguments for the items changed event in the Command Palette Extensions Toolkit.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -14,14 +14,16 @@ Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalett
1414

1515
Implements [IItemsChangedEventArgs](../microsoft-commandpalette-extensions/iitemschangedeventargs.md)
1616

17+
The **ItemsChangedEventArgs** class is used to represent the event arguments for the items changed event in the Command Palette Extensions Toolkit. It contains information about the total number of items that have changed.
18+
1719
## Constructors
1820

1921
| Constructor | Description |
2022
| :--- | :--- |
21-
| [ItemsChangedEventArgs(Integer)](itemschangedeventargs_constructor.md) | |
23+
| [ItemsChangedEventArgs(Integer)](itemschangedeventargs_constructor.md) | Initializes a new instance of the **ItemsChangedEventArgs** class with the specified total number of items. |
2224

2325
## Properties
2426

2527
| Property | Type | Description |
2628
| :--- | :--- | :--- |
27-
| TotalItems | Integer | |
29+
| TotalItems | Integer | Gets the total number of items that have changed. This property is read-only. |

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ItemsChangedEventArgs Constructors
3-
description:
3+
description: Initializes a new instance of the ItemsChangedEventArgs class with the specified total number of items.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -14,7 +14,7 @@ no-loc: [PowerToys, Windows, Insider]
1414

1515
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1616

17-
Initializes a new instance of the [ItemsChangedEventArgs](itemschangedeventargs.md) class with the [TotalItems](itemschangedeventargs.md#properties) property set to `totalItems` that defaults to -1.
17+
Initializes a new instance of the [ItemsChangedEventArgs](itemschangedeventargs.md) class with the [TotalItems](itemschangedeventargs.md#properties) property set to *totalItems* that defaults to `-1`.
1818

1919
```C#
2020
public ItemsChangedEventArgs(int totalItems = -1)
@@ -26,3 +26,5 @@ Initializes a new instance of the [ItemsChangedEventArgs](itemschangedeventargs.
2626
### Parameters
2727

2828
**`totalItems`** Integer
29+
30+
The total number of items that have changed. This parameter is optional and defaults to -1 if not provided.
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: JsonSettingsManager Class
3-
description:
3+
description: The JsonSettingsManager class provides functionality for managing extension settings in JSON format.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,16 +12,18 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
1414

15+
The **JsonSettingsManager** class provides functionality for managing settings in JSON format. It allows loading and saving settings to a specified file path.
16+
1517
## Properties
1618

1719
| Property | Type | Description |
1820
| :--- | :--- | :--- |
19-
| FilePath | String | |
20-
| Settings | [Settings](settings.md) | |
21+
| FilePath | String | The file path where the settings are stored. |
22+
| Settings | [Settings](settings.md) | The settings object that contains the configuration data. |
2123

2224
## Methods
2325

2426
| Method | Description |
2527
| :--- | :--- |
26-
| [LoadSettings()](jsonsettingsmanager_loadsettings.md) | |
27-
| [SaveSettings()](jsonsettingsmanager_savesettings.md) | |
28+
| [LoadSettings()](jsonsettingsmanager_loadsettings.md) | Loads settings from the specified file path. |
29+
| [SaveSettings()](jsonsettingsmanager_savesettings.md) | Saves the current settings to the specified file path. |

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: JsonSettingsManager.LoadSettings() Method
3-
description:
3+
description: The LoadSettings method loads the extension settings from the specified file path in JSON format.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -11,3 +11,5 @@ no-loc: [PowerToys, Windows, Insider]
1111
## Definition
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalette-extensions-toolkit.md)
14+
15+
The **LoadSettings** method loads the settings from the specified file path in JSON format. It deserializes the JSON data into the settings object.

0 commit comments

Comments
 (0)