Skip to content

Commit bf4245b

Browse files
UG updated
1 parent 076970d commit bf4245b

File tree

2 files changed

+44
-48
lines changed

2 files changed

+44
-48
lines changed

Extension/WPF-Extension/Template-Studio.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ Create the Syncfusion WPF project using the Visual Studio Project Template by fo
5353
![Syncfusion WPF project type selection wizard](Template-Studio-Images/WPF-4.png)
5454

5555
**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.
56-
57-
![Syncfusion WPF Predefined template wizard](Template-Studio-Images/WPFTemplate-6.png)
58-
56+
57+
![Syncfusion WPF Predefined template wizard](Template-Studio-Images/WPFTemplate-6.png)
58+
5959
**Project type:** Choose this option to select from 4 project types, including Navigation Pane, Blank, Menu Bar, and Ribbon .
6060

6161
6. Click **Next** or navigate to the **Pages** tab to access a list of available Syncfusion WPF components you can add to the application.
@@ -88,48 +88,46 @@ In the **Project Details** section, you can modify configurations and project ty
8888

8989
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.
9090

91-
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:
92-
93-
![ConfigureServices](Template-Studio-Images/DI-Setup.png)
91+
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:
92+
9493

94+
*I. Application Host:*
95+
- Registers **ApplicationHostService** to manage the app's lifecycle.
9596

96-
I. Application Host:
97-
- Registers `ApplicationHostService` to manage the app's lifecycle.
97+
*II. Specific Services:*
98+
- Registers **PageService** and **NavigationService** for handling page navigation.
9899

99-
II. Specific Services:
100-
- Registers `PageService` and `NavigationService` for handling page navigation.
101-
102-
III. Views and ViewModels:
100+
*III. Views and ViewModels:*
103101
- Registers ShellWindow and ShellViewModel for the main application window.
104-
- Registers `DataGridViewModel` and `DataGridPage` for the added component DataGrid UI.
102+
- Registers **DataGridViewModel** and **DataGridPage** for the added component DataGrid UI.
105103
- Registers MainViewModel and MainPage for the main page of the app.
106104

107-
IV. Configuration:
108-
- Binds the app's configuration settings to the `AppConfig` class using the settings from the configuration file.
105+
*IV. Configuration:*
106+
- Binds the app's configuration settings to the **AppConfig** class using the settings from the configuration file.
107+
108+
![ConfigureServices](Template-Studio-Images/DI-Setup.png)
109109

110-
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:
110+
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:
111111

112-
I. Initialization:
112+
*I. Initialization:*
113113
- The constructor of PageService takes a serviceProvider to access registered services.
114114

115-
II. Registering Pages:
116-
- Configure `<DataGridViewModel, DataGridPage>();` links the DataGridViewModel to the DataGridPage.
117-
- Configure `<MainViewModel, MainPage>();` links the MainViewModel to the MainPage.
115+
*II. Registering Pages:*
116+
- **Configure `<DataGridPage>()`:** Registers DataGridPage with the service provider.
117+
- **Configure `<MainPage>()`:** Registers MainPage with the service provider.
118118

119119
![PageServices](Template-Studio-Images/PageService.png)
120120

121-
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.
121+
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.
122122

123123
![Resources](Template-Studio-Images/Resources.png)
124124

125-
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.
126-
127-
> | .NET Version | Available From Version | Supported from Visual Studio |
128-
> |--------------|------------------------|-----------------------------|
129-
> | .NET 6.0 | v19.4.0.38 | Visual Studio 2022 |
130-
> | .NET 7.0 | v20.4.0.38 | Visual Studio 2022 |
131-
> | .NET 8.0 | v23.2.4 | Visual Studio 2022 |
132-
125+
126+
> | .NET Version | Available From Version | Supported from Visual Studio | Listed in "Select a framework version" when SDK is installed |
127+
> |--------------|------------------------|-----------------------------|--------------------------------------------------------------|
128+
> | .NET 6.0 | v19.4.0.38 | Visual Studio 2022 | Yes |
129+
> | .NET 7.0 | v20.4.0.38 | Visual Studio 2022 | Yes |
130+
> | .NET 8.0 | v23.2.4 | Visual Studio 2022 | Yes |
133131
134132
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.
135133

