ExternalSettingsManager Class

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.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Settings.SettingsManager
    Microsoft.VisualStudio.Settings.ExternalSettingsManager

Namespace:  Microsoft.VisualStudio.Settings
Assemblies:   Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.dll)
  Microsoft.VisualStudio.Settings.12.0 (in Microsoft.VisualStudio.Settings.12.0.dll)
  Microsoft.VisualStudio.Settings.11.0 (in Microsoft.VisualStudio.Settings.11.0.dll)

Syntax

'Declaration
Public NotInheritable Class ExternalSettingsManager _
    Inherits SettingsManager _
    Implements IDisposable

public sealed class ExternalSettingsManager : SettingsManager, 
    IDisposable

public ref class ExternalSettingsManager sealed : public SettingsManager, 
    IDisposable

[<Sealed>]
type ExternalSettingsManager =  
    class 
        inherit SettingsManager 
        interface IDisposable 
    end

public final class ExternalSettingsManager extends SettingsManager implements IDisposable

The ExternalSettingsManager type exposes the following members.

Methods

	Name	Description
	CreateForApplication(String)	Used to construct the SettingsManager for AppID-based Visual Studio applications.
	CreateForApplication(String, Boolean)	Used to construct the SettingsManager for AppID-based Visual Studio applications.
	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, 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.
	CreateForIsolatedApplication(String, String)
	CreateForIsolatedApplication(String, String, Boolean)
	CreateForIsolatedApplication(String, String, String)	Used to construct the SettingsManager for Visual Studio custom applications. Custom applications are isolated among themselves.
	CreateForIsolatedApplication(String, String, String, Boolean)	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.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetApplicationDataFolder	Returns the folder that Visual Studio uses for storing various files such as cache files, backup files, and template files (Overrides SettingsManager.GetApplicationDataFolder(ApplicationDataFolder).)
	GetCollectionScopes	Outputs the scopes that contain the given collection. (Overrides SettingsManager.GetCollectionScopes(String).)
	GetCommonExtensionsSearchPaths	Returns the list of folders that Visual Studio uses to install or look for machine-wide extensions. (Overrides SettingsManager.GetCommonExtensionsSearchPaths().)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetPropertyScopes	Outputs the scopes that contain the given property. (Overrides SettingsManager.GetPropertyScopes(String, String).)
	GetReadOnlySettingsStore	Provides the SettingsStore class for the requested scope which can be used for read-only operations. (Overrides SettingsManager.GetReadOnlySettingsStore(SettingsScope).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWritableSettingsStore	Provides the WritableSettingsStore class for the requested scope which can be used for reading operations and writing operations. (Overrides SettingsManager.GetWritableSettingsStore(SettingsScope).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Settings Namespace