WindowsFormsApplicationBase.SaveMySettingsOnExit Property

 

Determines whether the application saves the user settings on exit.

Namespace:   Microsoft.VisualBasic.ApplicationServices
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public bool SaveMySettingsOnExit { get; set; }

Property Value

Type: System.Boolean

Boolean. True indicates that the application saves the user settings on exit. Otherwise, the settings are not implicitly saved.

The SaveMySettingsOnExit property allows the user to change how the application saves settings, at run time. You can explicitly save setting changes by using the Save method of the My.Settings object. For more information about changing and saving settings, see Application Properties.

The changes to this property are not persisted when the application closes. To change the SaveMySettingsOnExit property permanently, you must change the setting in the Project Designer:

To change the setting in the Project Designer

  1. Have a project selected in Solution Explorer. Click Properties on the Project menu.

  2. Click the Application tab.

  3. Select Save My.Settings on Shutdown.

Project type

Available

Windows Forms Application

Yes

Class Library

No

Console Application

No

Windows Forms Control Library

No

Web Control Library

No

Windows Service

No

Web Site

No

This example has two parts.

  • The InitializeSaveMySettingsOnExit subroutine, which initializes the checked state of a CheckBox control to the current value of the SaveMySettingsOnExit property.

  • The SaveMySettingsOnExit_CheckedChanged subroutine, which handles changes to a CheckBox control to update the My.Application.SaveMySettingsOnExit property.

Private Sub InitializeSaveMySettingsOnExit()
    SaveMySettingsOnExit.Checked = 
        My.Application.SaveMySettingsOnExit
End Sub
Private Sub SaveMySettingsOnExit_CheckedChanged( 
    ByVal sender As System.Object, 
    ByVal e As System.EventArgs 
) Handles SaveMySettingsOnExit.CheckedChanged
    My.Application.SaveMySettingsOnExit = 
        SaveMySettingsOnExit.Checked
End Sub

For this example to work, your application must have a CheckBox control named SaveMySettingsOnExit.

.NET Framework
Available since 2.0
Return to top
Show: