Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

My.Settings Object 

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

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.

Properties

The properties of the My.Settings object provide access to your application's settings. To add or remove settings, use the Settings Designer. For more information, see How to: Add or Remove Application Settings.

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.

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

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. For more information, see How to: Add or Remove Application Settings.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft