Walkthrough: Deploying a Windows-based Application

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

Want more? Here are some additional resources on this topic:

Visual C++ Walkthroughs

Deployment in Visual Studio

Walkthrough: Deploying a Windows-based Application

This walkthrough demonstrates the process of creating an installer for a Windows-based application that launches Notepad. In this walkthrough, you will create the Windows-based application, then create an installer that sets up shortcuts and file associations, adds an entry to the registry, displays custom dialogs, and checks the version of Internet Explorer during installation.

When creating your own installers, not all of these steps are necessary. This walkthrough is intended to introduce you to some of the optional capabilities of deployment that you may find useful. To create a basic installer, complete the first four sets of procedures.

Note
The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. To change your settings, choose Import and Export Settings on the Tools menu. For more information, see Visual Studio Settings.

Note
The following instructions demonstrate creating a deployment project using a Visual Basic project; the general principles apply to all Visual Studio language projects that support deploying Windows-based applications.

Basic Application Creation and Deployment

To create a Windows-based application

On the File menu, click New Project.
In the New Project dialog box, in the Project Types pane, select Visual Basic, then choose Windows Application in the Templates pane. In the Name box, type My Notepad.
Click OK to close the dialog box.

The project is added to Solution Explorer, and the Windows Forms Designer opens.
Select the All Windows Forms tab in the Toolbox and drag a Button control onto the form.
Double-click the Button control to add an event handler for the button. In the event handler, add the following code:
```
Shell("Notepad.exe", AppWinStyle.NormalFocus)
```
This will launch Notepad.exe and give it focus.
On the Build menu, choose Build My Notepad to build the application.

To create a deployment project

On the File menu, point to Add, and then click New Project.
In the Add New Project dialog box, in the Project Types pane, open the Other Project Types node, click Setup and Deployment Projects, then click Setup Project in the Templates pane. In the Name box, type My Notepad Installer.
Click OK to close the dialog box.

The project is added to Solution Explorer, and the File System Editor opens.
Select the My Notepad Installer project in Solution Explorer. In the Properties window, select the ProductName property and type My Notepad.

Note

The ProductName property specifies the name that will be displayed for the application in folder names and in the Add/Remove Programs dialog box.

Note
The ProductName property specifies the name that will be displayed for the application in folder names and in the Add/Remove Programs dialog box.

To add the Windows-based application to the installer

Select the My Notepad Installer project in Solution Explorer. In the File System Editor, select the Application Folder node.
On the Action menu, point to Add, and then click Project Output.
In the Add Project Output Group dialog box, choose My Notepad from the Project drop-down list.
Select the Primary Output group from the list. In the Configuration box, select (Active). Click OK to close the dialog box.
On the Build menu, choose Build My Notepad Installer.

To deploy the application (basic installer)

Select the My Notepad Installer project in Solution Explorer. On the Project menu, choose Install.

This will run the installer (Setup Wizard) and install My Notepad on your development computer.

Note

You must have install permissions on the computer in order to run the installer.

Note
You must have install permissions on the computer in order to run the installer.

Optional Deployment Capabilities

This step demonstrates optional deployment capabilities; it creates a shortcut to your application that will be placed on the desktop of a target computer during installation.

To create shortcuts for the Windows-based application

Select the My Notepad Installer project in Solution Explorer.
In the File System Editor, select the Primary output from My Notepad node.
On the Action menu, choose Create Shortcut to Primary Output from My Notepad.

This will add a node called Shortcut to Primary output from My Notepad.
Rename the shortcut Shortcut to My Notepad.
Select Shortcut to My Notepad and drag it to the User's Desktop folder in the left pane.

Creating a File Association

This step adds a file association for My Notepad so that double-clicking .vbn files open the My Notepad application.

To create file associations for the Windows-based application

Select the My Notepad Installer project in Solution Explorer. On the View menu, point to Editor, and then choose File Types. The File Types Editor appears.
In the File Types Editor, select the File Types on Target Machine node. On the Action menu, choose Add File Type.

A node named New Document Type #1 is added and opened for renaming.
Rename New Document Type #1 as Vbn.doc.
In the Properties window, set the Extensions property of the file type to vbn.
Select the Command property and click the ellipsis (...) button. In the Select Item in Project dialog box, navigate to the Application Folder, and select Primary output from My Notepad.
Click OK to close the dialog box.

Adding a Registry Entry

This step adds a registry key and value to the registry. You can reference this registry key from your application's code to retrieve user-specific information at run time.

To add a registry entry for the Windows-based application

