Skip to content

Commit bee8495

Browse files
committed
Add next batch of authored API ref docs
1 parent abddad5 commit bee8495

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

+337
-184
lines changed

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: LogMessage Class
3-
description:
3+
description: The LogMessage class is used to define a log message in the command palette.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -16,15 +16,17 @@ Inherits [BaseObservable](baseobservable.md)
1616

1717
Implements [ILogMessage](../microsoft-commandpalette-extensions/ilogmessage.md)
1818

19+
The **LogMessage** class is used to define a log message in the command palette. It provides properties to specify the message content and its state.
20+
1921
## Constructors
2022

2123
| Constructor | Description |
2224
| :--- | :--- |
23-
| [LogMessage(String)](logmessage_constructor.md) | |
25+
| [LogMessage(String)](logmessage_constructor.md) | Initializes a new instance of the LogMessage class with the specified message. |
2426

2527
## Properties
2628

2729
| Property | Type | Description |
2830
| :--- | :--- | :--- |
29-
| Message | String | |
30-
| State | [MessageState](../microsoft-commandpalette-extensions/messagestate.md) | |
31+
| Message | String | The content of the log message. |
32+
| State | [MessageState](../microsoft-commandpalette-extensions/messagestate.md) | The state of the log message. |

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: LogMessage Constructors
3-
description:
3+
description: Initializes a new instance of the LogMessage class with the specified message.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -26,3 +26,5 @@ public LogMessage(string message = "")
2626
### Parameters
2727

2828
**`message`** String
29+
30+
The content of the log message. This parameter is optional and defaults to an empty string if not provided.

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: MarkdownContent Class
3-
description:
3+
description: The MarkdownContent class is used to define the content of a markdown file.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -16,8 +16,10 @@ Inherits [BaseObservable](baseobservable.md)
1616

1717
Implements [IMarkdownContent](../microsoft-commandpalette-extensions/imarkdowncontent.md)
1818

19+
The **MarkdownContent** class is used to represent the content of a command palette item in Markdown format. It provides properties to specify the body of the Markdown content and whether it should be rendered as HTML.
20+
1921
## Properties
2022

2123
| Property | Type | Description |
2224
| :--- | :--- | :--- |
23-
| Body | String | |
25+
| Body | String | The body of the Markdown content. This property is required and cannot be null or empty. |
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: MatchOption Class
3-
description:
3+
description: The MatchOption class is used to define the options for matching in the command palette.
44
ms.date: 2/26/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,10 +12,12 @@ no-loc: [PowerToys, Windows, Insider]
1212

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

15+
The **MatchOption** class is used to define the options for matching in the command palette. It provides properties to specify how the matching should be performed, including case sensitivity and prefix/suffix matching.
16+
1517
## Properties
1618

1719
| Property | Type | Description |
1820
| :--- | :--- | :--- |
19-
| IgnoreCase | Boolean | |
20-
| Prefix | String | |
21-
| Suffix | String | |
21+
| IgnoreCase | Boolean | Indicates whether the match should ignore case sensitivity. |
22+
| Prefix | String | Indicates whether the match should be a prefix match. |
23+
| Suffix | String | Indicates whether the match should be a suffix match. |
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: MatchResult Class
3-
description:
3+
description: The MatchResult class is used to represent the result of a match operation in the Command Palette Extensions Toolkit.
44
ms.date: 2/26/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,25 +12,27 @@ no-loc: [PowerToys, Windows, Insider]
1212

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

15+
The **MatchResult** class is used to represent the result of a match operation in the Command Palette Extensions Toolkit. It contains information about whether the match was successful, the score of the match, and any additional data related to the match.
16+
1517
## Constructors
1618

1719
| Constructor | Description |
1820
| :--- | :--- |
19-
| [MatchResult(Boolean, SearchPrecisionScore)](matchresult_constructor.md#matchresultboolean-searchprecisionscore-constructor) | |
20-
| [MatchResult(Boolean, SearchPrecisionScore, List<Integer>, Integer)](matchresult_constructor.md#matchresultboolean-searchprecisionscore-list-integer-constructor) | |
21+
| [MatchResult(Boolean, SearchPrecisionScore)](matchresult_constructor.md#matchresultboolean-searchprecisionscore-constructor) | Initializes a new instance of the MatchResult class with a success flag and a search precision score. |
22+
| [MatchResult(Boolean, SearchPrecisionScore, List\<Integer\>, Integer)](matchresult_constructor.md#matchresultboolean-searchprecisionscore-list-integer-constructor) | Initializes a new instance of the MatchResult class with a success flag, a search precision score, match data, and a raw score. |
2123

2224
## Properties
2325

2426
| Property | Type | Description |
2527
| :--- | :--- | :--- |
26-
| MatchData | List<Integer> | |
27-
| RawScore | Integer | |
28-
| Score | Integer | |
29-
| SearchPrecision | [SearchPrecisionScore](searchprecisionscore.md) | |
30-
| Success | Boolean | |
28+
| MatchData | List\<Integer\> | A list of integers representing the match data. |
29+
| RawScore | Integer | The raw score of the match. |
30+
| Score | Integer | The score of the match. |
31+
| SearchPrecision | [SearchPrecisionScore](searchprecisionscore.md) | The precision score of the match. |
32+
| Success | Boolean | A boolean value indicating whether the match was successful. |
3133

3234
## Methods
3335

3436
| Method | Description |
3537
| :--- | :--- |
36-
| [IsSearchPrecisionScoreMet()](matchresult_issearchprecisionscoremet.md) | |
38+
| [IsSearchPrecisionScoreMet()](matchresult_issearchprecisionscoremet.md) | Checks if the search precision score is met. |

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: MatchResult Constructors
3-
description:
3+
description: Initializes a new instance of the MatchResult class with specified parameters.
44
ms.date: 2/26/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -28,9 +28,13 @@ public MatchResult(bool success, SearchPrecisionScore searchPrecision)
2828

2929
**`success`** Boolean
3030

31+
Indicates whether the match was successful.
32+
3133
**`searchPrecision`** [SearchPrecisionScore](searchprecisionscore.md)
3234

33-
## MatchResult(Boolean, [SearchPrecisionScore](searchprecisionscore.md), List<Integer>, Integer) Constructor
35+
The search precision score for the match. This score is used to determine how closely the match aligns with the search criteria.
36+
37+
## MatchResult(Boolean, [SearchPrecisionScore](searchprecisionscore.md), List\<Integer\>, Integer) Constructor
3438

3539
### Definition
3640

@@ -52,8 +56,16 @@ public MatchResult(bool success, SearchPrecisionScore searchPrecision, List<int>
5256

5357
**`success`** Boolean
5458

59+
Indicates whether the match was successful.
60+
5561
**`searchPrecision`** [SearchPrecisionScore](searchprecisionscore.md)
5662

57-
**`matchData`** List<Integer>
63+
The search precision score for the match. This score is used to determine how closely the match aligns with the search criteria.
64+
65+
**`matchData`** List\<Integer\>
66+
67+
The list of match data. This data can be used to provide additional context or information about the match.
5868

5969
**`rawScore`** Integer
70+
71+
The raw score for the match. This score is used to quantify the quality of the match based on the search criteria.

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: MatchResult.IsSearchPrecisionScoreMet() Method
3-
description:
3+
description: The IsSearchPrecisionScoreMet method checks if the search precision score for a result has been met.
44
ms.date: 2/26/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 **IsSearchPrecisionScoreMet** method checks if the search precision score is met.
16+
1517
## Returns
1618

17-
Boolean
19+
A **Boolean** value indicating whether the search precision score is met.

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

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -15,73 +15,73 @@ Contains helper classes that make creating extensions easier.
1515

1616
| Interface | Description |
1717
| :--- | :--- |
18-
| [ISettingsForm](isettingsform.md) | |
18+
| [ISettingsForm](isettingsform.md) | Defines the interface for a settings form. |
1919

2020
## Classes
2121

2222
| Class | Description |
2323
| :--- | :--- |
24-
| [AnonymousCommand](anonymouscommand.md) | |
25-
| [BaseObservable](baseobservable.md) | |
26-
| [ChoiceSetSetting](choicesetsetting.md) | |
27-
| [ClipboardHelper](clipboardhelper.md) | |
28-
| [ColorHelpers](colorhelpers.md) | |
29-
| [Command](command.md) | |
30-
| [CommandContextItem](commandcontextitem.md) | |
31-
| [CommandItem](commanditem.md) | |
32-
| [CommandProvider](commandprovider.md) | |
33-
| [CommandResult](commandresult.md) | |
34-
| [ConfirmationArgs](confirmationargs.md) | |
35-
| [ContentPage](contentpage.md) | |
36-
| [CopyTextCommand](copytextcommand.md) | |
37-
| [Details](details.md) | |
38-
| [DetailsCommand](detailscommand.md) | |
39-
| [DetailsElement](detailselement.md) | |
40-
| [DetailsLink](detailslink.md) | |
41-
| [DetailsSeparator](detailsseparator.md) | |
42-
| [DetailsTags](detailstags.md) | |
43-
| [DynamicListPage](dynamiclistpage.md) | |
44-
| [ExtensionHost](extensionhost.md) | |
45-
| [FallbackCommandItem](fallbackcommanditem.md) | |
46-
| [Filter](filter.md) | |
47-
| [FormContent](formcontent.md) | |
48-
| [GoToPageArgs](gotopageargs.md) | |
49-
| [IconData](icondata.md) | |
50-
| [IconHelpers](iconhelpers.md) | |
51-
| [IconInfo](iconinfo.md) | |
52-
| [InvokableCommand](invokablecommand.md) | |
53-
| [ItemsChangedEventArgs](itemschangedeventargs.md) | |
54-
| [JsonSettingsManager](jsonsettingsmanager.md) | |
55-
| [KeyChordHelpers](keychordhelpers.md) | |
56-
| [ListHelpers](listhelpers.md) | |
57-
| [ListItem](listitem.md) | |
58-
| [ListPage](listpage.md) | |
59-
| [LogMessage](logmessage.md) | |
60-
| [MarkdownContent](markdowncontent.md) | |
61-
| [MatchOption](matchoption.md) | |
62-
| [MatchResult](matchresult.md) | |
63-
| [NoOpCommand](noopcommand.md) | |
64-
| [OpenUrlCommand](openurlcommand.md) | |
65-
| [Page](page.md) | |
66-
| [ProgressState](progressstate.md) | |
67-
| [PropChangedEventArgs](propchangedeventargs.md) | |
68-
| [Setting](setting.md) | |
69-
| [Settings](settings.md) | |
70-
| [SettingsForm](settingsform.md) | |
71-
| [ShellHelpers](shellhelpers.md) | |
72-
| [StatusMessage](statusmessage.md) | |
73-
| [StringMatcher](stringmatcher.md) | |
74-
| [Tag](tag.md) | |
75-
| [TextSetting](textsetting.md) | |
76-
| [ThumbnailHelper](thumbnailhelper.md) | |
77-
| [ToastArgs](toastargs.md) | |
78-
| [ToastStatusMessage](toaststatusmessage.md) | |
79-
| [ToggleSetting](togglesetting.md) | |
80-
| [TreeContent](treecontent.md) | |
81-
| [Utilities](utilities.md) | |
24+
| [AnonymousCommand](anonymouscommand.md) | AnonymousCommand is a command that can be invoked without a specific target. It is typically used for commands that do not require any parameters or context. |
25+
| [BaseObservable](baseobservable.md) | Base class for observable objects. |
26+
| [ChoiceSetSetting](choicesetsetting.md) | Represents a setting that allows the user to choose from a set of predefined options. |
27+
| [ClipboardHelper](clipboardhelper.md) | Helper class for clipboard operations. |
28+
| [ColorHelpers](colorhelpers.md) | Helper class for color operations. |
29+
| [Command](command.md) | Base class for commands. |
30+
| [CommandContextItem](commandcontextitem.md) | Represents an item in the command context. |
31+
| [CommandItem](commanditem.md) | Represents an item in the command palette. |
32+
| [CommandProvider](commandprovider.md) | Base class for command providers. |
33+
| [CommandResult](commandresult.md) | Represents the result of a command invocation. |
34+
| [ConfirmationArgs](confirmationargs.md) | Represents the arguments for a confirmation dialog. |
35+
| [ContentPage](contentpage.md) | Represents a page that contains content. |
36+
| [CopyTextCommand](copytextcommand.md) | Represents a command that copies text to the clipboard. |
37+
| [Details](details.md) | Represents a details view in the command palette. |
38+
| [DetailsCommand](detailscommand.md) | Represents a command that displays details in the command palette. |
39+
| [DetailsElement](detailselement.md) | Represents an element in the details view. |
40+
| [DetailsLink](detailslink.md) | Represents a link in the details view. |
41+
| [DetailsSeparator](detailsseparator.md) | Represents a separator in the details view. |
42+
| [DetailsTags](detailstags.md) | Represents tags in the details view. |
43+
| [DynamicListPage](dynamiclistpage.md) | Represents a dynamic list page in the command palette. |
44+
| [ExtensionHost](extensionhost.md) | Represents the host for an extension. |
45+
| [FallbackCommandItem](fallbackcommanditem.md) | Represents a fallback command item in the command palette. |
46+
| [Filter](filter.md) | Represents a filter for command items. |
47+
| [FormContent](formcontent.md) | Represents a form content in the command palette. |
48+
| [GoToPageArgs](gotopageargs.md) | Represents the arguments for navigating to a page. |
49+
| [IconData](icondata.md) | Represents icon data for command items. |
50+
| [IconHelpers](iconhelpers.md) | Helper class for icon operations. |
51+
| [IconInfo](iconinfo.md) | Represents information about an icon. |
52+
| [InvokableCommand](invokablecommand.md) | Represents a command that can be invoked. |
53+
| [ItemsChangedEventArgs](itemschangedeventargs.md) | Represents the event arguments for items changed events. |
54+
| [JsonSettingsManager](jsonsettingsmanager.md) | Manages settings stored in JSON format. |
55+
| [KeyChordHelpers](keychordhelpers.md) | Helper class for key chord operations. |
56+
| [ListHelpers](listhelpers.md) | Helper class for list operations. |
57+
| [ListItem](listitem.md) | Represents an item in a list. |
58+
| [ListPage](listpage.md) | Represents a list page in the command palette. |
59+
| [LogMessage](logmessage.md) | Represents a log message. |
60+
| [MarkdownContent](markdowncontent.md) | Represents markdown content in the command palette. |
61+
| [MatchOption](matchoption.md) | Represents options for matching command items. |
62+
| [MatchResult](matchresult.md) | Represents the result of a match operation. |
63+
| [NoOpCommand](noopcommand.md) | Represents a command that does nothing. It is typically used as a placeholder. |
64+
| [OpenUrlCommand](openurlcommand.md) | Represents a command that opens a URL in the default web browser. |
65+
| [Page](page.md) | Base class for pages in the command palette. |
66+
| [ProgressState](progressstate.md) | Represents the state of a progress operation. |
67+
| [PropChangedEventArgs](propchangedeventargs.md) | Represents the event arguments for property changed events. |
68+
| [Setting](setting.md) | Base class for settings. |
69+
| [Settings](settings.md) | Represents the settings for an extension. |
70+
| [SettingsForm](settingsform.md) | Represents a form for displaying settings. |
71+
| [ShellHelpers](shellhelpers.md) | Helper class for shell operations. |
72+
| [StatusMessage](statusmessage.md) | Represents a status message in the command palette. |
73+
| [StringMatcher](stringmatcher.md) | Helper class for string matching operations. |
74+
| [Tag](tag.md) | Represents a tag in the command palette. |
75+
| [TextSetting](textsetting.md) | Represents a setting that allows the user to enter text. |
76+
| [ThumbnailHelper](thumbnailhelper.md) | Helper class for thumbnail operations. |
77+
| [ToastArgs](toastargs.md) | Represents the arguments for a toast notification. |
78+
| [ToastStatusMessage](toaststatusmessage.md) | Represents a toast status message in the command palette. |
79+
| [ToggleSetting](togglesetting.md) | Represents a setting that allows the user to toggle a value on or off. |
80+
| [TreeContent](treecontent.md) | Represents tree content in the command palette. |
81+
| [Utilities](utilities.md) | Utility class for common operations. |
8282

8383
## Enums
8484

8585
| Enum | Description |
8686
| :--- | :--- |
87-
| [SearchPrecisionScore](searchprecisionscore.md) | |
87+
| [SearchPrecisionScore](searchprecisionscore.md) | The precision score of a search result. |

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: NoOpCommand Class
3-
description:
3+
description: The NoOpCommand class is used to represent a command that does nothing when invoked. It is typically used as a placeholder or for testing purposes.
44
ms.date: 2/25/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -14,8 +14,10 @@ Namespace: [Microsoft.CommandPalette.Extensions.Toolkit](microsoft-commandpalett
1414

1515
Inherits [InvokableCommand](invokablecommand.md)
1616

17+
The **NoOpCommand** class is used to represent a command that does nothing when invoked. It is typically used as a placeholder or for testing purposes.
18+
1719
## Methods
1820

1921
| Method | Description |
2022
| :--- | :--- |
21-
| [Invoke()](noopcommand_invoke.md) | |
23+
| [Invoke()](noopcommand_invoke.md) | Invokes the command. This method does nothing and is used as a placeholder. |

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: NoOpCommand.Invoke() Method
3-
description:
3+
description: The NoOpCommand.Invoke() method is used to invoke the command. This method does nothing and is used as a placeholder.
44
ms.date: 2/25/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 **NoOpCommand.Invoke()** method is used to invoke the command. This method does nothing and is used as a placeholder.
16+
1517
## Returns
1618

17-
[ICommandResult](../microsoft-commandpalette-extensions/icommandresult.md)
19+
An [ICommandResult](../microsoft-commandpalette-extensions/icommandresult.md) object that indicates the result of the command invocation.

0 commit comments

Comments
 (0)