Edit

Share via


Settings Class

Definition

Namespace: Microsoft.CommandPalette.Extensions.Toolkit

Implements ICommandSettings

The Settings class is used to manage the settings of a command palette extension. It provides methods to add, retrieve, and update settings, as well as to convert settings to JSON format.

Properties

Property Type Description
SettingsPage IContentPage The settings page associated with the command palette extension.

Events

Event Description
Windows.Foundation.TypedEventHandler<object, Settings> SettingsChanged Occurs when the settings of the command palette extension are changed.

Methods

Method Description
Add<T>(Setting<T>) Adds a new setting to the command palette extension.
GetSetting<T>(String) Retrieves the value of a setting by its name.
ToContent() Converts the settings to a content page.
ToJson() Converts the settings to JSON format.
TryGetSetting<T>(String, T) Attempts to retrieve the value of a setting by its name. If the setting does not exist, it returns the default value provided.
Update(String) Updates the settings of the command palette extension.