Select the My Notepad Installer project in Solution Explorer. On the View menu, point to Editor, and choose Registry. The Registry Editor appears.
In the Registry Editor, select the HKEY_CURRENT_USER node and expand it, then expand the Software node and select the [Manufacturer] node.

Note

The [Manufacturer] node is surrounded by brackets to denote that it is a property. It will be replaced by the value entered for the Manufacturer property for the deployment project.
On the Action menu, point to New, and then click Key.
Rename the key UserChoice and select it.
On the Action menu, point to New, and then click String Value.
Rename the string value TextColor.
In the Properties window, select the Value property and enter Black.

Note
The [Manufacturer] node is surrounded by brackets to denote that it is a property. It will be replaced by the value entered for the Manufacturer property for the deployment project.

Adding a Custom Installation Dialog Box

This step adds and configures a custom user interface dialog box that will be displayed during installation.

To add a custom installation dialog box

Select the My Notepad Installer project in Solution Explorer. On the View menu, point to Editor, and choose User Interface. The User Interface Editor appears.
In the User Interface Editor, select the Start node (under the Install node).
On the Action menu, choose Add Dialog.
In the Add Dialog dialog box, choose Checkboxes (A).
Click OK to close the dialog box.
Right-click the Checkboxes (A) dialog box and select Move Up twice to position it above the Installation Folder dialog box.
In the Properties window, set the BannerText property to Samples.
Set the BodyText property to the following:

The Install Samples check box controls whether or not the sample files are installed. If left unselected, the samples will not be installed.
Set the CheckBox1Label property to Install samples?
Set the properties Checkbox2Visible, Checkbox3Visible, and Checkbox4Visible to False. This will hide the additional check boxes.

Working with Samples

This step creates a Samples subfolder that will be installed beneath the Application folder.

To add a Samples folder

Select the My Notepad Installer project in Solution Explorer. On the View menu, point to Editor, and choose File System. Select Application Folder if it is not already.
Right-click Application Folder and on the context menu point to Add, and then click Folder.
Rename New Folder #1 to Samples.

This step creates two sample text files that will be installed if the user chooses the Install samples option in the custom dialog box.

To create sample files for the application

Using Notepad or another text editor, create a text file containing the text This is rules.vbn. Save it as Rules.vbn.

Note

To prevent Notepad from automatically adding a .txt extension, choose All Files in the Files of type drop-down list.
Create another text file containing the text This is memo.vbn. Save it as Memo.vbn.

Note
To prevent Notepad from automatically adding a .txt extension, choose All Files in the Files of type drop-down list.

This step adds the sample files to the Samples folder, and sets a condition that determines whether to install the files.

To add the samples to the installer

Select the My Notepad Installer project in Solution Explorer. On the View menu, point to Editor, choose File System, and select the Samples folder.
From the Action menu, point to Add, and then choose File. Add the Rules.vbn and Memo.vbn files to the Samples folder.
Select the file Rules.vbn in the File System Editor.
In the Properties window, set the Condition property to CHECKBOXA1=1. When the installer is run, the file Rules.vbn will only be installed if the custom check box is selected.
Select the file Memo.vbn in the File System Editor.
In the Properties window, set the Condition property to CHECKBOXA1=1. When the installer is run, the file Memo.vbn will only be installed if the custom check box is selected.

Adding Launch Conditions

This step checks to see if Internet Explorer 5.0 or higher is installed on a target computer, and it halts installation if the file is not installed.

To add a launch condition to check the Internet Explorer version

Select the My Notepad Installer project in Solution Explorer. On the View menu, point to Editor, and then click Launch Conditions.

Note

This step is intended only to demonstrate the concept of launch conditions; the My Notepad application has no actual dependency on Internet Explorer.
In the Launch Conditions Editor, select the Requirements on Target Machine node.
On the Action menu, choose Add File Launch Condition.

A Search for File1 node is added beneath the Search Target Machine node, and a Condition1 node is added beneath the Launch Conditions node.
Rename Search for File1 to Search for Internet Explorer.
In the Properties window, set the FileName property to Iexplore.exe, the Folder property to [ProgramFilesFolder], the Depth property to 2, and the MinVersion property to 5.00.
Select the Condition1 node.
Set the Message property to the following:

This program requires Microsoft Internet Explorer 5.0 or higher. Please install Internet Explorer and rerun the Notepad installer.

Note
This step is intended only to demonstrate the concept of launch conditions; the My Notepad application has no actual dependency on Internet Explorer.

Setting Properties for Prerequisite Components

