diff --git a/Extension/WindowsForms-Extension/Item-Template-images/Add-item.png b/Extension/WindowsForms-Extension/Item-Template-images/Add-item.png new file mode 100644 index 00000000..07188017 Binary files /dev/null and b/Extension/WindowsForms-Extension/Item-Template-images/Add-item.png differ diff --git a/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item-3.png b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item-3.png new file mode 100644 index 00000000..e5b7cc02 Binary files /dev/null and b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item-3.png differ diff --git a/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item-details.png b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item-details.png new file mode 100644 index 00000000..28ceea0b Binary files /dev/null and b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item-details.png differ diff --git a/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item.png b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item.png new file mode 100644 index 00000000..7da1d60b Binary files /dev/null and b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-item.png differ diff --git a/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-ui.png b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-ui.png new file mode 100644 index 00000000..b943a259 Binary files /dev/null and b/Extension/WindowsForms-Extension/Item-Template-images/Add-syncfusion-ui.png differ diff --git a/Extension/WindowsForms-Extension/Project-Template-images/Syncfusion-Menu.png b/Extension/WindowsForms-Extension/Project-Template-images/Syncfusion-Menu.png new file mode 100644 index 00000000..28a978c7 Binary files /dev/null and b/Extension/WindowsForms-Extension/Project-Template-images/Syncfusion-Menu.png differ diff --git a/Extension/WindowsForms-Extension/Syncfusion-Item-Templates-for-Windows-Forms.md b/Extension/WindowsForms-Extension/Syncfusion-Item-Templates-for-Windows-Forms.md index e64ce3e7..cedb26b4 100644 --- a/Extension/WindowsForms-Extension/Syncfusion-Item-Templates-for-Windows-Forms.md +++ b/Extension/WindowsForms-Extension/Syncfusion-Item-Templates-for-Windows-Forms.md @@ -7,79 +7,51 @@ control: Syncfusion Extensions documentation: ug --- -# Item Template Extension +# Add Syncfusion Components to the WinForms Application -The Syncfusion Item Templates extensions provides support to add a predefined form for the Windows Forms applications. +Syncfusion supports Visual Studio Item Templates to add Syncfusion WinForms Components to a WinForms application with Syncfusion WinForms references. I> The Syncfusion Windows Forms item templates are available from v13.1.0.21. -## Using Syncfusion Item Template Gallery +The following steps will guide you to add the Syncfusion WinForms Components to your Visual Studio WinForms application. -Follow the given steps to add the Syncfusion item in Visual Studio. +> Check whether the **WinForms 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 Visual Studio 2017 or lower 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](https://help.syncfusion.com/windowsforms/visual-studio-integration/download-and-installation) help topic. -> Before use the Syncfusion WinForms Item Template, check whether the **WinForms Extensions - Syncfusion** installed or not in Visual Studio Extension Manager by clicking on the Tools -> Extensions and Updates -> Installed for Visual Studio 2017 or lower and for Visual Studio 2019 by clicking on the Extensions -> Manage Extensions -> Installed.If this extension not installed, please install the extension by follow the steps from the [download and installation](https://help.syncfusion.com/windowsforms/visual-studio-integration/vs2019-extensions/download-and-installation/) help topic. +## Add Components using Syncfusion Item Template -1. Open a new or existing **WinForms** application. -2. Right-click the WinForms Project from the Solution Explorer. Select the Add Syncfusion Item New Item… option. +1. Open a new or existing WinForms application. -  + **Option 1:** -3. Now, the Syncfusion Item Template Gallery window will be open. +2. From the **Solution Explorer, right-click** on the WinForms application. Choose **Add Syncfusion Item...**. -  - -4. Select the required assembly location, version, and Form from the Syncfusion Item Template Gallery. +  -  + **Option 2:** - **Assembly From:** Choose an assembly reference option such as GAC location, Essential Studio installed location, or NuGet packages, to specify where from the required Syncfusion assemblies are added to the project. +3. Click **Extensions > Essential Studio for WinForms > Add Syncfusion Item…** in Visual Studio. -  +  - N> Installed location and GAC option will be available only when the Syncfusion Essential WinForms setup has been installed. You can use NuGet option without installing the Syncfusion Essential Windows Forms setup. If you add the Syncfusion item files in .NET Core Windows Forms application, GAC option will not be listed in the Assembly From option. - **Version:** Choose the Essential Studio version to add the corresponding version assemblies to the project. +4. The Syncfusion WinForms Item Template wizard will be launched as follows. -  +  - N> Version option will be available only when you install the Syncfusion Essential Windows Forms setup and choose the assembly location as Installed Location or GAC. +5. Select the WinForms Components from the Component list within your WinForms Item Template. The features associated with the selected Component will be presented. From here, choose the specific features that are essential for your project. - **Template Gallery:** This part contains a set of Syncfusion Item Templates, and you can choose the Item Templates as required. When the Add button is clicked, the selected item template is added to the project. +6. Choose an assembly reference option such as GAC location, Essential Studio installed location, or NuGet packages to specify where the required Syncfusion assemblies are added to the project. -  + N> If the Syncfusion Essential WindowsForm build is installed, the Installed location and GAC options will be enabled. Without installing the Syncfusion Essential WindowsForm setup, use the NuGet option. The GAC option will not be available when using the Syncfusion WinForms Components in a .NET Core application. The Version drop-down lists the installed WinForms versions. -5. 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/license-key#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://blog.syncfusion.com/post/Whats-New-in-2018-Volume-2-Licensing-Changes-in-the-1620x-Version-of-Essential-Studio.aspx) post for understanding the licensing changes introduced in Essential Studio. +7. Click **Add**, and a pop-up will appear providing information about adding Component **files** and **NuGet/Assemblies** details. -  +  -## Using Visual Studio Add new Item +8. Click **OK** to incorporate the chosen Components into the WinForms application, along with the necessary Syncfusion assemblies. -Syncfusion Project Template can also be added from the Visual Studio Item Template. +  -1. To create a Syncfusion WinForms item template, follow either one of the options below: - - **Option 1** - Click **Syncfusion Menu** and choose **Essential Studio for WinForms > Add Office2010Form...** or any other Form in **Visual Studio**. +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/license-key#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://blog.syncfusion.com/post/Whats-New-in-2018-Volume-2-Licensing-Changes-in-the-1620x-Version-of-Essential-Studio.aspx) post for understanding the licensing changes introduced in Essential Studio. -  - - N> From Visual Studio 2019, Syncfusion menu is available under Extensions in Visual Studio menu. - - **Option 2** - Right-click the Windows Forms Project, select **Add > New Item**, and then navigate to **Visual C# Items or VB Items > Syncfusion > Windows**. Refer to the following screenshot for more information. - -  - -2. The Syncfusion Item Templates are available under the Syncfusion tab. It is available for both C# Items and VB Items. - -  - -3. Now the selected template is added to the project along with Syncfusion references. - -  - -  - -4. 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/license-key#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://blog.syncfusion.com/post/Whats-New-in-2018-Volume-2-Licensing-Changes-in-the-1620x-Version-of-Essential-Studio.aspx) post for understanding the licensing changes introduced in Essential Studio. - -  +  \ No newline at end of file diff --git a/Extension/WindowsForms-Extension/Syncfusion-Project-Templates-for-Windows-Forms.md b/Extension/WindowsForms-Extension/Syncfusion-Project-Templates-for-Windows-Forms.md index acb9b0dc..58dea592 100644 --- a/Extension/WindowsForms-Extension/Syncfusion-Project-Templates-for-Windows-Forms.md +++ b/Extension/WindowsForms-Extension/Syncfusion-Project-Templates-for-Windows-Forms.md @@ -7,32 +7,33 @@ control: Syncfusion Extensions documentation: ug --- - # Create WinForms application Syncfusion provides the Visual Studio Project Template for the Syncfusion WinForms platform to create the Syncfusion WinForms Application by adding the required Syncfusion assemblies and forms. I> The Syncfusion Windows Forms templates are available from v14.3.0.49. +>WinForms Project Template works seamlessly with Visual Studio 2015 or lower. For the Visual Studio 2017 or later versions, it is recommended to use a [WinForms Template Studio](https://help.syncfusion.com/windowsforms/visual-studio-integration/template-studio). + Use the following steps to create the Syncfusion Windows Forms project through the Visual Studio Project Template. -> Before use the Syncfusion WinForms Project Template, check whether the **WinForms Extensions - Syncfusion** installed or not in Visual Studio Extension Manager by clicking on the Tools -> Extensions and Updates -> Installed for Visual Studio 2017 or lower and for Visual Studio 2019 by clicking on the Extensions -> Manage Extensions -> Installed.If this extension not installed, please install the extension by follow the steps from the [download and installation](https://help.syncfusion.com/windowsforms/visual-studio-integration/vs2019-extensions/download-and-installation/) help topic. +> Check whether the **WinForms Extensions - Syncfusion** are installed or not in Visual Studio 2015 or lower by going to **Tools -> Extensions and Updates -> Installed**. If this extension not installed, please install the extension by follow the steps from the [download and installation](https://help.syncfusion.com/windowsforms/visual-studio-integration/download-and-installation) help topic. 1. To create a Syncfusion Windows Forms project, follow either one of the options below: **Option 1:** Click **Extensions >Syncfusion Menu** and choose **Essential Studio for WinForms > Create New Syncfusion Project…** in **Visual Studio**. -  +  - N> In Visual Studio 2017 or lower, you can see the Syncfusion menu directly in the Visual Studio menu. + N> In Visual Studio 2015 or lower, you can see the Syncfusion menu directly in the Visual Studio menu. **Option 2:** Choose **File -> New -> Project**. Opens a new dialog to create a new project. You can obtain the templates provided by Syncfusion for WinForms by filtering the project type with Syncfusion or by using the Syncfusion keyword in the search option  - In Visual Studio 2017 or lower, Select File > New > Project and navigate to Syncfusion > Windows > Syncfusion Windows Forms Application in Visual Studio. + In Visual Studio 2015 or lower, Select File > New > Project and navigate to Syncfusion > Windows > Syncfusion Windows Forms Application in Visual Studio.  @@ -44,13 +45,7 @@ Use the following steps to create the Syncfusion Windows Forms project through t  - > .NET 6.0 version is available from v19.4.0.38 and support from Visual Studio 2022. - - > .NET 7.0 version is available from v20.4.0.38 and support from Visual Studio 2022. - - > .NET 8.0 version is available from v23.2.4 and support from Visual Studio 2022. - - In Visual Studio 2017 or lower, Syncfusion Windows Forms Application project configuration wizard. + In Visual Studio 2015 or lower, Syncfusion Windows Forms Application project configuration wizard.  @@ -58,13 +53,11 @@ Use the following steps to create the Syncfusion Windows Forms project through t **Project Type:** Select the project type, either .NET Framework or .NET Core. - N> Project type selection option will be available only from Visual Studio 2019 and later in Syncfusion Windows Forms Project template configuration. The .NET 6.0, .NET 7.0, and .NET 8.0 option will be listed in project type only when the .NET 6.0, .NET 7.0, and .NET 8.0 setup has been installed. - **Language:** Select the language, either CSharp or VB. **Reference From:** Choose the assembly location such as NuGet, GAC Location, or Essential Studio installed location, from where the assembly is added to the project. - N> Installed location and GAC option will be available only when the Syncfusion Essential Windows Forms setup has been installed. You can use NuGet option without installing the Syncfusion Essential Windows Forms setup. Also, the GAC option will not be available when you choose .NET 6.0, .NET 7.0, and .NET 8.0 from project type option in Visual Studio 2022. + N> Installed location and GAC option will be available only when the Syncfusion Essential Windows Forms setup has been installed. You can use NuGet option without installing the Syncfusion Essential Windows Forms setup. **Installed ES Build Version:** Choose the build version to add the corresponding version assemblies to the project. @@ -72,7 +65,7 @@ Use the following steps to create the Syncfusion Windows Forms project through t **Select Window:** Choose the window as required for application. -4. After the Project Configuration Wizard is done, the Syncfusion WinForms project is created with required references and forms. +4. After choosing above project configuration options in the Project Configuration Wizard, click the create button then Syncfusion WinForms project is created with the necessary XAML files and required Syncfusion WinForms assemblies/NuGet packages.  diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/Syncfusion-Project-Template-Gallery-8.png b/Extension/WindowsForms-Extension/Template-Studio-Images/Syncfusion-Project-Template-Gallery-8.png new file mode 100644 index 00000000..0c68bf13 Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/Syncfusion-Project-Template-Gallery-8.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-1.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-1.png new file mode 100644 index 00000000..2bfbdc18 Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-1.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-15.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-15.png new file mode 100644 index 00000000..2a9f33a2 Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-15.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-2.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-2.png new file mode 100644 index 00000000..337c595c Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-2.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-3.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-3.png new file mode 100644 index 00000000..430e1dff Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-3.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-4.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-4.png new file mode 100644 index 00000000..ff7ea552 Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-4.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-5.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-5.png new file mode 100644 index 00000000..439761fc Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-5.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-6.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-6.png new file mode 100644 index 00000000..cd427c3a Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-6.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-7.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-7.png new file mode 100644 index 00000000..e8bedb60 Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-7.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-8.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-8.png new file mode 100644 index 00000000..1f38751b Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-8.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio-Images/WF-9.png b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-9.png new file mode 100644 index 00000000..e0ee1ec4 Binary files /dev/null and b/Extension/WindowsForms-Extension/Template-Studio-Images/WF-9.png differ diff --git a/Extension/WindowsForms-Extension/Template-Studio.md b/Extension/WindowsForms-Extension/Template-Studio.md new file mode 100644 index 00000000..14bb093d --- /dev/null +++ b/Extension/WindowsForms-Extension/Template-Studio.md @@ -0,0 +1,93 @@ +--- +layout: post +title: Template Studio | WinForms | Syncfusion +description: Syncfusion provides the Visual Studio Project Templates for the Syncfusion WinForms platform to create Syncfusion WinForms Application by addiing the required assemblies +platform: windowsforms +control: Syncfusion Extensions +documentation: ug +--- + + +# Syncfusion WinForms Template Studio + +The WinForms Template Studio by Syncfusion is a specialized tool for constructing applications with their WinForms components. This studio simplifies development by incorporating crucial Syncfusion components, handling required NuGet references, offering preset namespaces, and creating component render code. Acting as a wizard, it facilitates the creation of WinForms applications using Syncfusion components, streamlining the process for developers. + +I> The Syncfusion WinForms Template Studio is available from v24.1.41. + +N> WinForms Template Studio works seamlessly with Visual Studio 2017 or later. For the Visual Studio 2015 or lower versions, it is recommended to use a [WinForms project template](https://help.syncfusion.com/windowsforms/visual-studio-integration/create-project). + +Create the Syncfusion WinForms project using the Visual Studio Project Template by following the provided steps. + +> Check whether the **WinForms 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](https://help.syncfusion.com/windowsforms/visual-studio-integration/download-and-installation) help topic. + +1. Open the Visual Studio 2022. + +2. Select one of the following options to create the Syncfusion WinForms application + + **Option 1:** + Choose **Extension -> Syncfusion -> Essential Studio for WinForms -> Create New Syncfusion Project…** from the Visual Studio menu. + +  + + N> 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 WinForms. + +  + +3. Select the **Syncfusion WinForms Template Studio** and click Next. + +  + +4. When you launch the **Syncfusion WinForms Template Studio**, you will encounter a configuration wizard that allows you to set up your Syncfusion WinForms application. In this wizard, you can choose your desired .NET Core Version or .NET Framework Version, as well as select the Reference type. + +  + + N> The installed location and GAC options will be available only after the Syncfusion Essential WinForms setup has been installed. Use the NuGet option instead of installing the Syncfusion Essential WinForms 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. + +5. Navigate to the **Project type** tab and choose the Syncfusion WinForms application type you want—there are three types: Blank, MenuBar, and Tabbed Form. Click **Next** to proceed. + +  + +6. Click **Next** or navigate to the **Pages** tab to access a list of available Syncfusion WinForms components you can add to the application. + +  + + 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. + +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. + +  + +8. Click **Next** or navigate the **App Features** tab to select the desired application features. + +  + + N> The App Features option is not accessible for .NET Framework. + + **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. + +  + +9. Click **Create** to initiate the process. This action generates the Syncfusion WinForms application. The resulting Syncfusion WinForms app has the necessary Syncfusion NuGet packages, styles, and rendering code specific to the chosen Syncfusion component. + +  + +10. The Syncfusion WinForms application is configured with the latest versions of Syncfusion WinForms NuGet packages, complete with the appropriate namespaces and component render code for seamless integration of Syncfusion components. + + 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. + + > .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. + +11. 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. + +  \ No newline at end of file diff --git a/extension-toc.html b/extension-toc.html index 05c7c3c9..d3b098d7 100644 --- a/extension-toc.html +++ b/extension-toc.html @@ -225,6 +225,7 @@