Troubleshoot the WPF project

17 Jul 20267 minutes to read

Troubleshoot the project with the Syncfusion® configuration and apply the fix, such as a wrong .NET Framework version of a Syncfusion® assembly in the project or a missing Syncfusion® dependent assembly of a referred assembly. The Syncfusion® Troubleshooter can perform the following tasks:

  • Report the configuration issues.
  • Apply the solution.

Report the Configuration issues

The steps below will assist you in using the Syncfusion® Troubleshooter in Visual Studio.

Check whether the WPF Extensions - Syncfusion® are installed in the Visual Studio Extension Manager. In Visual Studio 2017 or lower, go to Tools -> Extensions and Updates -> Installed. In Visual Studio 2019 and later, go to Extensions -> Manage Extensions -> Installed. If this extension is not installed, follow the steps from the download and installation help topic to install it.

  1. To open the Syncfusion® Troubleshooter wizard, follow one of the options below:

    Option 1
    Open an existing Syncfusion® WPF application, click the Syncfusion® Menu, and choose Essential Studio® for WPF > Troubleshoot… in Visual Studio.

    Syncfusion Troubleshooter via Syncfusion menu

    NOTE

    From Visual Studio 2019 and later, the Syncfusion® menu is available under Extensions in the Visual Studio menu.

    Syncfusion Troubleshooter via Syncfusion menu

    Option 2
    Right-click the project file in Solution Explorer and select Syncfusion® Troubleshooter… from the context menu.

    Syncfusion Troubleshooter add-in

  2. Analyze the project now. If any Syncfusion® control project configuration errors are discovered, they are reported in the Troubleshooter dialog. If there are no configuration issues with the project, the dialog box indicates that no modifications are required in the following areas:

    • Syncfusion® assembly references.
    • Syncfusion® NuGet Packages.
    • Syncfusion® Toolbox Configuration.

    No configuration changes required dialog box

IMPORTANT

The Syncfusion® Troubleshooter options are visible only for Syncfusion® projects, which means the project should contain Syncfusion® assemblies or Syncfusion® NuGet packages referred.

The Syncfusion® Troubleshooter handles the following project configuration issues:

  1. Assembly Reference Issues.

  2. NuGet-related Issues.

  3. Toolbox Configuration Issues.

Assembly Reference Issues

The Syncfusion® Troubleshooter handles the assembly reference issues listed below in Syncfusion® projects.

  1. Dependent assemblies are missing for referred assemblies from the project.

    For instance: If the “Syncfusion.Chart.WPF” assembly is referred in the project and “Syncfusion.Shared.WPF” (dependent of Syncfusion.Chart.Base) is not referred in the project, the Syncfusion® Troubleshooter will show that the dependent assembly is missing.

    Dependent assemblies missing issue shown in Troubleshooter wizard

  2. The Syncfusion® Troubleshooter compares all Syncfusion® assembly versions in the same project. If any Syncfusion® assembly version inconsistency is found, the Syncfusion® Troubleshooter will show that the Syncfusion® assemblies versions are mismatched.

    For instance: If the “Syncfusion®.Tools.WPF” assembly (v17.1.0.32) is referred in the project, but other Syncfusion® assemblies’ referred assembly version is v17.1.0.38, the Syncfusion® Troubleshooter will show that the Syncfusion® assembly version is mismatched.

    Assembly version mismatched issue shown in Troubleshooter wizard

  3. Framework version mismatching (Syncfusion® Assemblies) with the project’s .NET Framework version. Find the supported .NET Framework details for Syncfusion® assemblies in the following link:

    https://help.syncfusion.com/common/essential-studio/assembly-information#supported-framework-version-for-essential-studio-assemblies

    For instance: The .NET Framework of the application is v4.5 and the “Syncfusion.Tools.WPF” assembly (v17.1.0.38 & .NET Framework version 4.6) is referred in the same application. The Syncfusion® Troubleshooter will show that the Syncfusion® assembly .NET Framework version is incompatible with the project’s .NET Framework version.

    Target Framework version of application

    Framework mismatch issue shown in Troubleshooter wizard

