ApplicationSettingsBase.Save Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Stores the current values of the application settings properties.
public:
override void Save();public override void Save ();override this.Save : unit -> unitPublic Overrides Sub Save ()Examples
The following code example shows the Save method being called from the Closing event handler for the primary form. This method also appends an extra period to the settings property that is associated with the form's Text property.
The full code example is listed in the ApplicationSettingsBase class overview.
private:
void AppSettingsForm_FormClosing(Object^ sender,
FormClosingEventArgs^ e)
{
//Synchronize manual associations first.
formSettings->FormText = this->Text + '.';
formSettings->Save();
}
private void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
//Synchronize manual associations first.
frmSettings1.FormText = this.Text + '.';
frmSettings1.FormSize = this.Size;
frmSettings1.Save();
}
Private Sub Form1_FormClosing_1(ByVal sender As Object, ByVal e As _
FormClosingEventArgs) Handles MyBase.FormClosing
'Synchronize manual associations first.
frmSettings1.FormText = Me.Text + "."c
' Save size settings manually.
frmSettings1.FormSize = Me.Size
frmSettings1.Save()
End Sub
Remarks
The Save method writes the current value of each settings property to its associated data store. For each property, this method calls the SetPropertyValues method on the associated settings provider.
This method differs from the base class implementation in that it raises the SettingsSaving event before the values are written.
If the only settings defined are application-scoped settings, Save will have no effect and return no error if called with the default LocalFileSettingsProvider. LocalFileSettingsProvider only saves user-scoped settings.
Important
There is no corresponding Load method because the values of application settings are automatically loaded during wrapper class initialization. In contrast, these values are not automatically saved when an application ends. Therefore, you must explicitly call the Save method to persist the current values of the application settings. This is typically performed in the Closing event handler of the primary or containing Form.
