Skip to content

how-to-create-property-grids-for-user-settings.md

Latest commit

 

History

History
61 lines (46 loc) · 4.56 KB

how-to-create-property-grids-for-user-settings.md

File metadata and controls

61 lines (46 loc) · 4.56 KB
Raw
title How to: Create Property Grids for User Settings in Visual Basic
ms.custom
ms.date 07/20/2015
ms.prod .net
ms.reviewer
ms.suite
ms.technology
devlang-visual-basic
ms.topic article
helpviewer_keywords
My.Settings object [Visual Basic], creating property grids for user settings
user settings [Visual Basic], creating property grids
property grids [Visual Basic], creating for user settings
property grids
ms.assetid b0bc737e-50d1-43d1-a6df-268db6e6f91c
caps.latest.revision 13
author dotnet-bot
ms.author dotnetcontent

How to: Create Property Grids for User Settings in Visual Basic

You can create a property grid for user settings by populating a xref:System.Windows.Forms.PropertyGrid control with the user setting properties of the My.Settings object.

Note

In order for this example to work, your application must have its user settings configured. For more information, see Managing Application Settings (.NET).

The My.Settings object exposes each setting as a property. The property name is the same as the setting name, and the property type is the same as the setting type. The setting's Scope determines if the property is read-only; the property for an Application-scope setting is read-only, while the property for a User-scope setting is read-write. For more information, see My.Settings Object.

Note

You cannot change or save the values of application-scope settings at run time. Application-scope settings can be changed only when creating the application (through the Project Designer) or by editing the application's configuration file. For more information, see Managing Application Settings (.NET).

This example uses a xref:System.Windows.Forms.PropertyGrid control to access the user-setting properties of the My.Settings object. By default, the xref:System.Windows.Forms.PropertyGrid shows all the properties of the My.Settings object. However, the user-setting properties have the xref:System.Configuration.UserScopedSettingAttribute attribute. This example sets the xref:System.Windows.Forms.PropertyGrid.BrowsableAttributes%2A property of the xref:System.Windows.Forms.PropertyGrid to xref:System.Configuration.UserScopedSettingAttribute to display only the user-setting properties.

To add a user setting property grid

  1. Add the PropertyGrid control from the Toolbox to the design surface for your application, assumed here to be Form1.

    The default name of the property-grid control is PropertyGrid1.

  2. Double-click the design surface for Form1 to open the code for the form-load event handler.

  3. Set the My.Settings object as the selected object for the property grid.

    [!code-vbVbVbalrMyResources#11]

  4. Configure the property grid to show only the user settings.

    [!code-vbVbVbalrMyResources#12]

    [!NOTE] To show only the application-scope settings, use the xref:System.Configuration.ApplicationScopedSettingAttribute attribute instead of xref:System.Configuration.UserScopedSettingAttribute.

Robust Programming

The application saves the user settings when the application shuts down. To save the settings immediately, call the My.Settings.Save method. For more information, see How to: Persist User Settings in Visual Basic.

See Also

My.Settings Object
How to: Read Application Settings in Visual Basic
How to: Change User Settings in Visual Basic
How to: Persist User Settings in Visual Basic
Managing Application Settings (.NET)