Edit

My.Settings Object

  • Article

Provides properties and methods for accessing the application's settings.

Remarks

The My.Settings object provides access to the application's settings and allows you to dynamically store and retrieve property settings and other information for your application. For more information, see Managing Application Settings (.NET).

Properties

The properties of the My.Settings object provide access to your application's settings. To add or remove settings, use the Settings Designer.

Each setting has a Name, Type, Scope, and Value, and these settings determine how the property to access each setting appears in the My.Settings object:

  • Name determines the name of the property.

  • Type determines the type of the property.

  • Scope indicates if the property is read-only. If the value is Application, the property is read-only; if the value is User, the property is read-write.

  • Value is the default value of the property.

Methods

Method Description
Reload Reloads the user settings from the last saved values.
Save Saves the current user settings.

The My.Settings object also provides advanced properties and methods, inherited from the ApplicationSettingsBase class.

Tasks

The following table lists examples of tasks involving the My.Settings object.

To See
Read an application setting How to: Read Application Settings in Visual Basic
Change a user setting How to: Change User Settings in Visual Basic
Persist user settings How to: Persist User Settings in Visual Basic
Create a property grid for user settings How to: Create Property Grids for User Settings in Visual Basic

Example

This example displays the value of the Nickname setting.

Sub ShowNickname()
    MsgBox("Nickname is " & My.Settings.Nickname)
End Sub

For this example to work, your application must have a Nickname setting, of type String.

See also