Microsoft.VisualStudio.Extensibility.Settings Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| ArraySetting<T> |
Configuration of a VisualStudio.Extensibility setting which accepts multiple values. |
| ArraySettingItem |
Value of one of the entries of a Setting.ObjectArray. ArraySettingItem behaves like a Dictionary<TKey,TValue> but its values can only be accessed by calling GetValue<T>(String) or TryGetValue<T>(String, T). |
| ArraySettingItemProperty |
Configuration of a property of a Setting.ObjectArray. |
| ArraySettingItemProperty.Boolean |
Configuration of a boolean property of a Setting.ObjectArray. |
| ArraySettingItemProperty.Decimal |
Configuration of a decimal property of a Setting.ObjectArray. |
| ArraySettingItemProperty.Enum |
Configuration of an enum property of a Setting.ObjectArray. |
| ArraySettingItemProperty.FormattedString |
Configuration of a string property of a Setting.ObjectArray with format validation. |
| ArraySettingItemProperty.Integer |
Configuration of an integer property of a Setting.ObjectArray. |
| ArraySettingItemProperty.String |
Configuration of a string property of a Setting.ObjectArray. |
| ArraySettingItemProperty<T> |
Configuration of a property of a Setting.ObjectArray. |
| ArraySettingItemPropertyRule |
Configuration of a VisualStudio.Extensibility setting rule. |
| EnumSettingEntry |
Configuration of an enum entry of a EnumSettingEntry. |
| InvalidSettingTypeException |
An error raised when the requested setting type is not one of the supported type of Setting<T>. |
| Setting |
Configuration of a VisualStudio.Extensibility setting. |
| Setting.Boolean |
Configuration of a boolean VisualStudio.Extensibility setting. |
| Setting.Decimal |
Configuration of a decimal VisualStudio.Extensibility setting. |
| Setting.Enum |
Configuration of an enum VisualStudio.Extensibility setting. |
| Setting.EnumArray |
Configuration of an enum VisualStudio.Extensibility setting accepting multiple values. |
| Setting.FormattedString |
Configuration of a string VisualStudio.Extensibility setting with format validation. |
| Setting.FormattedStringArray |
Configuration of a string VisualStudio.Extensibility setting with format validation accepting multiple values. |
| Setting.Integer |
Configuration of an integer VisualStudio.Extensibility setting. |
| Setting.ObjectArray |
Configuration of a VisualStudio.Extensibility setting accepting multiple values, each grouping multiple settings. |
| Setting.String |
Configuration of a string VisualStudio.Extensibility setting. |
| Setting.StringArray |
Configuration of a string VisualStudio.Extensibility setting accepting multiple values. |
| Setting<T> |
Configuration of a VisualStudio.Extensibility setting. |
| SettingCategory |
Configuration of a VisualStudio.Extensibility setting category. |
| SettingChangeResult |
The result of a setting value change. |
| SettingIdentifier |
The full identifiers of the settings, including the categories it is nested under. |
| SettingIdentifier<T> |
The full identifiers of the settings, including the categories it is nested under. |
| SettingRule |
Configuration of a VisualStudio.Extensibility setting rule. |
| SettingsReadException |
Exception related to reading a setting values. |
| SettingsReadFailedValidationException |
An error raised when the requested setting's value is not valid according to the setting definition. |
| SettingsReadJsonDeserializationErrorException |
An error was encountered when parsing the setting json value. |
| SettingsReadNotPersistedException |
An error raised when the setting being requested is not persisted and doesn't have a default value. |
| SettingsReadNotRegisteredException |
An error raised when the setting being requested is not registered. |
| SettingsReadTypeMismatchException |
An error raised when the requested setting type doesn't match its registered type. |
| SettingsReadUnexpectedErrorException |
An unexpected error when reading a setting's value. |
| SettingsReadValueConversionException |
An error was raised when converting the setting value to its expected type. |
| SettingsWriteBatch |
A batch write of multiple settings. Call WriteSetting<T>(Setting<T>, T) to add write operations to the batch. |
| SettingsWriteResponse |
The result of committing a settings change. |
| SettingValue<T> |
The value of a setting. |
| SettingValues |
The value of a multiple settings. |
| SimpleSetting<T> |
Configuration of a VisualStudio.Extensibility setting with a single value. |
Structs
| SettingStringFormat |
Formats of Setting.FormattedString. |
| SettingTag |
Valid values for Tags. |
Interfaces
| IArraySettingItemConvertible |
Utility interface that allows creating types that can be converted to and from ArraySettingItem to simplify reading and writing Setting.ObjectArray settings. |
| ISettingValue |
The value of a setting. |
Enums
| SettingChangeResult.ResultCode |
A code indicating the outcome of a setting value change. |
| SettingsWriteResponse.ResultCode |
A code indicating the outcome of committing a settings change. |