Microsoft.VisualStudio.Settings Namespace

Classes

CrossProcessMutexFactory
ExternalSettingsManager

An implementation of the SettingsManager class that allows applications to access settings from Visual Studio or an isolated shell, either of which is selected by its AppID.

IdleStateChangedEventArgs

Arguments for the IdleStateChanged event.

ListMerger

Handles merging operations for setting collections.

NamedVersionedString

A setting value serialized as a string along with an associated name, version, and machine-local flag.

SerializedSetting
ServiceHubPubSubTopic
ServiceUploadParameters
ServiceUploadResult
SettingNameTooLongException
SettingsEventArgs
SettingsListChangedEventArgs

Event arguments describing a change to an ISettingsList.

SettingsManager

Represents the settings stored in Visual Studio.

SettingsManagerFactory

A factory object that constructs an ISettingsManager.

SettingsStore

Abstract class for reading or enumerating the selected scope's collections and properties. It is obtained from SettingsManager.GetReadOnlySettingsStore method.

SettingTooLargeException

This exception is thrown (from ISettingsManager, ISettingsList, etc.) when a setting value is given whose serialized representation exceeds the size limit on the roaming settings server (currently 1MB).

StoreLogPropertyDefinition
StoreLogPropertyDefinition<T>
StoreLogPropertyInstance
StoreLogPropertyInstance<T>
StringWithMachineLocalFlag

A setting value serialized as a string that contains a flag indicating whether the value contains machine-local content.

VersionedString

A setting value serialized as a string along with an associated version and machine-local flag.

WritableSettingsStore

Abstract class for both reading and writing the selected scope's collections and properties. It is obtained from SettingsManager.GetWritableSettingsStore method.

Interfaces

IAsyncStringStorage

Stores and retrieves strings. Used as an abstraction over the settings service in the hub and unit-tests.

ICrossProcessLockFactory
IInteropLogger
IListMerger

Handles merging operations for setting collections.

IRemoteDefaultsStore
ISettingNameTranslator

Translates between private names and shared names. This allows an application to isolate its settings from other apps by inserting a prefix or suffix.

ISettingsList

A collection of settings. The collection is ordered but the server is order-agnostic. Items can be added only at the front but removed from anywhere. The collection is preserved by the server in the order it was created.Keys are treated as case insensitive.

ISettingsManager

Stores and retrieves settings as well as handling synchronization between applications and machines.

ISettingsManager2
ISettingsManagerHost

Functionality provided by the application that creates an ISettingsManager viaSettingsManagerFactory.CreateInstance.

ISettingsManagerHost2
ISettingsManagerHost3
ISettingsManagerHost4
ISettingsService
ISettingsSubset

A subset of settings (either a single setting or all settings matching a wildcard pattern) for which one can subscribe to change events.

IStoreUpdateLogger
IStoreUpdateLoggerWithAmbientContext
IStringStorage

Stores and retrieves strings. Used as an abstraction over the registry.

Enums

ApplicationDataFolder

This enumeration is used to specify the folder that Visual Studio uses to keep various files for different purposes like cache files, backup files or template files.

EnclosingScopes

Enumeration returned as a result of a querying call to GetPropertyScope or GetCollectionScope methods of the SettingsManager class to learn the enclosing scopes of the provided property or collection.

GetValueResult

Represents the result of getting a value from the settings store.

ServiceUploadResultKind
SettingsEvent
SettingsListOperation

The kind of operation performed on an ISettingsList.

SettingsScope

This enumeration is used to specify the scope of the settings that is retrieved from the SettingsManager class.

SettingsType

Data types of the properties that are stored inside the collections.

Delegates

AsyncEventHandler

An asynchronous event handler.

CollectionChangedAsyncEventHandler

Handles changes to an ISettingsList that returns aTask so it can be asynchronous.

LockedStorageCreatorDelegate<T>
NonLockedStorageCreatorDelegate<T>
PropertyChangedAsyncEventHandler

n event handler similar to System.ComponentModel.PropertyChangedHandler that returns a Task so the handler can be asynchronous.

StoreUpdatedEventHandler

A handler for events raised by StoreUpdated that returns a Task so it can be asynchronous.