ApplicationSettingsBase.Reset Method

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-preview.3.24172.9

Source:

ApplicationSettingsBase.cs

Restores the persisted application settings values to their corresponding default properties.

public:
 void Reset();

public void Reset ();

member this.Reset : unit -> unit

Public Sub Reset ()

Exceptions

ConfigurationErrorsException

The configuration file could not be parsed.

Examples

The following code example shows the Reset method being invoked in the body of the Click event handler for a button named btnReset. As a result of this call, the stored default values for the application settings are reloaded into their corresponding properties. The full code example is listed in the ApplicationSettingsBase class overview.

private:
    void ResetButton_Click(Object^ sender, EventArgs^ e)
    {
        formSettings->Reset();
        this->BackColor = SystemColors::Control;
    }

private void btnReset_Click(object sender, EventArgs e)
{
    frmSettings1.Reset();
    this.BackColor = SystemColors.Control;
}

Private Sub btnReset_Click(ByVal sender As Object, ByVal e As EventArgs) _
        Handles btnReset.Click
    frmSettings1.Reset()
    Me.BackColor = SystemColors.Control
End Sub

Remarks

The Reset method overwrites the user-scoped settings properties by restoring the currently persisted value of each application settings. This method performs the following actions:

• It calls the IApplicationSettingsProvider.Reset method on every settings provider that supports this optional method.

• It calls the Reload method to force a refresh of the settings property values.

Reload contrasts with Reset in that the former will load the last set of saved application settings values, whereas the latter will load the saved default values.

See also

• Reload()
• Save()
• Reset(SettingsContext)