ExternalSettingsManager Class

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Settings.15.0.dll

Package:

Microsoft.VisualStudio.Settings.15.0 v17.10.34916.79

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.

public ref class ExternalSettingsManager sealed : Microsoft::VisualStudio::Settings::SettingsManager, IDisposable

public sealed class ExternalSettingsManager : Microsoft.VisualStudio.Settings.SettingsManager, IDisposable

type ExternalSettingsManager = class
    inherit SettingsManager
    interface IDisposable

Public NotInheritable Class ExternalSettingsManager
Inherits SettingsManager
Implements IDisposable

Inheritance

Object

SettingsManager

ExternalSettingsManager

Implements

IDisposable

Remarks

By using this class, you can search for properties and collections in different scopes. It contains references to the SettingsStore class and the WritableSettingsStore class for further manipulation of the properties and collections in the scopes.

This class implements the IDisposable pattern. Therefore, it must be disposed after it is no longer required.

Methods

CreateForApplication(String, Boolean)	Used to construct the SettingsManager for AppID-based Visual Studio applications.
CreateForApplication(String, IInteropLogger)
CreateForApplication(String, String, Boolean)	Used to construct the SettingsManager for AppID-based Visual Studio applications that use suffixed mode. In suffixed mode, any changes to the settings are isolated from the normal running mode.
CreateForApplication(String, String, IInteropLogger)
CreateForApplication(String, String)	Used to construct the SettingsManager for AppID-based Visual Studio applications that use suffixed mode. In suffixed mode, any changes to the settings are isolated from the normal running mode.
CreateForApplication(String)	Used to construct the SettingsManager for AppID-based Visual Studio applications.
CreateForIsolatedApplication(String, String, String, Boolean)	Used to construct the SettingsManager for Visual Studio custom applications. Custom applications are isolated among themselves.
CreateForIsolatedApplication(String, String, String)	Used to construct the SettingsManager for Visual Studio custom applications. Custom applications are isolated among themselves.
Dispose()	Releases the resources that are used by the current instance of the ExternalSettingsManager class.
Finalize()
GetApplicationDataFolder(ApplicationDataFolder)	Returns the folder that Visual Studio uses for storing various files such as cache files, backup files, and template files
GetCollectionScopes(String)	Outputs the scopes that contain the given collection.
GetCommonExtensionsSearchPaths()	Returns the list of folders that Visual Studio uses to install or look for machine-wide extensions.
GetPropertyScopes(String, String)	Outputs the scopes that contain the given property.
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 for reading operations and writing operations.