ShellSettingsManager Class

Definition

Namespace:

Microsoft.VisualStudio.Shell.Settings

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.9.37000

This is the gateway class to reach for the settings stored inside the Visual Studio. It provides two basic functionality. It allows to search for properties and collections inside the scopes. It hands the SettingsScope and WritableSettingsStore classes for further manipulation of the collections and properties within the scopes.

public ref class ShellSettingsManager sealed : Microsoft::VisualStudio::Settings::SettingsManager

public ref class ShellSettingsManager sealed : Microsoft::VisualStudio::Settings::SettingsManager

class ShellSettingsManager sealed : Microsoft::VisualStudio::Settings::SettingsManager

public sealed class ShellSettingsManager : Microsoft.VisualStudio.Settings.SettingsManager

type ShellSettingsManager = class
    inherit SettingsManager

Public NotInheritable Class ShellSettingsManager
Inherits SettingsManager

Inheritance

Object

SettingsManager

ShellSettingsManager

Remarks

This class allows you to search for properties and collections in different scopes. It contains references to the SettingsScope and WritableSettingsStore classes for further manipulation of the collections and properties in the scope. This class implements the IDisposable pattern and must be disposed after it is no longer necessary.

Constructors

ShellSettingsManager(IServiceProvider)	Constructor for the SettingsManager class. It requires Service Provider to reach IVsSettingsManager which is the interop COM interface of the service that provides the Settings related functionalities.
ShellSettingsManager(IVsSettingsManager)	Constructor which takes a settings manager instance

Methods

GetApplicationDataFolder(ApplicationDataFolder)	Returns the folder that Visual Studio uses for storing various cache, backup, template, etc. files
GetCollectionScopes(String)	Outputs the scopes that contain the given collection. If more than one scope contains the collection, the corresponding bit flags of those scopes are set.
GetCommonExtensionsSearchPaths()	Returns the list of folders that Visual Studio uses for installing/discovering machine-wide extensions.
GetPropertyScopes(String, String)	Outputs the scopes that contain the given property. If more than one scope contains the property, the corresponding bit flags of those scopes are set.
GetReadOnlySettingsStore(SettingsScope)	Provides the SettingsStore class for the requested scope which can be used for read-only operations.
GetWritableSettingsStore(SettingsScope)	Provides the WritableSettingsStore class for the requested scope which can be used both for reading and writing.