Skip to content

Commit 5889219

Browse files
authored
Merge pull request #754 from telerik/nkaraiva/vse-upgrade-project-templates
Update VSE upgrade project
2 parents b99c48e + 0e02cf8 commit 5889219

5 files changed

+66
-22
lines changed

visual-studio-integration/visual-studio-extensions/upgrade-project.md

Lines changed: 66 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,52 +11,96 @@ previous_url: installation-deployment-and-distribution-vsx-upgrade-wizard,/devto
1111

1212
# Upgrade project
1313

14-
##
14+
The **Project Upgrade Wizard** is an essential feature of the Telerik Visual Studio Extensions that streamlines the process of upgrading your Telerik UI for WinForms projects to newer versions.
1515

16-
An important feature in the Visual Studio Extensions is the __Project Upgrade Wizard__.
16+
## Overview
1717

18-
The Upgrade Wizard (started by using the __Telerik > Telerik UI for WinForms > Upgrade Wizard__ menu item) is used to change the version of __Telerik UI for WinForms__ your projects use.
18+
The Upgrade Wizard can be accessed in Visual Studio by **Extensions > Telerik > Telerik UI for WinForms > Upgrade Wizard**. It simplifies the process of changing the Telerik UI for WinForms version used in your projects. This tool ensures a smooth transition between versions while maintaining project integrity.
1919

20-
In addition to the pure assembly reference change, the upgrade wizard provides several important features:
20+
## Prerequisites
2121

22-
* Check if a new version of __Telerik UI for WinForms__ is available on the Telerik website.
22+
Before using the Project Upgrade Wizard, ensure that:
2323

24-
* Download of a newly discovered version.
24+
- You have the latest version of Telerik Visual Studio Extensions installed
25+
- Your project currently uses Telerik UI for WinForms controls
26+
- Visual Studio is closed for any projects you plan to upgrade (recommended)
2527

26-
* Visual Studio toolbox update.
28+
## Key Features
2729

28-
* Project themes upgrade.
30+
In addition to updating assembly references, the upgrade wizard provides several important additional features:
2931

30-
* Current project backup.
32+
- **Version Detection**: Automatically checks if a new version of Telerik UI for WinForms is available on the Telerik website
33+
- **Automatic Download**: Downloads newly discovered versions directly from the wizard
34+
- **Toolbox Integration**: Updates the Visual Studio toolbox with the new control versions
35+
- **Theme Upgrade**: Upgrades project themes to be compatible with the new version
36+
- **Backup Creation**: Creates a backup of your current project before making changes
37+
- **Batch Processing**: Upgrades multiple projects in a solution simultaneously
3138

32-
On the first step the wizard provides basic update process information:
39+
## Step-by-Step Upgrade Process
40+
41+
### Step 1: Initialize the Upgrade Wizard
42+
43+
You can find the Upgrade Wizard when you select the solution file in Visual Studio, then go to **Extensions > Telerik > Telerik UI for WinForms > Upgrade Wizard**.
44+
45+
![installation-deployment-and-distribution-vsx-upgrade-project 000](images/installation-deployment-and-distribution-vsx-upgrade-project000.png)
46+
47+
Alternatively, you can right-click on a project file with the mouse, then select **Telerik UI for WinForms > Upgrade Wizard** from the menu.
48+
49+
### Step 2: Upgrade Wizard Information
50+
51+
The wizard starts with an overview of the upgrade process, providing essential information about what will be updated and any important considerations.
3352

3453
![installation-deployment-and-distribution-vsx-upgrade-project 001](images/installation-deployment-and-distribution-vsx-upgrade-project001.png)
3554

