Creating a custom Start Page

  • Article

Applies to: yesVisual Studio noVisual 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 create a custom Start Page by following the steps in this document.

Create a blank Start Page

First, make a blank Start Page by creating a .xaml file that has a tag structure that Visual Studio will recognize. Then, add markup and code-behind to produce the appearance and functionality you want.

  1. Create a new project of the type WPF Application (Visual C# > Windows Desktop).

  2. Add a reference to Microsoft.VisualStudio.Shell.14.0.

  3. Open the XAML file in the XML editor and change the top-level <Window> element to a <UserControl> element without removing any of the namespace declarations.

  4. Remove the x:Class declaration from the top-level element. This makes the XAML content compatible with the Visual Studio tool window that hosts the Start Page.

  5. Add the following namespace declarations to the top-level <UserControl> element.

    xmlns:vs="clr-namespace:Microsoft.VisualStudio.PlatformUI;assembly=Microsoft.VisualStudio.Shell.14.0"
xmlns:vsfx="clr-namespace:Microsoft.VisualStudio.Shell;assembly=Microsoft.VisualStudio.Shell.14.0"

    These namespaces let you access Visual Studio commands, controls, and UI settings. For more information, see Add Visual Studio commands to a Start Page.

    The following example shows the markup in the .xaml file for a blank Start Page. Any custom content should go in the inner Grid element.

    <UserControl
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:MyNamespace="clr-namespace:ManualStartPage;assembly=ManualStartPage"
    xmlns:vs="clr-namespace:Microsoft.VisualStudio.PlatformUI;assembly=Microsoft.VisualStudio.Shell.14.0"
            xmlns:vsfx="clr-namespace:Microsoft.VisualStudio.Shell;assembly=Microsoft.VisualStudio.Shell.14.0"
    xmlns:local="clr-namespace:StartPageHost"
    mc:Ignorable="d"
     Height="350" Width="525">
    <Grid>
    <!--Add content here.-->
    </Grid>
</UserControl>

  6. Add controls to the empty <UserControl> element to fill in your custom Start Page. For information about how to add functionality that is specific to Visual Studio, see Add Visual Studio commands to a Start Page.

Test and apply the custom Start Page

Do not set the primary instance of Visual Studio to run the custom Start Page until you verify that it does not crash Visual Studio. Instead, test it in the experimental instance.

To test a manually-created custom Start Page

  1. Copy your XAML file, and any supporting text files or markup files, to the %USERPROFILE%\My Documents\Visual Studio 2015\StartPages\ folder.

  2. If your start page references any controls or types in assemblies that are not installed by Visual Studio, copy the assemblies and then paste them in {Visual Studio installation folder}\Common7\IDE\PrivateAssemblies\.

  3. At a Visual Studio command prompt, type devenv /rootsuffix Exp to open an experimental instance of Visual Studio.

  4. In the experimental instance, go to the Tools > Options > Environment > Startup page and select your XAML file from the Customize Start Page dropdown.

  5. On the View menu, click Start Page.

    Your custom start page should be displayed. If you want to change any files, you must close the experimental instance, make the changes, copy and paste the changed files, and then re-open the experimental instance to view the changes.

To apply the custom start page in the primary instance of Visual Studio

  • After you have tested your Start Page and found it to be stable, use the Customize Start Page option in the Options dialog box to select it as the start page in the primary instance of Visual Studio

See also