Extension/WindowsForms-Extension/Template-Studio.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -91,47 +91,45 @@ Create the Syncfusion WinForms project using the Visual Studio Project Template
9191
To find out which NuGet packages are needed for other WinForms controls, please refer to this [documentation link](https://help.syncfusion.com/windowsforms/control-dependencies) for detailed information on the required packages for each control.
9292

9393
10. When you create a WinForms project, the following Dependency Injection (DI) setup is added to the **Program.cs** file. This setup registers services, view models, and views with the DI container, ensuring proper functionality and service management within your application. Below **ConfigureServices** method in program.cs file establishes the DI setup in a WinForms project. It manages the application's services, view models, and views. Here's a detailed breakdown:
94-
95-
![DI-Setup](Template-Studio-Images/DI-Setup.png)
96-
97-
I. Application Host:
94+
95+
*I. Application Host:*
9896
- Registers **ApplicationHostService** to manage the app's lifecycle.
9997

100-
II. Specific Services:
98+
*II. Specific Services:*
10199
- Registers **PageService** and **NavigationService** for handling page navigation.
102100

103-
III. Views and ViewModels:
101+
*III. Views and ViewModels:*
104102
- **ShellWindow:** Registers the main application window.
105103
- **DataGridPage:** Registers the added component DataGrid on UI.
106104
- **MainPage:** Registers the main page of the application.
107105

108-
IV. Configuration:
106+
*IV. Configuration:*
109107
- Binds the app's configuration settings to the **AppConfig** class using the settings from the configuration file.
110108

109+
![DI-Setup](Template-Studio-Images/DI-Setup.png)
110+
111111
11. In a WinForms MVVM application, the **PageService.cs** class is responsible for managing navigation and page creation. It registers view models with their corresponding pages, allowing for seamless navigation within the application.
112112
Here's a simple explanation:
113-
114-
![PageService](Template-Studio-Images/PageService.png)
115-
116-
I. Initialization:
113+
114+
*I. Initialization:*
117115
- The constructor of PageService takes an IServiceProvider to access the registered services. This allows the service to resolve and instantiate the required view models and views.
118116

119-
II. Registering Pages:
117+
*II. Registering Pages:*
120118
- **Configure `<DataGridPage>()`:** Registers DataGridPage with the service provider.
121119
- **Configure `<MainPage>()`:** Registers MainPage with the service provider.
122120

121+
![PageService](Template-Studio-Images/PageService.png)
122+
123123
12. Some components require additional resource files, such as pdf and other necessary files, to function correctly. For example, if you add the **PDFViewer** and **Diagram** components to your WinForms project, the respective PDF and ico files will be added to the Resources folder in your project.
124124

125125
![Resources](Template-Studio-Images/Resources.png)
126126

127127

128-
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.
129-
130-
> | .NET Version | Available From Version | Supported from Visual Studio |
131-
> |--------------|------------------------|-----------------------------|
132-
> | .NET 6.0 | v19.4.0.38 | Visual Studio 2022 |
133-
> | .NET 7.0 | v20.4.0.38 | Visual Studio 2022 |
134-
> | .NET 8.0 | v23.2.4 | Visual Studio 2022 |
128+
> | .NET Version | Available From Version | Supported from Visual Studio | Listed in "Select a framework version" when SDK is installed |
129+
> |--------------|------------------------|-----------------------------|--------------------------------------------------------------|
130+
> | .NET 6.0 | v19.4.0.38 | Visual Studio 2022 | Yes |
131+
> | .NET 7.0 | v20.4.0.38 | Visual Studio 2022 | Yes |
132+
> | .NET 8.0 | v23.2.4 | Visual Studio 2022 | Yes |
135133
136134
13. If you install the trial setup or NuGet packages from nuget.org, you must register the Syncfusion license key to your application since Syncfusion introduced the licensing system from the 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) to generate and register the Syncfusion license key to your application. 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.
137135

0 commit comments

Comments
 (0)