DialogPage.SaveSettingsToXml(IVsSettingsWriter) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Called by Visual Studio to store the settings of a dialog page to the Visual Studio settings storage on disk.

public:
 virtual void SaveSettingsToXml(Microsoft::VisualStudio::Shell::Interop::IVsSettingsWriter ^ writer);

public:
 virtual void SaveSettingsToXml(Microsoft::VisualStudio::Shell::Interop::IVsSettingsWriter ^ writer);

 virtual void SaveSettingsToXml(Microsoft::VisualStudio::Shell::Interop::IVsSettingsWriter const & writer);

public virtual void SaveSettingsToXml (Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter writer);

abstract member SaveSettingsToXml : Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter -> unit
override this.SaveSettingsToXml : Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter -> unit

Public Overridable Sub SaveSettingsToXml (writer As IVsSettingsWriter)

Parameters

writer

IVsSettingsWriter

[in]A IVsSettingsWriter interface that is provided by the environment to the VSPackage to give write access to the Visual Studio settings file.

Implements

SaveSettingsToXml(IVsSettingsWriter)

Remarks

SaveSettingsToXml implements LoadSettingsFromXml.

This method is called to save the settings of a dialog page to the Visual Studio settings storage on disk.

The default implementation saves setting information for all the properties of the dialog page's automation object that support conversion to a string through TypeConverter.

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, not the properties of the class, that are retrieved.