DialogPage.LoadSettingsFromStorage Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Called by Visual Studio to load the settings of a dialog page from local storage, generally the registry.

public:
 virtual void LoadSettingsFromStorage();

public:
 virtual void LoadSettingsFromStorage();

 virtual void LoadSettingsFromStorage();

public virtual void LoadSettingsFromStorage ();

abstract member LoadSettingsFromStorage : unit -> unit
override this.LoadSettingsFromStorage : unit -> unit

Public Overridable Sub LoadSettingsFromStorage ()

Implements

LoadSettingsFromStorage()

Remarks

LoadSettingsFromStorage implements Microsoft.VisualStudio.Shell.IProfileManager.LoadSettingsFromStorage.

This method is called to load the settings of a dialgo page from local (as opposed to disk) storage, typically from the registry.

The default implementation is as follows:

1. Retrieves setting information for all the properties of the dialog page's automation object that support conversion to a string through TypeConverter.

2. Obtains settings from registry under the registry VSROOT\SettingsRegistryPath, where

   • VSROOT is the Visual Studio version-specific top-level registry entry, typically

     HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\Version, where

     Version is the Visual Studio version.

     An alternative root can be specified when the Visual Studio shell is initialized. For more information about how to specify an alternative root in the registry, see Command-Line Switches.

   • SettingsRegistryPath is the value that is returned by SettingsRegistryPath.

Note

Typically, an instance of a dialog page class is its own automation object. Therefore, properties that are retrieved are those of the class that is derived from DialogPage. However, if AutomationObject returns another object, it is that object's properties, and not the properties of the class, that are retrieved.