Syncfusion WPF Template Studio

23 Apr 20247 minutes to read

The WPF Template Studio is a tool Syncfusion provides specifically for building applications using their WPF components. This studio streamlines the development process by including essential Syncfusion components, managing necessary NuGet references, providing predefined namespaces, and generating component render code. It acts as a template studio wizard, making it easier for developers to create WPF applications using Syncfusion components.

IMPORTANT

The Syncfusion WPF Template Studio is available from v23.1.36.

NOTE

WPF Template Studio works seamlessly with Visual Studio 2017 or later. For the Visual Studio 2015 or lower versions, it is recommended to use a WPF project template.

Create the Syncfusion WPF project using the Visual Studio Project Template by following the provided steps.

Check whether the WPF Extensions - Syncfusion are installed or not in Visual Studio Extension Manager by going to Extensions -> Manage Extensions -> Installed for Visual Studio 2019 or later, and for Visual Studio 2017 by going to Tools -> Extensions and Updates -> Installed. If this extension is not installed, please install the extension by following the steps from the download and installation help topic.

  1. Open the Visual Studio 2022.

  2. Select one of the following options to create the Syncfusion WPF application

    Option 1:
    Choose Extension -> Syncfusion -> Essential Studio for WPF -> Create New Syncfusion Project… from the Visual Studio menu.

    Choose Syncfusion WPF Application from Visual Studio new project dialog via Syncfusion menu

    NOTE

    In Visual Studio 2017, you can see the Syncfusion menu directly in the Visual Studio menu.

    Option 2:
    Choose File -> New -> Project from the menu. This launches a new dialogue for creating a new application. Filtering the application type by Syncfusion or typing Syncfusion as a keyword in the search option can help you find the Syncfusion templates for WPF.

    Choose Syncfusion WPF Application from Visual Studio new project dialog

  3. Select the Syncfusion WPF Template Studio and click Next.

    Choose Syncfusion WPF Application from Visual Studio new project dialog

  4. When you launch the Syncfusion WPF Template Studio, you will encounter a configuration wizard that allows you to set up your Syncfusion WPF application. Within this wizard, you will have the option to specify your preferred .NET Core Version or .NET Framework Version, select the desired language(CSharp or Visual Basic), and choose the reference type according to your requirements.

    Syncfusion WPF project configuration wizard

    NOTE

    The installed location and GAC options will be available only after the Syncfusion Essential WPF setup has been installed. Use the NuGet option instead of installing the Syncfusion Essential WPF setup. Also, the GAC option will not be available when you choose .NET 6.0, .NET 7.0, and .NET 8.0 from the project type option in Visual Studio.

    IMPORTANT

    Visual Basic Language support is available in WPF Template Studio starting from version 25.1.35.

  5. Click Next or navigate to the Type tab, then select the desired Syncfusion WPF application type. When selecting the type of template for your application, you have two options:

    Syncfusion WinForms project type selection wizard

    Predefined template: Choose this option to select from 5 predefined templates, including Calendar, Contact, Outlook, Docking Manager, Spreadsheet, Tile view, and Word. By choosing one of these templates, you can create your application without needing to follow any further steps.

    Syncfusion WinForms Predefined template wizard

    Project type: Choose this option to select from 4 project types, including Navigation Pane, Blank, Menu Bar, and Ribbon .

    1. Click Next or navigate to the Pages tab to access a list of available Syncfusion WPF components you can add to the application.

      Syncfusion WinForms pages selection wizard

      To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details.

      NOTE

      The Control Features option is not accessible for Blank Pages.

    2. Click Next or navigate to the Control Features tab to view the listed features for the selected controls. From here, choose the features needed.

      Syncfusion WinForms control features selection wizard

    3. Click Next or navigate the App Features tab to select the desired application features.

      Syncfusion WinForms app features selection wizard

      NOTE

      The App Features option is not accessible for .NET Framework.

    Project Details Section

    In the Project Details section, modify configurations and project types. Additionally, you can remove one or more controls from the selected list and remove the chosen application feature.

    Syncfusion WinForms project details selection and unselection wizard

    1. Click Next or navigate to the Pages tab to access a list of available Syncfusion WPF components you can add to the application.

    Syncfusion WPF pages selection wizard

    To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details.

    NOTE

    The Control Features option is not accessible for Blank, Settings, and Master Detail Pages.

    1. Click Next or navigate to the Control Features tab to view the listed features for the selected controls. From here, choose the features needed.

    Syncfusion WPF control features selection wizard

    1. Click Next or navigate the App Features tab to select the desired application features.

    Syncfusion WPF app features selection wizard

    Project Details Section

    In the Project Details section, you can modify configurations and project types. Additionally, you can remove one or more controls from the selected list and remove the chosen application feature.

    Syncfusion WPF project details selection and unselection wizard

    1. Click Create to initiate the process. This action generates the Syncfusion WPF application. The resulting Syncfusion WPF app has the necessary Syncfusion NuGet packages, styles, and rendering code specific to the chosen Syncfusion component.

    Syncfusion WPF project created with readme

    1. The Syncfusion WPF application is configured with the latest versions of Syncfusion WPF NuGet packages, complete with the appropriate namespaces and component render code for seamless integration of Syncfusion components.

    NOTE

    The .Net 6.0, .Net 7.0, and .Net 8.0 option will be listed in Select a framework version when only the .Net 6.0, .Net 7.0, and .Net 8.0 SDK setup has been installed.

    .NET 6.0 version is available from v19.4.0.38 and it support from Visual Studio 2022.

    .NET 7.0 version is available from v20.4.0.38 and it support from Visual Studio 2022.

    .NET 8.0 version is available from v23.2.4 and it support from Visual Studio 2022.

    1. Then, Syncfusion licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the help topic, which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this blog post for understanding the licensing changes introduced in Essential Studio.

    Syncfusion license registration required information dialog in Syncfusion WPF project