36-
On the next step the wizard lists all projects from the solution, which use Telerik UI for WinForms. You can choose which projects will be updated (it is recommended to upgrade all projects to the chosen version, not just part of them) and the version which they will be upgraded to. The Compatibility button will invoke the [Upgrade API Analyzer tool](http://docs.telerik.com/devtools/winforms/api-analyzer):
55+
### Step 3: Select Projects and Target Version
56+
57+
The wizard displays all projects in your solution that use Telerik UI for WinForms. Here you can:
58+
59+
- **Select Projects**: Choose which projects to upgrade. It's recommended to upgrade all projects to maintain version consistency in your solution.
60+
- **Choose Target Version**: Select the Telerik UI for WinForms version to upgrade.
61+
- **Check Compatibility**: Use the **Compatibility** button to invoke the [Upgrade API Analyzer tool](http://docs.telerik.com/devtools/winforms/api-analyzer) to identify potential breaking changes.
62+
63+
>note Upgrading all projects in a solution to the same version prevents compatibility issues and ensures consistent behavior across your application.
3764
3865
![installation-deployment-and-distribution-vsx-upgrade-project 002](images/installation-deployment-and-distribution-vsx-upgrade-project002.png)
3966

40-
The next screen allows you to update the Visual Studio Toolbox with the newly selected controls, so that you avoid accidental reference change during a control drag and drop, as well as creating a backup of your project:
67+
68+
### Step 4: Configure Toolbox and Backup Options
69+
70+
The final configuration screen allows you to:
71+
72+
- **Update Toolbox**: Update the Visual Studio Toolbox with the newly selected control versions to prevent accidental reference mismatches during drag-and-drop operations.
73+
- **Create Backup**: Create a backup of your current project before applying changes (highly recommended).
4174

4275
![installation-deployment-and-distribution-vsx-upgrade-project 003](images/installation-deployment-and-distribution-vsx-upgrade-project003.png)
4376

44-
Notes:
4577

46-
* The Telerik UI for WinForms distribution selection screen lists all the versions that can be detected automatically. These are versions, installed by using the Windows Installer MSI package, versions, downloaded by the Upgrade Wizard and versions, available in the GAC. Hotfixes, downloaded manually cannot be detected.
78+
### Step 5: Visual Studio Restart
4779

48-
* You can use the __GET LATEST__ button to access the Latest Version Acquirer and download the latest available version on our website.
80+
Visual Studio will restart automatically to complete the toolbox update. If automatic restart fails, manually restart Visual Studio to finish the upgrade process. This ensures all new controls are properly registered in the toolbox.
4981

50-
* The distribution, downloaded by the Upgrade Wizard contains only the "hotfix" files, e.g. the barebone files, needed for a project to run correctly. It does not contain the documentation or the Live Examples.
82+
## Important Notes and Considerations
5183

52-
* A Visual Studio restart will be required in order to update your toolbox. If the automatic restart fails, a restart should be initiated manually in order to complete the toolbox upgrade.
84+
#### Version Detection
85+
- The distribution selection screen automatically detects versions installed via Windows Installer MSI package
86+
- Versions downloaded by the Upgrade Wizard are detected
87+
- Versions available in the Global Assembly Cache (GAC) are detected
88+
- **Limitation**: Manually downloaded hotfixes cannot be automatically detected
5389

54-
# See Also
90+
#### Latest Version Access
91+
- Use the **GET LATEST** button to access the [Latest Version Acquirer]({%slug winforms/installation-deployment-and-distribution/visual-studio-extensions/latest-version-acquirer%})
92+
- This feature downloads the most recent version available from the Telerik website
93+
- Ensures you always have access to the newest features and bug fixes
5594

56-
* [Configure Project]({%slug winforms/installation-deployment-and-distribution/visual-studio-extensions/configure-project%})
95+
#### Distribution Content
5796

58-
* [Automatic Dependency Resolving]({%slug winforms/installation-deployment-and-distribution/visual-studio-extensions/automatic-dependency-resolving%})
97+
- Documentation and Live Examples are not included in wizard downloads
98+
- For complete installations with documentation, use the full [MSI installer]({%slug winforms/installation-deployment-and-distribution/installing-on-your-computer%})
5999

60-
* [Download New Version]({%slug winforms/installation-deployment-and-distribution/visual-studio-extensions/latest-version-acquirer%})
61100

62-
* [How to Upgrade a Telerik UI for WinForms Project]({%slug how-to-upgrade-a-project%})
101+
## See Also
102+
103+
* [Configure Project]({%slug winforms/installation-deployment-and-distribution/visual-studio-extensions/configure-project%})
104+
* [Automatic Dependency Resolving]({%slug winforms/installation-deployment-and-distribution/visual-studio-extensions/automatic-dependency-resolving%})
105+
* [Download New Version]({%slug winforms/installation-deployment-and-distribution/visual-studio-extensions/latest-version-acquirer%})
106+
* [How to Upgrade a Telerik UI for WinForms Project]({%slug winforms/installation-deployment-and-distribution/upgrade-project%})

0 commit comments

Comments
 (0)