Walkthrough: Save user settings on a Start Page

Article
11/04/2016

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

You can persist user settings for your Start Page. By following this walkthrough, you can create a control that saves a setting to the registry when the user clicks a button, and then retrieves that setting every time the Start Page loads. Because the Start Page project template includes a customizable user control, and the default Start Page XAML calls that control, you don't have to modify the Start Page itself.

The settings store that is instantiated in this walkthrough is an instance of the IVsWritableSettingsStore interface, which reads and writes to the following registry location when it's called: HKCU\Software\Microsoft\VisualStudio\14.0\<CollectionName>

When it's running in the experimental instance of Visual Studio, the settings store reads and writes to HKCU\Software\Microsoft\VisualStudio\14.0Exp\<CollectionName>.

For more information about how to persist settings, see Extending User Settings and Options.

Prerequisites

Note

To follow this walkthrough, you must install the Visual Studio SDK. For more information, see Visual Studio SDK.

You can download the Start Page project template by using Extension Manager.

Set up the project

Create a Start Page project as described in Create a custom Start Page. Name the project SaveMySettings.
In Solution Explorer, add the following assembly references to the StartPageControl project:
- EnvDTE
- EnvDTE80
- Microsoft.VisualStudio.OLE.Interop
- Microsoft.VisualStudio.Shell.Interop.11.0
Open MyControl.xaml.
From the XAML pane, in the top-level UserControl element definition, add the following event declaration after the namespace declarations.
```
Loaded="OnLoaded"
```
In the design pane, click the main area of the control, and then press Delete.

This step removes the Border element and everything in it, and leaves only the top level Grid element.
From the Toolbox, drag a StackPanel control to the grid.
Now drag a TextBlock, a TextBox, and a Button to the StackPanel.

Add an x:Name attribute for the TextBox, and a Click event for the Button, as shown in the following example.

<StackPanel Width="300" HorizontalAlignment="Center" VerticalAlignment="Center">
    <TextBlock Width="140" FontSize="14">Enter your setting</TextBlock>
    <TextBox x:Name="txtblk" Margin="0, 5, 0, 10" Width="140" />
    <Button Click="Button_Click" Width="100">Save My Setting</Button>
</StackPanel>

Implement the user control

In the XAML pane, right-click the Click attribute of the Button element, and then click Navigate to Event Handler.

This step opens MyControl.xaml.cs, and creates a stub handler for the Button_Click event.

Add the following using directives to the top of the file.

using EnvDTE80;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Shell.Interop;
using System.ComponentModel;

Add a private SettingsStore property, as shown in the following example.

private IVsWritableSettingsStore _settingsStore = null;
private IVsWritableSettingsStore SettingsStore
{
    get
    {
        if (_settingsStore == null)
        {
            // Get a reference to the DTE from the DataContext.
            var typeDescriptor = DataContext as ICustomTypeDescriptor;
            var propertyCollection = typeDescriptor.GetProperties();
            var dte = propertyCollection.Find("DTE", false).GetValue(
                DataContext) as DTE2;

            // Get the settings manager from the DTE.
            var serviceProvider = new ServiceProvider(
                (Microsoft.VisualStudio.OLE.Interop.IServiceProvider)dte);
            var settingsManager = serviceProvider.GetService(
                typeof(SVsSettingsManager)) as IVsSettingsManager;

            // Write the user settings to _settingsStore.
            settingsManager.GetWritableSettingsStore(
                (uint)__VsSettingsScope.SettingsScope_UserSettings,
                out _settingsStore);
        }
        return _settingsStore;
    }
}

This property first gets a reference to the DTE2 interface, which contains the Automation object model, from the DataContext of the user control, and then uses the DTE to get an instance of the IVsSettingsManager interface. Then it uses that instance to return the current user settings.

Fill in the Button_Click event as follows.

private void Button_Click(object sender, RoutedEventArgs e)
{
    int exists = 0;
    SettingsStore.CollectionExists("MySettings", out exists);
    if (exists != 1)
    {
        SettingsStore.CreateCollection("MySettings");
    }
    SettingsStore.SetString("MySettings", "MySetting", txtblk.Text);
}

This writes the content of the text box to a "MySetting" field in a "MySettings" collection in the registry. If the collection does not exist, it's created.

Add the following handler for the OnLoaded event of the user control.

private void OnLoaded(Object sender, RoutedEventArgs e)
{
    string value;
    SettingsStore.GetStringOrDefault(
        "MySettings", "MySetting", "", out value);
    txtblk.Text = value;
}

This code sets the text of the text box to the current value of "MySetting".

Build the user control.
In Solution Explorer, open source.extension.vsixmanifest.
In the manifest editor, set Product Name to Save My Settings Start Page.

This feature sets the name of the Start Page as it's to appear in the Customize Start Page list in the Options dialog box.
Build StartPage.xaml.

Test the control

Press F5.

The experimental instance of Visual Studio opens.
In the experimental instance, on the Tools menu, click Options.
In the Environment node, click Startup, and then, in the Customize Start Page list, select [Installed Extension] Save My Settings Start Page.

Click OK.
Close the Start Page if it's open, and then, on the View menu, click Start Page.
On the Start Page, click the MyControl tab.
In the text box, type Cat, and then click Save My Setting.
Close the Start Page and then open it again.

The word "Cat" should be displayed in the text box.
Replace the word "Cat" with the word "Dog". Do not click the button.
Close the Start Page and then open it again.

The word "Dog" should be displayed in the text box, even though you didn't save the setting because Visual Studio keeps tool windows in memory, even if they are closed, until Visual Studio itself closes.
Close the experimental instance of Visual Studio.
Press F5 to reopen the experimental instance.
The word "Cat" should be displayed in the text box.

Next steps

You can modify this user control to save and retrieve any number of custom settings by using different values from different event handlers to get and set the SettingsStore property. As long as you use a different propertyName parameter for each call to SetString, the values don't overwrite one another in the registry.

Share via