Microsoft.VisualStudio.Utilities.UnifiedSettings Namespace

Reference

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

ArraySettingContent	The content of an array setting.
DynamicMessageTextChangedEventArgs
EnumChoice	Represents a value the user can choose for an enum setting.
EnumSettingChoicesChangedEventArgs
ExternalSettingOperationResult
ExternalSettingOperationResult.Failure
ExternalSettingOperationResult.Success
ExternalSettingOperationResult<T>.Failure
ExternalSettingOperationResult<T>.Success
ExternalSettingOperationResult<T>
ExternalSettingsChangedEventArgs
IncompatibleSettingTypeException	Thrown on setting retrieval when the stored value can't be converted to the target type.
SettingChangeResult	The result of a call to one of ISettingsWriter's Enqueue*Change methods.
SettingCommitResult	The result of a call to RequestCommit(String).
SettingNotRegisteredException	Thrown from ISettingsReader's Get*OrThrow methods when the setting has no stored value (or the stored value can't be converted to the target type) and the setting isn't registered.
SettingRetrieval<T>	The result of a call to one of ISettingsReader's Get* methods.
SettingsUpdate	Setting change event payload.

Interfaces

IArrayItemCommand
IArraySettingMigrator	Migration support for array settings in Unified Settings. This is invoked if array settings include a migrationCallback property indicating the package and/or service ID to invoke. It should be implemented by the setting owner.
ICachingExternalSettingsProvider	Controls an external settings region that caches its state in memory because reading, writing, or monitoring the backing store is too expensive. The external settings provider must implement this (instead of just IExternalSettingsProvider) if the registration specifies realtimeNotifications = false.
IExternalArrayItemCommandsProvider	May be implemented by an implementor of IExternalSettingsProvider to proffer additional commands for array items.
IExternalSettingsProvider	Controls a single region of external settings. Unified Settings will query for this object when the external settings region is shown in the UI.
ISettingsManager	The main entry point for Unified Settings, available as a VS service (via service SVsUnifiedSettingsManager).
ISettingsReader	This exposes the "effective value" of settings: the value from the highest priority scope where each setting is customized.
ISettingsWriter	Changes made via this API don't take effect until RequestCommit(String) is called. At that point, they may be immediately approved/rejected or they may need to wait for user approval. The scope at which the changes are persisted may be user-determined. RequestCommit(String) can be called multiple times.
ISuspendableExternalSettingsProvider	An optional interface external settings providers may implement for resource usage optimization.

Enums

ExternalSettingsErrorScope	Indicates how broadly an error condition applies.
SettingChangeOutcome	The outcome of a call to one of ISettingsWriter's Enqueue*Change methods.
SettingCommitOutcome	The outcome of a call to RequestCommit(String).
SettingReadOptions	Defines the requirements for reading settings via ISettingsReader.
SettingRetrievalOutcome	The outcome of a call to one of ISettingsReader's Get* methods.
SettingWriteOptions	Defines the requirements for write settings via ISettingsWriter.