NuGet Issues

The Syncfusion® Troubleshooter addresses the following NuGet package-related issues in Syncfusion® projects.

  1. If the application has Syncfusion® NuGet packages in multiple versions, the Syncfusion® Troubleshooter will show that the Syncfusion® NuGet package version is mismatched.

    For instance: Syncfusion® WPF platform packages are installed in multiple versions (v16.4.0.54 & v17.1.0.38), so the Syncfusion® Troubleshooter will show that the Syncfusion® package version is mismatched.

    Syncfusion NuGet Packages version mismatched issue shown in Troubleshooter wizard

  2. The installed Syncfusion® NuGet package’s Framework version differs from the project’s .NET Framework version.

    For instance: If the “Syncfusion.SfBulletGraph.WPF40” NuGet package version (v15.4.0.17 with 4.0 Framework) is installed in the project, but the project .NET Framework version is 4.5, the Syncfusion® Troubleshooter will show that the Syncfusion® package Framework version is mismatched.

    Syncfusion NuGet packages Framework version mismatched issue shown in Troubleshooter wizard

  3. A dependent NuGet package of the installed Syncfusion® NuGet packages is missing.

    For instance: If you install the Syncfusion.Chart.WPF NuGet package alone in the project, the Syncfusion® Troubleshooter will show that the Syncfusion.Chart.Base and other dependent NuGet packages are missing.

    Dependent NuGet package missing issue shown in Troubleshooter wizard

IMPORTANT

An internet connection is required to restore the missing dependent packages. If the internet is not available, the dependent packages will not be restored.

Toolbox Configuration Issues

In Syncfusion® projects, the Syncfusion® Troubleshooter addresses the following Toolbox Configuration issues.

  1. If the project .NET Framework version’s Syncfusion® Toolbox is not installed or configured, the Syncfusion® Troubleshooter will show that the Syncfusion® Toolbox .NET Framework version is mismatched.

    For instance: If the latest Syncfusion® assembly reference version is v17.1.0.38 but the Toolbox assemblies are configured to v17.1.0.32, the Syncfusion® Troubleshooter will show that the Syncfusion® Toolbox version is mismatched.

    Syncfusion Toolbox Framework version mismatched issue shown in Troubleshooter wizard

  2. If the configured version of the Syncfusion® Toolbox differs from the latest Syncfusion® assembly reference version or NuGet package version in the same project, the Syncfusion® Troubleshooter will indicate that the Syncfusion® Toolbox version is mismatched.

    For instance: If the latest Syncfusion® assembly reference version is v17.1.0.38 but the Toolbox assemblies are configured to v17.1.0.32, the Syncfusion® Troubleshooter will show that the Syncfusion® Toolbox version is mismatched.

    Syncfusion Toolbox version mismatched issue shown in Troubleshooter wizard

Apply the solution

  1. After loading the Syncfusion® Troubleshooter dialog, check the corresponding check box of the issue to be resolved. Then click the “Fix Issue(s)” button.

    Syncfusion Troubleshooter wizard with project configuration issues

  2. A dialog appears, asking you to take a backup of the project before performing the troubleshooting process. If you need to back up the project before troubleshooting, click the “Yes” button.

    Syncfusion Troubleshooter backup dialog

  3. Wait while the Syncfusion® Troubleshooter resolves the selected issues. After the troubleshooting process is complete, a status message appears in the Visual Studio status bar: “Troubleshooting process completed successfully”.

    Syncfusion Troubleshooter process success status message in visual studio status bar

  4. If you installed the trial setup or NuGet packages, the Syncfusion® license registration message box is displayed, since Syncfusion® introduced the licensing system in 2018 Volume 2 (v16.2.0.41) of the Essential Studio® release. Navigate to the help topic shown in the licensing message box to generate and register the Syncfusion® license key for your project. Refer to this blog post to understand the licensing changes introduced in Essential Studio®.

    Syncfusion license registration required information dialog in Syncfusion Troubleshooter