This step sets a property to install the .NET Framework automatically if the correct version is not present on the target computer. Note that the .NET Framework 2.0 package will also install the Windows Installer 2.0 files.

When the prerequisites properties are set as follows, clicking setup.exe will automatically install .NET Framework before running the .msi file (this is set by default). For more information on specifying prerequisites, see Prerequisites Dialog Box.

To set optional properties for the deployment project

Select the My Notepad Installer project in Solution Explorer. On the View menu, choose Property Pages.
In the My Notepad Installer Property Pages dialog box, in Installation URL, specify the URL of a server or Web site from which the application and/or prerequisites will be installed. Click the Prerequisites button.
In the Prerequisites dialog box, under Choose which prerequisites to install, make sure that .NET Framework is selected (it should be selected by default). Under Specify the install location for prerequisites, accept the default setting.
On the Build menu, select Build My Notepad Installer.

Installing on Your Development Computer

This step will run the installer and install My Notepad on your development computer.

To install My Notepad on your development computer

Select the My Notepad Installer project in Solution Explorer. On the Project menu, choose Install.

Note

You must have install permissions on the computer in order to run the installer.

Note
You must have install permissions on the computer in order to run the installer.

Deploying to Another Computer

This step will run the installer and install My Notepad on another computer.

To deploy My Notepad to another computer

In Windows Explorer, navigate to your project directory and find the built installer. The default path will be \Documents and Settings\yourloginname\My Documents\Visual Studio 2005\Projects\Solution Folder Name\My Notepad Installer\project configuration\My Notepad Installer.msi. (The default project configuration is either Debug or Release.)
Copy My Notepad Installer.msi, Setup.exe, and all other files and subdirectories in the directory to another computer.

Note

To install on a computer that is not on a network, copy the files to traditional media such as CD-ROM.
On the target computer, double-click Setup.exe to run the installer.

Note

You must have install permissions on the target computer in order to run the installer.

Note
To install on a computer that is not on a network, copy the files to traditional media such as CD-ROM.

Note
You must have install permissions on the target computer in order to run the installer.

Testing

This step will test starting the application from a desktop shortcut and will also test uninstalling it.

To test the installation

Verify that the shortcut is installed on the desktop and that it correctly launches the My Notepad application.
Uninstall the application using the Add or Remove Programs tool in Control Panel. In Add or Remove Programs, select My Notepad, then click the Remove button.

Tip

To uninstall from your development computer, on the Project menu, choose Uninstall.
The icon should be removed from the desktop and the installed application files and folders should be deleted from your computer.

Tip
To uninstall from your development computer, on the Project menu, choose Uninstall.

Tasks

How to: Create or Add Deployment Projects
How to: Add Items to a Deployment Project

Other Resources

File Installation Management in Deployment
Registry Settings Management in Deployment
File Types Management in Deployment
User Interface Management in Deployment
Launch Condition Management in Deployment

Tags

: Add a tag

Community Content

Add new content

Annotations

Selecting the Primary output from the application node

Simple Samples | Edit | Show History

I created my deployment project using the Setup Wizard template instead of the Setup Project template. I don't know if that is why the layout is slightly different but it took time for me to find the "Primary output from" application. In the File System Editor, I had to first select "Application Folder" in the file system tree and then I could select the Primary output from the application.

Tags

: Add a tag

Flag as ContentBug

Finding the PropertyName Value for C++ with Visual Studio 2005

Developah | Edit | Show History

Highlight the Windows Installer Project Name in the Solutions Window that you created as per the above.
Then use the top menu bar - View - Other Windows - Properties Window to get to the properties that you need.
You can then finally access the ProductName and Manufacturer properties needed by the Installer.
You will notice that right clicking on the Windows Installer Project Name, or using the Properties Icon of Solution Explorer, both bring up a Properties Pages window that is not the one that you need.
Furthermore, there is a second PropertyName and CompanyName, this time in Resource View - Version - VS_VERSION_INFO. Double Click on this and access the properties of the table that will appear. These names will appear under any Icons that you create when viewed in windows folders later.
You must also add the "primary output" to your "application folder." Primary Output is Microsoft's strange way of referring to your program's executable file. It is hard to reason why this is not there already by default.
I hope this information helps someone else from wasting a few hours on what should only take a minute.

Tags

: Add a tag

Flag as ContentBug

Hii All

Dinesh Lakmal | Edit | Show History

I want to deploy a C# application with a sql database and install it in a computer which does not visual studio installed.Is it possible?,if possible please tell me how

Tags

: Add a tag

Flag as ContentBug