Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Registering the Smart Client Software Development Package

Retired Content

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies.
This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

You can use the Smart Client Development guidance package to automate Smart client development activities that you would otherwise have to manually perform. It includes recipes and templates to generate Visual Studio artifacts such as projects, classes, and code. These artifacts are consistent with the guidance contained in the Smart Client Software Factory.

Ff649642.note(en-us,PandP.10).gifNote:
You can install the guidance package with the Smart Client Software Factory installer, or you can use the guidance package source code to create a custom guidance package. This topic describes how to build, register, and install a custom guidance package that you create from source code.

Building the Guidance Package

The guidance package is available as source code. If you do not select the option to install the guidance package when you install the software factory, you must compile the guidance package before you can install (or register) it. The following procedure describes how to compile the guidance package and the installer.

To compile the guidance package and guidance package installer

  1. Using Visual Studio, open the solution file GuidancePackage.sln.
  2. On the Build menu, click Rebuild Solution. By default, this is a debug build.

Registering a Guidance Package

The installation process works well when you distribute a guidance package. However, it makes it difficult to efficiently test incremental changes as you modify a guidance package. For developers of guidance packages, the Guidance Automation Toolkit provides the following recipes to make it easier to test changes:

  • Register Guidance Package. This recipe registers the package you are developing on your computer. Registration is a form of installation that you can perform without leaving the Visual Studio development environment.
  • Quick Register. This recipe performs a quick registration of the guidance package. You must perform a full registration of the guidance package before you use the Quick Register recipe.
  • Unregister Guidance Package. This recipereverses the registration.

Ff649642.note(en-us,PandP.10).gifNote:
Since the Guidance Automation Toolkit requires registry access when registering a guidance package, if you are running Windows Vista with User Account Control (UAC) turned on you must run Visual Studio as an administrator. To do this, right-click the Visual Studio shortcut or executable and select Run as administrator.

To register the guidance package and guidance package installer

  1. Using Visual Studio, open the solution file GuidancePackage.sln.
  2. On the Build menu, click Rebuild Solution. By default, this is a debug build.
  3. Use the Guidance Package Manager to enable the Guidance Package Development guidance package. You must do this before you can use the Register Guidance Package recipe, Quick Register recipe, and Unregister Guidance Package recipe.
    Ff649642.note(en-us,PandP.10).gifNote:
    After you enable the Guidance Package Development guidance package, the Guidance Navigator will appear in Visual Studio. This window displays an overview of the guidance package and available recipes.

  4. In Solution Explorer, right-click SmartClientFactoryPackage, and then click Register Guidance Package.

    After you register a guidance package, you can open a new instance of Visual Studio to test the functionality of the package. This means that you do not have to continually rebuild the setup project and run the Windows Installer package for the guidance package every time you want to test the progress of your development.

    You should unregister the package if you want to do one or both of the following:

      Install the guidance packages using the Windows Installer package.
  • Install the guidance packages using the Windows Installer package.
  • Remove the guidance package from your computer.

After you unregister a guidance package (or uninstall it), you can register it again by executing the Register Guidance Package recipe.

Enabling the Guidance Package

There are two ways to enable the Smart Client Development guidance package:

  • Unfolding the Visual Studio solution named Smart Client Solution (this solution template contains actions that enable the package for the solution that it creates)
  • Selecting and enabling the guidance package in Guidance Package Manager

To enable the Smart Client Development guidance package by unfolding a solution template, see the topic How to: Create Smart Client Solutions. The following procedure describes how to enable the guidance package using the Guidance Package Manager.

To enable the Smart Client Development guidance package with the Guidance Package Manager

  1. Using Visual Studio, open your solution.
  2. On the Tools menu, click Guidance Package Manager.
  3. In the Guidance Package Manager dialog box, click Enable / Disable Packages.
  4. In the Enable and Disable Packages dialog box, select the Smart Client Development - April 2008 check box.
  5. Click OK.

Ff649642.note(en-us,PandP.10).gifNote:
The recipes in the Smart Client Development guidance package are designed to work with a solution that you create with the Smart Client Application template. For a description of the requirements for a recipe, see the documentation for that recipe.

Show:
© 2014 Microsoft. All rights reserved.