How to: Install a Top-Level Tab


Applies To: Windows Server 2012 Essentials, Windows Home Server 2011, Windows Storage Server 2008 R2 Essentials, Windows Small Business Server 2011 Essentials

To install your new top-level tab in the Dashboard, you must create an .addin file that provides the name and location information for the add-in that contains the top-level tab.

An .addin file is required for each top-level tab that you create. The .addin file is an XML file that is used by the Dashboard to identify and load the binary files that are associated with your add-in. The following table lists the attributes that are defined in the .addin file.

Attribute Description
name The identifier for your add-in.
basedir The full path to the folder that contains the binary files.
type The fully qualified type name of the object that defines the add-in and the name of the .dll file (without the .dll extension).

To create the .addin file

  1. In the TopLevelTab project, open the AddinConfig.addin file.

    For a list view subtab, the file contains the following code:

    <addin name="Test Add-in" basedir="PROVIDE_FULL_PATH_TO_BINARIES_HERE" type="MyNamespace.TopLevelTabPageProvider, TopLevelTab" />  
  2. Change the name, type, and basedir attributes to values that are specific for your add-in.

  3. Save the .addin file.

  4. Rename the AddinConfig.Addin file to a unique name that does not conflict with other installed add-ins.

For more information about the installation requirements for add-ins, see Add-In Installation Requirements.

For the Dashboard to load the top-level tab, you must place the .addin file and the associated binary files in the appropriate folders on the server. The steps in the following procedure can be used for top-level tabs that contain list view subtabs and custom control subtabs.

To install the add-in files

  1. Ensure that the Visual Studio solution for your top-level tab successfully builds.

  2. Ensure that the .addin file has a unique name from other installed add-ins.

  3. Copy the .addin file to the following folder:

    %ProgramFiles%\Windows Server\Bin\Addins\Primary


    The Addins\Primary folder does not exist by default.

  4. Copy the binary files that are associated with the add-in to the folder that is specified by the basedir attribute in the .addin file.