diff --git a/wpf/Visual-Studio-Integration/Template-Studio-Images/DI-Setup.png b/wpf/Visual-Studio-Integration/Template-Studio-Images/DI-Setup.png new file mode 100644 index 000000000..4886fa7fd Binary files /dev/null and b/wpf/Visual-Studio-Integration/Template-Studio-Images/DI-Setup.png differ diff --git a/wpf/Visual-Studio-Integration/Template-Studio-Images/NuGetEntry.png b/wpf/Visual-Studio-Integration/Template-Studio-Images/NuGetEntry.png new file mode 100644 index 000000000..3fba75893 Binary files /dev/null and b/wpf/Visual-Studio-Integration/Template-Studio-Images/NuGetEntry.png differ diff --git a/wpf/Visual-Studio-Integration/Template-Studio-Images/PageService.png b/wpf/Visual-Studio-Integration/Template-Studio-Images/PageService.png new file mode 100644 index 000000000..09b3e2104 Binary files /dev/null and b/wpf/Visual-Studio-Integration/Template-Studio-Images/PageService.png differ diff --git a/wpf/Visual-Studio-Integration/Template-Studio-Images/Resources.png b/wpf/Visual-Studio-Integration/Template-Studio-Images/Resources.png new file mode 100644 index 000000000..b620ef72c Binary files /dev/null and b/wpf/Visual-Studio-Integration/Template-Studio-Images/Resources.png differ diff --git a/wpf/Visual-Studio-Integration/Template-Studio.md b/wpf/Visual-Studio-Integration/Template-Studio.md index d81d0b6ad..5f9fb574a 100644 --- a/wpf/Visual-Studio-Integration/Template-Studio.md +++ b/wpf/Visual-Studio-Integration/Template-Studio.md @@ -50,74 +50,86 @@ Create the Syncfusion WPF project using the Visual Studio Project Template by fo 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](Template-Studio-Images/WPF-4.png) + ![Syncfusion WPF project type selection wizard](Template-Studio-Images/WPF-4.png) **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](Template-Studio-Images/WPFTemplate-6.png) + ![Syncfusion WPF Predefined template wizard](Template-Studio-Images/WPFTemplate-6.png) **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. +6. 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](Template-Studio-Images/WPF-Page.png) - - To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details. - - N> 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 WPF pages selection wizard](Template-Studio-Images/WPF-6.png) - ![Syncfusion WinForms control features selection wizard](Template-Studio-Images/WPF-Features.png) + To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details. - 3. Click **Next** or navigate the **App Features** tab to select the desired application features. + N> The Control Features option is not accessible for Blank, Settings, and Master Detail Pages. - ![Syncfusion WinForms app features selection wizard](Template-Studio-Images/WPF-AppFeatures.png) +7. Click **Next** or navigate to the **Control Features** tab to view the listed features for the selected controls. From here, choose the features needed. - N> The App Features option is not accessible for .NET Framework. + ![Syncfusion WPF control features selection wizard](Template-Studio-Images/WPF-2.gif) - **Project Details Section** +8. Click **Next** or navigate the **App Features** tab to select the desired application features. - 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 WPF app features selection wizard](Template-Studio-Images/WPF-7.png) - ![Syncfusion WinForms project details selection and unselection wizard](Template-Studio-Images/ProjectDetails.png) +**Project Details Section** - 4. Click **Next** or navigate to the **Pages** tab to access a list of available Syncfusion WPF components you can add to the application. +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 pages selection wizard](Template-Studio-Images/WPF-6.png) +![Syncfusion WPF project details selection and unselection wizard](Template-Studio-Images/WPF-8.png) - To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details. +9. Click **Create** to generate the Syncfusion WPF application. Once you've created the project, the relevant Syncfusion NuGet packages will be automatically added to your project for the chosen components. For example, if you add an **DataGrid** control, the corresponding Syncfusion NuGet packages required for that control will be installed. - N> The Control Features option is not accessible for Blank, Settings, and Master Detail Pages. + ![Syncfusion WPF project created with readme](Template-Studio-Images/WPF-9.png) - 5. Click **Next** or navigate to the **Control Features** tab to view the listed features for the selected controls. From here, choose the features needed. + ![NuGetEntry](Template-Studio-Images/NuGetEntry.png) - ![Syncfusion WPF control features selection wizard](Template-Studio-Images/WPF-2.gif) + To find out which NuGet packages are needed for other WPF controls, please refer to this [documentation link](https://help.syncfusion.com/wpf/control-dependencies) for detailed information on the required NuGet packages for each control. - 6. Click **Next** or navigate the **App Features** tab to select the desired application features. +10. When you create a WPF project, the following Dependency Injection (DI) setup is added to the **App.xaml.cs** file. This setup registers services, view models, and views with the DI container, ensuring proper functionality for the selected components and service management within your application. Below, the **ConfigureServices** method in **App.xaml.cs** sets up Dependency Injection (DI) in a WPF project to manage the application's services, view models, and views. Here's a simple breakdown: + - ![Syncfusion WPF app features selection wizard](Template-Studio-Images/WPF-7.png) + *I. Application Host:* + - Registers **ApplicationHostService** to manage the app's lifecycle. - **Project Details Section** + *II. Specific Services:* + - Registers **PageService** and **NavigationService** for handling page navigation. - 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. + *III. Views and ViewModels:* + - Registers ShellWindow and ShellViewModel for the main application window. + - Registers **DataGridViewModel** and **DataGridPage** for the added component DataGrid UI. + - Registers MainViewModel and MainPage for the main page of the app. - ![Syncfusion WPF project details selection and unselection wizard](Template-Studio-Images/WPF-8.png) + *IV. Configuration:* + - Binds the app's configuration settings to the **AppConfig** class using the settings from the configuration file. - 7. 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. + ![ConfigureServices](Template-Studio-Images/DI-Setup.png) - ![Syncfusion WPF project created with readme](Template-Studio-Images/WPF-9.png) +11. In a WPF MVVM application, the **PageService.cs** class helps manage navigation and page creation. For instance, it facilitates registering and navigating to pages associated with specific view models. Here's a simple explanation: - 8. 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. + *I. Initialization:* + - The constructor of PageService takes a serviceProvider to access registered services. - N> 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. + *II. Registering Pages:* + - **Configure `()`:** Registers DataGridPage with the service provider. + - **Configure `()`:** Registers MainPage with the service provider. + + ![PageServices](Template-Studio-Images/PageService.png) - > .NET 6.0 version is available from v19.4.0.38 and it support from Visual Studio 2022. +12. Some components require additional resource files, such as images and other necessary files, to function correctly. For example, if you add the **PDFViewer** and **Carousel** component to your WPF project, the respective images and PDF files will be added to the Images and Assets folder in your project. - > .NET 7.0 version is available from v20.4.0.38 and it support from Visual Studio 2022. + ![Resources](Template-Studio-Images/Resources.png) - > .NET 8.0 version is available from v23.2.4 and it support from Visual Studio 2022. + + > The .NET 6.0, .NET 7.0, and .NET 8.0 options will be available in the Select a framework version dropdown only if the respective .NET SDKs are installed on your system. The table below outlines the .NET versions, the specific product versions from which they are available, and the Visual Studio versions that support them: + > | .NET Version | Available From Version | Supported from Visual Studio | + > |--------------|------------------------|-----------------------------| + > | .NET 6.0 | v19.4.0.38 | Visual Studio 2022 | + > | .NET 7.0 | v20.4.0.38 | Visual Studio 2022 | + > | .NET 8.0 | v23.2.4 | Visual Studio 2022 | - 9. 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](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio. +13. 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](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio. - ![Syncfusion license registration required information dialog in Syncfusion WPF project](Template-Studio-Images/Syncfusion-Project-Template-Gallery-9.png) \ No newline at end of file + ![Syncfusion license registration required information dialog in Syncfusion WPF project](Template-Studio-Images/Syncfusion-Project-Template-Gallery-9.png) \ No newline at end of file