DialogPage::SaveSettingsToXml Method (IVsSettingsWriter^)

 

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

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

public:
virtual void SaveSettingsToXml(
	IVsSettingsWriter^ writer
)

Parameters

writer
Type: Microsoft.VisualStudio.Shell.Interop::IVsSettingsWriter^

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

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.

System_CAPS_noteNote

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.

Return to top
Show: