diff --git a/WindowsForms/AI-Coding-Assistant/mcp-server.md b/WindowsForms/AI-Coding-Assistant/mcp-server.md index f3adc189a..48f43941a 100644 --- a/WindowsForms/AI-Coding-Assistant/mcp-server.md +++ b/WindowsForms/AI-Coding-Assistant/mcp-server.md @@ -24,7 +24,7 @@ The [SyncfusionWinFormsAssistant](https://www.npmjs.com/package/@syncfusion/winf Before using [SyncfusionWinFormsAssistant](https://www.npmjs.com/package/@syncfusion/winforms-assistant), ensure you have: * Required [node](https://nodejs.org/en/) version >= 18 -* A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion® CodeStudio](https://www.syncfusion.com/code-studio/), etc.) +* A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion® Code Studio](https://www.syncfusion.com/code-studio/), etc.) * An active Syncfusion® license (any of the following): - [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense) - [Free Community License](https://www.syncfusion.com/products/communitylicense) @@ -66,7 +66,8 @@ Below are setup instructions for popular MCP clients: ### Syncfusion® Code Studio -* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the `Custom Servers` tab. +* Sign in to [Code Studio](https://www.syncfusion.com/code-studio/) with your Syncfusion account before installing the server. +* In Code Studio, open MCP Marketplace and navigate to the `Custom Servers` tab. * Enter the Server Name as `winforms-mcp`, choose Server Type as npm package, and set the NPM Package name to `@syncfusion/winforms-assistant`. * Add an environment variable as `Syncfusion_API_Key` and value as your [Syncfusion API key](https://syncfusion.com/account/api-key), then click **Install Server**. * Once installed, the server will appear in the User Installed Server list, and will be added to the **config.yaml** file. @@ -122,7 +123,7 @@ Below are setup instructions for popular MCP clients: } ``` -* After updating the mcp.json configuration, open the GitHub Copilot Chat window. Click the Ask arrow, then select Agent. +* After updating the mcp.json configuration, open the GitHub Copilot Chat window. Click the Ask arrow, then select **Agent**. * Select the [SyncfusionWinFormsAssistant](https://www.npmjs.com/package/@syncfusion/winforms-assistant) from the tools section. * For more details, refer to the official [Visual Studio documentation](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022). @@ -229,8 +230,7 @@ Product support is available through the following mediums. * [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours \| Unlimited tickets \| Holiday support * [Community forum](https://www.syncfusion.com/forums/windowsforms) * [Request feature or report bug](https://www.syncfusion.com/feedback/winforms) -* Live chat - +* Live Chat ## See also * [Syncfusion Windows Forms Documentation](https://help.syncfusion.com/windowsforms/overview) diff --git a/WindowsForms/AI-Coding-Assistant/overview.md b/WindowsForms/AI-Coding-Assistant/overview.md index 53ae2483b..724ea29e6 100644 --- a/WindowsForms/AI-Coding-Assistant/overview.md +++ b/WindowsForms/AI-Coding-Assistant/overview.md @@ -9,7 +9,7 @@ documentation: ug # Syncfusion® AI Coding Assistant Overview -The **Syncfusion® AI Coding Assistant** are designed to streamline your development workflow when building Windows Forms applications with Syncfusion® components. It uses contextual knowledge of the Syncfusion® component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. +The **Syncfusion® AI Coding Assistant** is designed to streamline your development workflow when building Windows Forms applications with Syncfusion® components. It uses contextual awareness based on Syncfusion's documentation to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. AI Coding Assistant: @@ -53,7 +53,7 @@ This ensures users can fully leverage Syncfusion® ## Recommendations * Session Management: Start new sessions when switching tasks to ensure prompt relevance and maintain content focus. -* Model Compatibility: For optimal performance, use the tools with advanced AI models such as GPT-5 or Claude Sonnet 4. +* Model Compatibility: For optimal performance, use the tools with a current advanced AI model available in your region, such as GPT-5 or Claude Sonnet 4. ## Privacy & Data Handling @@ -66,5 +66,5 @@ The Syncfusion® AI Coding Assistant is desi ## See also -* Add the **SyncfusionWinFormsAssistant MCP Server** to an MCP-enabled client. -* [Syncfusion® Windows Forms Documentation](https://help.syncfusion.com/windowsforms/overview). +* Add the [SyncfusionWinFormsAssistant MCP Server](https://help.syncfusion.com/windowsforms/ai-coding-assistant/mcp-server) to an MCP-enabled client. +* [Syncfusion® Windows Forms Documentation](https://help.syncfusion.com/windowsforms/overview). \ No newline at end of file diff --git a/WindowsForms/Add-Syncfusion-Controls.md b/WindowsForms/Add-Syncfusion-Controls.md index 82f95838a..00bd5246f 100644 --- a/WindowsForms/Add-Syncfusion-Controls.md +++ b/WindowsForms/Add-Syncfusion-Controls.md @@ -150,13 +150,13 @@ The following steps direct you to create the Syncfusion® Windows For ![Add-Syncfusion-Control_images5](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-5.png) -4. Once the Project Configuration Wizard is done, the Syncfusion® Windows Forms project is created with required references and forms. +4. Once the Project Configuration Wizard is done, the Syncfusion® Windows Forms project is created with the required references and forms. ![Add-Syncfusion-Control_images6](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-6.png) ![Add-Syncfusion-Control_images7](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-7.png) -5. Then, Syncfusion® licensing registration required message box will be shown as follow, if you are installed the trial setup or NuGet packages since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Please 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®. +5. Then, Syncfusion® licensing registration required message box will be shown as follow, if you have installed the trial setup or NuGet packages since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Please 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®. ![Add-Syncfusion-Control_images8](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-8.png) @@ -191,7 +191,7 @@ This is a combo box where you can choose the application’s platform. For now i #### Version -Syncfusion’s Installed Build Versions are listed for Syncfusion® Essential Studio® v13.1.0.21 and later, for the installed Windows Forms platform. +Syncfusion's Installed Build Versions are listed for Syncfusion® Essential Studio® v13.1.0.21 and later, for the installed Windows Forms platform. #### Template Gallery @@ -201,13 +201,13 @@ When Add button is clicked, then the selected item template is added to the proj ![Add-Syncfusion-Control_images5](Add-Syncfusion-Control_images\Syncfusion-Item-Template-Gallery-5.png) -5.Then, Syncfusion® licensing registration required message box will be shown as follow, if you are installed the trial setup or NuGet packages since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Please 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®. +5. Then, Syncfusion® licensing registration required message box will be shown as follow, if you have installed the trial setup or NuGet packages since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Please 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®. ![Add-Syncfusion-Control_images8](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-8.png) ### Using Visual Studio Add new Item -Syncfusion® Project Template can be also add from the Visual Studio Item Template. Right-click on the Windows Forms Project Add ->New Item. You can refer to the following screenshot for more information. +Syncfusion® Project Template can also be added from the Visual Studio Item Template. Right-click on the Windows Forms Project Add ->New Item. You can refer to the following screenshot for more information. ![Add-Syncfusion-Control_images1](Add-Syncfusion-Control_images\Syncfusion-Add-New-Item-1.png) @@ -221,6 +221,6 @@ Syncfusion® Project Template can be also add from the Visual Studio ![Add-Syncfusion-Control_images4](Add-Syncfusion-Control_images\Syncfusion-Add-New-Item-4.png) -3. Then, Syncfusion® licensing registration required message box will be shown as follow, if you are installed the trial setup or NuGet packages since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Please 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®. +3. Then, Syncfusion® licensing registration required message box will be shown as follow, if you have installed the trial setup or NuGet packages since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Please 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®. ![Add-Syncfusion-Control_images8](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-8.png) diff --git a/WindowsForms/Applying-patches/Applying-patches.md b/WindowsForms/Applying-patches/Applying-patches.md index 66bcf9734..33b8f6b93 100644 --- a/WindowsForms/Applying-patches/Applying-patches.md +++ b/WindowsForms/Applying-patches/Applying-patches.md @@ -11,63 +11,44 @@ documentation: ug Syncfusion provides patch installer for major version or service pack version, either to add new features or to fix issues. You have to install the patches in the order you have received. - ## Installing the Patch installer The steps below show how to install a patch. - -I> Before installing the patch, ensure that corresponding Essential Studio version platform has been installed in your machine. - - +I> Before installing the patch, ensure that the corresponding Essential Studio version is installed on your machine. 1. Double-click the Syncfusion Essential Studio patch installer. The Syncfusion Essential Studio Service Pack opens. ![Welcome Wizard](Patches_images/Installing-a-Patch-Setup_img2.png) - - - 2. Click Next. The Assembly Manager screen opens. ![Assembly Manager](Patches_images/Installing-a-Patch-Setup_img3.png) - - - 3. Select the Run Assembly Manager check box to install the assemblies in GAC. 4. Click Next. The Ready To Install screen opens. ![Ready To Install](Patches_images/Installing-a-Patch-Setup_img4.png) - - - 5. Click Install to continue installing. ![Installation Progress](Patches_images/Installing-a-Patch-Setup_img5.png) N> The patch is installed on your computer, and a dialog box appears when the installation is complete. - - ![Finish Wizard](Patches_images/Installing-a-Patch-Setup_img7.png) - 6. Click Finish. The new assemblies are placed in the Pre-Compiled Assemblies folder. These new assemblies can be referenced in your project. - ## Patch Assembly Version Format In the patch assembly, the **File Version** and **Product Version** will be different. Product Version will be the release version and File Version will be the increment of the release version's **revision** number. For each patch, the File Version will be a different one. You can differentiate between the build and patch assemblies by File Version. - + **File Version of the assembly shipped in build:** -![Patch Assembly](Patches_images/Installing-a-Patch-Setup_img8.png) +![File Version of a patched assembly](Patches_images/Installing-a-Patch-Setup_img8.png) **Product Version of the assembly shipped in patch:** -![Patch Assembly](Patches_images/Installing-a-Patch-Setup_img9.png) - - +![Product Version of a patched assembly](Patches_images/Installing-a-Patch-Setup_img9.png) \ No newline at end of file diff --git a/WindowsForms/Applying-patches/Patches_images/Installing-a-Patch-Setup_img9.png b/WindowsForms/Applying-patches/Patches_images/Installing-a-Patch-Setup_img9.png index 5dcb19e3a..092de5805 100644 Binary files a/WindowsForms/Applying-patches/Patches_images/Installing-a-Patch-Setup_img9.png and b/WindowsForms/Applying-patches/Patches_images/Installing-a-Patch-Setup_img9.png differ diff --git a/WindowsForms/Compatibility-with-the-NIST-MBARK-framework.md b/WindowsForms/Compatibility-with-the-NIST-MBARK-framework.md index f7b090c33..e2dca5227 100644 --- a/WindowsForms/Compatibility-with-the-NIST-MBARK-framework.md +++ b/WindowsForms/Compatibility-with-the-NIST-MBARK-framework.md @@ -1,7 +1,7 @@ --- layout: post title: Syncfusion Component Compatibility with the NIST MBARK Framework -description: Syncfusion components has the Compatibility with the NIST MBARK Framework. It helps to develop a large database of face, fingerprint and iris images. +description: Syncfusion components have compatibility with the NIST MBARK Framework. It helps to develop a large database of face, fingerprint, and iris images. platform: WindowsForms control: Introduction documentation: ug @@ -12,4 +12,4 @@ documentation: ug # Compatibility with the NIST MBARK Framework Syncfusion components are compatible with the [NIST's MBARK](https://www.nist.gov/services-resources/software/multimodal-biometric-application-resource-kit-mbark) Framework applications. `NIST MBARK` is public domain source code that may be leveraged to develop the next generation of biometric and personal identity verification applications. `NIST MBARK` application is based on .NET 3.5 SP1 Framework and latest .NET Framework versions. Incorporating the `MBARK` libraries can yield a variety of enhancements critical for the success of any real-world system. -`NIST's MBARK` is originally envisioned as a tool to develop a large database of face, fingerprint and iris images for performance testing of biometric systems. `MBARK` has evolved into a standardized, flexible middle ware package that will enable organizations to plug in sensors from different manufacturers. \ No newline at end of file +`NIST's MBARK` was originally envisioned as a tool to develop a large database of face, fingerprint, and iris images for performance testing of biometric systems. `MBARK` has evolved into a standardized, flexible package that enables organizations to plug in sensors from different manufacturers. \ No newline at end of file diff --git a/WindowsForms/Control-Dependencies.md b/WindowsForms/Control-Dependencies.md index 63149d5fe..e5932d59f 100644 --- a/WindowsForms/Control-Dependencies.md +++ b/WindowsForms/Control-Dependencies.md @@ -1150,7 +1150,7 @@ Syncfusion.GridExport.WinForms -## GridDataBoundGrid(Classic) +## GridDataBoundGrid (Classic) diff --git a/WindowsForms/Deployment.md b/WindowsForms/Deployment.md index 33baefc76..f76a7b67a 100644 --- a/WindowsForms/Deployment.md +++ b/WindowsForms/Deployment.md @@ -12,7 +12,7 @@ documentation: ug ## Copy Local -Copying assembly in local folder is supported by the Syncfusion assembly reference in the Solutions Explorer. It can be achieved by setting its Copy Local property of the reference to `True`. So, that the Syncfusion assemblies are copied to the Release/Bin, Debug/Bin folders. This deployment consists of copying the EXE, assembly and XML files to the client machines similar to that of manual copy. +Copying assemblies in the local folder is supported by the Syncfusion assembly reference in the Solutions Explorer. It can be achieved by setting its Copy Local property of the reference to `True`. So, that the Syncfusion assemblies are copied to the Release/Bin and Debug/Bin folders. This deployment consists of copying the EXE, the assembly, and the XML files to the client machines, similar to that of a manual copy. ![windows forms assembly installation and deployment](Installation-And-Deployment_images/Deployment_img1.jpg) @@ -23,7 +23,7 @@ Through Syncfusion installer, Syncfusion assemblies are installed in the GAC of ## Installed Location -The following table represents Assemblies/ Samples and its installed location +The following table summarizes the Assemblies/ Samples and their installed locations.
@@ -48,4 +48,4 @@ Samples
C:\Users\Public\Documents\Syncfusion\Windows\{{ site.releaseversion }}
-N> In above section, Latest Essential Studio version details has been provided. User can refer installed Essential Studio version instead of mentioned version. \ No newline at end of file +N> In the above section, the latest Essential Studio version details have been provided. The user can refer to the installed Essential Studio version instead of the mentioned version. \ No newline at end of file diff --git a/WindowsForms/Featured-Samples.md b/WindowsForms/Featured-Samples.md index c4aaf9468..7db9507f6 100644 --- a/WindowsForms/Featured-Samples.md +++ b/WindowsForms/Featured-Samples.md @@ -13,13 +13,13 @@ documentation: ug To explore the Syncfusion Windows Forms controls and components, open `Syncfusion Windows Forms Controls Panel` by searching it from start and open. -![Windows Formss Control Panel Search](featured-samples_images/winforms-control-panel-search.png) +![Windows Forms Control Panel Search](featured-samples_images/winforms-control-panel-search.png) -In another way, Open the control panel from the following installed location, +In another way, launch the control panel from the following installed location: C:\Program Files (x86)\Syncfusion\Essential Studio\{{ site.releaseversion }}\Infrastructure\Launcher\Syncfusion Windows Forms Control Panel.exe -N> In above section, Latest Essential Studio version details has been provided. User can refer installed Essential Studio version instead of mentioned version. +N> In the above section, the latest Essential Studio version details have been provided. The user can refer to the installed Essential Studio version instead of the mentioned version. ![Syncfusion Windows Forms Controls Panel](featured-samples_images/syncfusion-winforms-controls-panel.png) @@ -32,9 +32,9 @@ To explore the locally installed demos, click `Run Local Demos` which will open ## Offline samples -`Syncfusion Windows Forms Sample Browser` compile and launch the samples installed by Syncfusion installer. The samples are available in the following installed location where you can make changes and further exploration of controls. +`Syncfusion Windows Forms Sample Browser` compiles and launches the samples installed by the Syncfusion installer. The samples are available in the following installed location, where you can make changes and further explore the controls. -C:\Users\Public\Documents\Syncfusion\\Windows\{{ site.releaseversion }} +C:\Users\Public\Documents\Syncfusion\Windows\{{ site.releaseversion }} ## GitHub Demos diff --git a/WindowsForms/HighDPI-support.md b/WindowsForms/HighDPI-support.md index 250b2f69f..8e69061de 100644 --- a/WindowsForms/HighDPI-support.md +++ b/WindowsForms/HighDPI-support.md @@ -13,10 +13,10 @@ DPI stands for Dots Per Inch is the number of pixels or points rendered in one i ## DPI awareness -Desktop application fall into two categories based on the DPI awareness: +Desktop applications fall into two categories based on the DPI awareness: * Non-DPI aware application -* DPI aware application +* DPI-aware application ### Non-DPI aware application @@ -26,9 +26,9 @@ Refer to the following DataGrid sample demo screenshot that runs under 192 DPI w ![windows forms High DPI support with default scaling](HighDPI_images/HighDPI_img1.jpeg) -### DPI aware application +### DPI-aware application -The applications render themselves based on the actual DPI of a screen and provide a much better visual experience. The controls or applications needs manual implementation, such DPI awareness by retrieving the current monitor DPI value, scaling its content, applying different icon sets, and more. +The applications render themselves based on the actual DPI of a screen and provide a much better visual experience. The controls or applications need manual implementation, such DPI awareness by retrieving the current monitor DPI value, scaling its content, applying different icon sets, and more. The following DataGrid sample demo screenshot runs under 192 DPI, you can see the better quality of text and icon. @@ -102,12 +102,12 @@ The application or control created in 96 DPI value must be properly changed base ## DPI scaling -The DPI scaling mechanism calculates the scaling difference between the system that form has been designed on and the running system. This DPI scaling will only trigger if your application declares to be DPI aware. Otherwise, the system will be rendered in the default DPI (96 DPI) sandbox and bitmap scaling of the OS will be used. +The DPI scaling mechanism calculates the scaling difference between the system that form has been designed on and the running system. This DPI scaling will only trigger if your application is declared to be DPI aware. Otherwise, the system will be rendered in the default DPI (96 DPI) sandbox and bitmap scaling of the OS will be used. -You have probably noticed the following two properties: +The following two properties are involved in DPI scaling: -* [AutoScaleDimensions](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.containercontrol.autoscaledimensions?view=netframework-4.7.2#System_Windows_Forms_ContainerControl_AutoScaleDimensions): The Visual Studio designer will serialize the dimensions of the unit used for comparison either font or DPI. When running the form with different DPI settings, its dimensions will be obtained and compared against the serialized dimensions. The scaling factor is computed based on that, then it is applied. -* [AutoScaleMode](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.containercontrol.autoscalemode?view=netframework-4.7.2#System_Windows_Forms_ContainerControl_AutoScaleMode): Indicates the method to calculate the scale factor. Depending on it, the scaling mechanism will calculate the scale factor according to the dimensions of the system font or system DPI. If the AutoScaleMode is set to `None`, the automatic scaling will be disabled. When the scale factor is calculated, the framework calls the scale method of form which basically recalculates the size and the location of child controls on it. Their scale method is also called as properly scale. +* [AutoScaleDimensions](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.containercontrol.autoscaledimensions?view=netframework-4.7.2#System_Windows_Forms_ContainerControl_AutoScaleDimensions): The Visual Studio designer will serialize the dimensions of the unit used for comparison either font or DPI. When running the form with different DPI settings, its dimensions will be obtained and compared against the serialized dimensions. The scaling factor is then computed and applied. +* [AutoScaleMode](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.containercontrol.autoscalemode?view=netframework-4.7.2#System_Windows_Forms_ContainerControl_AutoScaleMode): Indicates the method to calculate the scale factor. Based on this, the scaling mechanism will calculate the scale factor according to the dimensions of the system font or system DPI. When the AutoScaleMode is set to `None`, the automatic scaling will be disabled. When the scale factor is calculated, the framework calls the scale method of form which basically recalculates the size and the location of child controls on it. Their scale method is also called to properly scale them. {% tabs %} {% highlight c# %} @@ -136,7 +136,6 @@ To turn your desktop application into DPI-aware and add `app.manifest` file, fol 4. When setting the `dpiAware` to true, the control will be drawn using the current DPI value. In this, the font size and image size will be automatically increased. The high DPI controls can be enabled by the following code snippet. -{% capture codesnippet1 %} {% tabs %} {% highlight xaml %} @@ -146,20 +145,18 @@ To turn your desktop application into DPI-aware and add `app.manifest` file, fol -{% endhighlight xaml %} +{% endhighlight %} {% endtabs %} -{% endcapture %} -{{ codesnippet1 | OrderList_Indent_Level_1 }} -5. Most of the Syncfusion controls support high DPI through manifest file. But, the following Syncfusion controls provides the high DPI support by adding both manifest file and enabling the [DpiAware](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.ScrollControl.html#Syncfusion_Windows_Forms_ScrollControl_DpiAware) property. +5. Most of the Syncfusion controls support high DPI through a manifest file. But the following Syncfusion control provides the high DPI support by adding both manifest file and enabling the [DpiAware](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.ScrollControl.html#Syncfusion_Windows_Forms_ScrollControl_DpiAware) property. * GridControl * GridGroupingControl * GridDataBoundGrid * GridListControl -{% capture codesnippet2 %} + {% tabs %} {% highlight c# %} @@ -192,8 +189,6 @@ gridListControl1.Grid.DpiAware = True {% endhighlight %} {% endtabs %} -{% endcapture %} -{{ codesnippet2 | OrderList_Indent_Level_1 }} ## Automatically change images based on DPI through ImageListAdv component @@ -213,7 +208,7 @@ The steps below illustrate the setting of image for a ButtonAdv using ImageListA 1. Drag and drop the ImageListAdv from the toolbox to the designer. -2. Add the required images to the [`Images`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.ImageListAdv.html#Syncfusion_Windows_Forms_Tools_ImageListAdv_Images) collection of the ImageListAdv. These images will act as default images that will be displayed at all scaling when no DPI images are set. +2. Add the required images to the [`Images`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.ImageListAdv.html#Syncfusion_Windows_Forms_Tools_ImageListAdv_Images) collection of the ImageListAdv. These images act as default images that will be displayed at all scaling when no DPI images are set. ![Images collection editor](HighDPI_images/ImageListAdv_Properties.png) @@ -241,7 +236,6 @@ The steps below illustrate the setting of image for a ButtonAdv using ImageListA 8. Now map the desired image from the [`Images`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.ImageListAdv.html#Syncfusion_Windows_Forms_Tools_ImageListAdv_Images) collection to the ButtonAdv control using its [`Image`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.ButtonAdv.html) property. -{% capture codesnippet3 %} {% tabs %} {% highlight c# %} @@ -255,8 +249,6 @@ buttonAdv1.Image = imageListAdv1.Images(0) {% endhighlight %} {% endtabs %} -{% endcapture %} -{{ codesnippet3 | OrderList_Indent_Level_1 }} 9. Run the application and the image for the ButtonAdv will be displayed as per the image set for different DPI scaling as shown below. @@ -275,6 +267,4 @@ buttonAdv1.Image = imageListAdv1.Images(0) #### 200 Scaling -![Adding images and index](HighDPI_images/DPI_200.png) - - +![Adding images and index](HighDPI_images/DPI_200.png) \ No newline at end of file diff --git a/WindowsForms/Installation.md b/WindowsForms/Installation.md index 36ef4739d..219800e9a 100644 --- a/WindowsForms/Installation.md +++ b/WindowsForms/Installation.md @@ -8,7 +8,7 @@ documentation: ug --- -# Installation in Windows Forms controls +# Installing Essential Studio for Windows Forms ## Manual Installation @@ -21,7 +21,7 @@ The following procedure illustrates how to manually install Essential Studio for 5. Click Next. Then, Select the Installation and Samples Folder window opens. 6. To install it in the displayed default location, click “Install”. 7. Select the “Run Dashboard” check box to launch the Dashboard after installing. -8. Click "Finish". Essential Studio is installed in system and the Syncfusion Essential Studio [Dashboard](http://help.syncfusion.com/ug/common/documents/dashboard.htm#) is launched automatically. +8. Click **Finish**. Essential Studio is installed on the system, and the Syncfusion Essential Studio [Dashboard](https://help.syncfusion.com/common/essential-studio/overview) is launched automatically. ## Command Line installation @@ -30,10 +30,10 @@ Follow the given steps to install through Command Line in Silent mode. 1. Double-click the “Syncfusion Essential Studio” Setup file. The Self-Extractor wizard opens and extracts the package automatically. 2. The SyncfusionEssentialStudio_({{ site.releaseversion }}).exe file is extracted into the Temp folder. -3. Run %temp%. The Temp folder opens. The SyncfusionEssentialStudio_({{ site.releaseversion }}).exe file is available in one of the folders. +3. Run `%temp%` to open the Temp folder. The SyncfusionEssentialStudio_({{ site.releaseversion }}).exe file is available in one of the folders. 4. Copy the SyncfusionEssentialStudio_({{ site.releaseversion }}).exe file in local drive. Example: D:\temp 5. Cancel the wizard. -6. Open Command Prompt in administrator mode and pass the following arguments for corresponding version. +6. Open Command Prompt in administrator mode and pass the following arguments for the corresponding version. {% tabs %} @@ -45,5 +45,5 @@ Follow the given steps to install through Command Line in Silent mode. {% endtabs %} -N> In above section, Latest Essential Studio version details has been provided. User can refer installed Essential Studio version instead of mentioned version. +N> In the above section, the latest Essential Studio version details have been provided. The user can refer to the installed Essential Studio version instead of the mentioned version. diff --git a/WindowsForms/Installation/Installation-errors.md b/WindowsForms/Installation/Installation-errors.md index 18abd2c43..27cfebef2 100644 --- a/WindowsForms/Installation/Installation-errors.md +++ b/WindowsForms/Installation/Installation-errors.md @@ -32,7 +32,7 @@ You are attempting to use a Trial unlock key to unlock the licensed installer. ### Suggested solution -Only a licensed unlock key can unlock a licensed installer. So, to unlock the Licensed installer, use the Licensed unlock key. To generate the licensed unlock key, refer to [this](http://syncfusion.com/kb/2326) article. +Only a licensed unlock key can unlock a licensed installer. So, to unlock the Licensed installer, use the Licensed unlock key. To generate the licensed unlock key, refer to [this](https://www.syncfusion.com/kb/2326) article. ## License has expired @@ -76,7 +76,7 @@ You can choose from the options listed below. The following are possible causes of this error: -* When your trial period expired +* When your trial period has expired * When you don't have a license or an active trial * You are not the license holder of your license * Your account administrator has not yet assigned you a license. @@ -86,9 +86,9 @@ The following are possible causes of this error: You can choose from the options listed below. 1. You can get a new license [here](https://www.syncfusion.com/sales/products). -2. Contact your account administrator. -3. Send an email to to request a license. -4. You can reach out to our sales team by emailing . +2. Contact your account administrator. +3. Send an email to to request a license. +4. You can reach out to our sales team by emailing . ## Unable to install because of another installation diff --git a/WindowsForms/Installation/install-nuget-packages.md b/WindowsForms/Installation/install-nuget-packages.md index 4dd80cde9..dd3130111 100644 --- a/WindowsForms/Installation/install-nuget-packages.md +++ b/WindowsForms/Installation/install-nuget-packages.md @@ -12,9 +12,9 @@ documentation: ug ## Overview -**NuGet** is a Package management system for Visual Studio. It makes it easy to add, update and remove external libraries in our application. Syncfusion publishing all WinForms NuGet packages in [nuget.org](https://www.nuget.org/packages?q=Tags%3A%22Winforms%22+syncfusion). The Syncfusion WinForms NuGet packages can be used without installing the Syncfusion Essential Studio setup. You can simply exploit the Syncfusion WinForms NuGet packages in WinForms application to develop with the Syncfusion WinForms components. +**NuGet** is a Package management system for Visual Studio. It makes it easy to add, update and remove external libraries in our application. Syncfusion publishes all WinForms NuGet packages in [nuget.org](https://www.nuget.org/packages?q=Tags%3A%22Winforms%22+syncfusion). The Syncfusion WinForms NuGet packages can be used without installing the Syncfusion Essential Studio setup. You can simply use the Syncfusion WinForms NuGet packages in a WinForms application to develop with the Syncfusion WinForms components. -> From v16.2.0.46 (2018 Volume 2 Service Pack 1) onwards, all the Syncfusion WinForms components are available as NuGet packages at nuget.org. +> From v16.2.0.46 (2018 Volume 2 Service Pack 1) onwards, all the Syncfusion WinForms components are available as NuGet packages at nuget.org. ## Installation using Package Manager UI @@ -34,11 +34,11 @@ The NuGet **Package Manager UI** allows you to search, install, uninstall, and u 3. When you select a package, the right side panel will provide more information about it. -4. By default, the package selected with latest version. You can choose the required version and click the **Install** button and accept the license terms. The package will be added to your WinForms application. +4. By default, the package is selected with the latest version. You can choose the required version and click the **Install** button and accept the license terms. The package will be added to your WinForms application. ![WinForms NuGet Packages Install](Platform_images/InstallNuGet.png) -5. At this point, your application has all the required Syncfusion assemblies, and you will be ready to start building high-performance, responsive app with [Syncfusion WinForms components](https://www.syncfusion.com/winforms-ui-controls). Also, you can refer to the [Syncfusion WinForms help document](https://help.syncfusion.com/windowsforms/overview) for development. +5. After installation, register your Syncfusion license key in the WinForms application as described in the [Licensing overview](https://help.syncfusion.com/windowsforms/licensing/overview). ## Installation using Dotnet (.NET) CLI @@ -47,6 +47,7 @@ The [dotnet Command Line Interface (CLI)](https://learn.microsoft.com/en-us/nuge Follow the below instructions to use the dotnet CLI command to install the Syncfusion WinForms NuGet packages. 1. Open a command prompt and navigate to the directory where your Syncfusion WinForms project file is located. + 2. To install a NuGet package, run the following command. ```dotnet add package ``` @@ -54,7 +55,7 @@ Follow the below instructions to use the dotnet CLI command to install the Syncf **For Example:** dotnet add package Syncfusion.Grid.Windows - > If you don’t provide a version flag, this command will be upgrading to the latest version by default. To specify a version, add the -v parameter: dotnet add package Syncfusion.Grid.Windows -v 19.2.0.57 + > If you don’t provide a version flag, this command will be upgrading to the latest version by default. To specify a version, add the -v parameter: dotnet add package Syncfusion.Grid.Windows -v 34.1.31 3. Examine the Syncfusion WinForms project file after the command has completed to ensure that the Syncfusion WinForms package was installed. To see the added reference, open the .csproj file. @@ -70,11 +71,11 @@ Follow the below instructions to use the dotnet CLI command to install the Syncf The **Package Manager Console** saves NuGet packages installation time since you don't have to search for the Syncfusion WinForms NuGet package which you want to install, and you can just type the installation command to install the appropriate Syncfusion WinForms NuGet package. Follow the instructions below to use the Package Manager Console to reference the Syncfusion WinForms component as NuGet packages in your WinForms application. -1. To show the Package Manager Console, open your WinForms web application in Visual Studio and navigate to **Tools -> NuGet Package Manager -> Package Manager Console**. +1. To show the Package Manager Console, open your WinForms application in Visual Studio and navigate to **Tools -> NuGet Package Manager -> Package Manager Console**. ![Package Manager Console ](Platform_images/console.png) -2. The **Package Manager Console** will be shown at the bottom of the screen. You can install the Syncfusion WinForms NuGet packages by enter the following NuGet installation commands. +2. The **Package Manager Console** will be shown at the bottom of the screen. You can install the Syncfusion WinForms NuGet packages by entering the following NuGet installation commands. ***Install specified Syncfusion WinForms NuGet package.*** @@ -90,13 +91,13 @@ The **Package Manager Console** saves NuGet packages installation time since you The below command will install the Syncfusion WinForms NuGet package in the given WinForms application. - ```Install-Package -ProjectName ``` + `Install-Package -ProjectName ` **For example:** Install-Package Syncfusion.Grid.Windows -ProjectName SyncfusionWinformsApp -3. By default, the package will be installed with latest version. You can give the required version with the -Version term like below to install the Syncfusion WinForms NuGet packages in the appropriate version. +3. By default, the package will be installed with the latest version. You can give the required version with the -Version term like below to install the Syncfusion WinForms NuGet packages in the appropriate version. - ```Install-Package Syncfusion.Grid.Windows -Version 19.2.0.59``` + ```Install-Package Syncfusion.Grid.Windows -Version 34.1.31``` ![Package Manager Console Output ](Platform_images/ConsoleInstallationOutput.png) diff --git a/WindowsForms/Installation/offline-installer/how-to-download.md b/WindowsForms/Installation/offline-installer/how-to-download.md index 1862193b7..e914bd302 100644 --- a/WindowsForms/Installation/offline-installer/how-to-download.md +++ b/WindowsForms/Installation/offline-installer/how-to-download.md @@ -38,7 +38,7 @@ Our 30-day trial can be downloaded in two ways. 7. Click the More Download Options (element 2 in the above screenshot) button to get the Essential Studio Windows Forms Offline trial installer which is available in EXE and ZIP format. - ![License and downloads of Syncfusion Essential Studio](images/start-trial-download-offline-installer.png) + ![Offline trial installer formats for Syncfusion Essential Studio](images/start-trial-download-offline-installer.png) ### Start Trials if using components through [NuGet.org](https://www.nuget.org/packages?q=syncfusion) @@ -50,7 +50,7 @@ You should initiate an evaluation if you have already obtained our components th ![Trial and downloads of Syncfusion Essential Studio](images/start-trial-download.png) -2. To access this page, you must sign up\log in with your Syncfusion account. +2. To access this page, you must sign up or log in with your Syncfusion account. 3. Begin your trial by selecting the Windows Forms product. N> If you've already used the trial products and they haven't expired, you won't be able to start the trial for the same product again. @@ -68,13 +68,13 @@ You should initiate an evaluation if you have already obtained our components th 2. You can view all the licenses (both active and expired) associated with your account. 3. Click the Download (element 1 in the screenshot below) button to download the respective product’s installer. 4. The most recent version of the installer will be downloaded from this page. -5. To download older version installers, go to [Downloads Older Versions](https://www.syncfusion.com/account/downloads/studio) (element 2 in the screenshot below). -6. You can download other platform\add-on installers by going to More Downloads Options (element 3 in the screenshot below). +5. To download older version installers, go to [Download Older Versions](https://www.syncfusion.com/account/downloads/studio) (element 2 in the screenshot below). +6. You can download other platform or add-on installers by going to More Downloads Options (element 3 in the screenshot below). ![License and downloads of Syncfusion Essential Studio](images/license-download.png) -7. For Windows OS, EXE and Zip formats are available for download. They are both Offline Installers. +7. For Windows OS, EXE and Zip formats are available for download. Both formats are offline installers. - ![License and downloads of Syncfusion Essential Studio](images/start-trial-download-offline-installer.png) + ![Offline installer formats for Syncfusion Essential Studio](images/start-trial-download-offline-installer.png) -You can also refer to the [**Offline installer**](https://help.syncfusion.com/windowsforms/installation/offline-installer/how-to-install) links for step-by-step installation guidelines. +You can also refer to the [**Offline installer**](https://help.syncfusion.com/windowsforms/installation/offline-installer/how-to-install) links for step-by-step installation guidelines. \ No newline at end of file diff --git a/WindowsForms/Installation/offline-installer/how-to-install.md b/WindowsForms/Installation/offline-installer/how-to-install.md index 106135e60..f10946124 100644 --- a/WindowsForms/Installation/offline-installer/how-to-install.md +++ b/WindowsForms/Installation/offline-installer/how-to-install.md @@ -13,9 +13,11 @@ documentation: ug ## Installing with UI -The steps below show how to install the Essential Studio Windows Forms installer. +Before starting the installation, close all Visual Studio instances and any running Syncfusion applications. -1. Open the Syncfusion Windows Forms offline installer file from downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. +The steps below show how to install the Essential Studio for Windows Forms installer. + +1. Open the Syncfusion Windows Forms offline installer file from the downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. ![Installer extraction wizard](images/Step-by-Step-Installation_img1.png) @@ -51,15 +53,17 @@ The steps below show how to install the Essential Studio Windows Forms installer 3. After reading the License Terms and Privacy Policy, check the **“I agree to the License Terms and Privacy Policy”** check box. Click the Next button. -4. Change the install and sample locations here. You can also change the Additional settings. Click Next\Install to install with the default settings. +4. Change the install and sample locations here. You can also change the additional settings. Click Next and then Install to install with the default settings. ![Advanced options](images/Step-by-Step-Installation_img4.png) **Additional Settings** + + The following additional settings can be configured for the installation: - * Select the **Install Demos** check box to install Syncfusion samples, or leave the check box unchecked, if you do not want to install Syncfusion samples - * Select the **Register Syncfusion Assemblies in GAC** check box to install the latest Syncfusion assemblies in GAC, or clear this check box when you do not want to install the latest assemblies in GAC. + * Select the **Install Demos** check box to install Syncfusion samples, or leave the check box unchecked if you do not want to install Syncfusion samples. + * Select the **Register Syncfusion Assemblies in GAC** check box to install the latest Syncfusion assemblies in the Global Assembly Cache (GAC), or clear this check box when you do not want to install the latest assemblies in the GAC. * Select the **Configure Syncfusion controls in Visual Studio** check box to configure the Syncfusion controls in the Visual Studio toolbox, or clear this check box when you do not want to configure the Syncfusion controls in the Visual Studio toolbox during installation. Note that you must also select the Register Syncfusion assemblies in GAC check box when you select this check box. * Select the **Configure Syncfusion Extensions controls in Visual Studio** checkbox to configure the Syncfusion Extensions in Visual Studio or clear this check box when you do not want to configure the Syncfusion Extensions in Visual Studio. * Check the **Create Desktop Shortcut** checkbox to add a desktop shortcut for Syncfusion Control Panel @@ -68,10 +72,10 @@ The steps below show how to install the Essential Studio Windows Forms installer -5. If any previous versions of the current product is installed, the Uninstall Previous Version(s) wizard will be opened. Select **Uninstall** checkbox to uninstall the previous versions and then click the Proceed button. +5. If any previous version of the current product is installed, the Uninstall Previous Version(s) wizard will be opened. Select **Uninstall** checkbox to uninstall the previous versions and then click the Proceed button. - ![Advanced options](images/Step-by-Step-Installation_img7.png) + ![Uninstall Previous Versions wizard](images/Step-by-Step-Installation_img7.png) N> From the 2021 Volume 1 release, Syncfusion has added the option to uninstall previous versions from 18.1 while installing the new version. @@ -95,14 +99,16 @@ The steps below show how to install the Essential Studio Windows Forms installer ![Completed wizard](images/Step-by-Step-Installation_img10.png) -7. After installing, click the **Launch Control Panel** link to open the Syncfusion Control Panel. +6. After installing, click the **Launch Control Panel** link to open the Syncfusion Control Panel. + +7. Click the Finish button. Your system has been installed with the Syncfusion Essential Studio for Windows Forms product. -8. Click the Finish button. Your system has been installed with the Syncfusion Essential Studio Windows Forms product. +After installation, you can register your Syncfusion license key in your application as described in the [Licensing overview](https://help.syncfusion.com/windowsforms/licensing/overview). ## Installing in silent mode -The Syncfusion Essential Studio Windows Forms Installer supports installation and uninstallation via the command line. +The Syncfusion Essential Studio for Windows Forms Installer supports installation and uninstallation via the command line. ### Command Line Installation @@ -111,17 +117,16 @@ To install through the Command Line in Silent mode, follow the steps below. 1. Run the Syncfusion Windows Forms installer by double-clicking it. The Installer Wizard automatically opens and extracts the package. 2. The file syncfusionessentialwindowsforms_(version).exe file will be extracted into the Temp directory. 3. Run %temp%. The Temp folder will be opened. The syncfusionessentialwindowsforms_(version).exe file will be located in one of the folders. -4. Copy the extracted syncfusionessentialwindowsforms_(version).exe file in local drive. +4. Copy the extracted syncfusionessentialwindowsforms_(version).exe file to a local drive. 5. Exit the Wizard. 6. Run Command Prompt in administrator mode and enter the following arguments. - - **Arguments:** “installer file path\SyncfusionEssentialStudio(product)_(version).exe” /Install silent /UNLOCKKEY:“(product unlock key)” [/log “{Log file path}”] [/InstallPath:{Location to install}] [/InstallSamples:{true/false}] [/InstallAssemblies:{true/false}] [/UninstallExistAssemblies:{true/false}] [/InstallToolbox:{true/false}] + **Arguments:** "installer file path\SyncfusionEssentialStudio(product)_(version).exe" /Install silent /UNLOCKKEY:"(product unlock key)" [/log "{Log file path}"] [/InstallPath:{Location to install}] [/InstallSamples:{true/false}] [/InstallAssemblies:{true/false}] [/UninstallExistAssemblies:{true/false}] [/InstallToolbox:{true/false}] N> [..] – Arguments inside the square brackets are optional. - **Example:** “D:\Temp\syncfusionessentialwindowsforms_x.x.x.x.exe” /Install silent /UNLOCK:“product unlock key” /log “C:\Temp\EssentialStudio_Platform.log” /InstallPath:C:\Syncfusion\x.x.x.x /InstallSamples:true /InstallAssemblies:true /UninstallExistAssemblies:true /InstallToolbox:true + **Example:** "D:\Temp\syncfusionessentialwindowsforms_x.x.x.x.exe" /Install silent /UNLOCKKEY:"product unlock key" /log "C:\Temp\EssentialStudio_Platform.log" /InstallPath:C:\Syncfusion\x.x.x.x /InstallSamples:true /InstallAssemblies:true /UninstallExistAssemblies:true /InstallToolbox:true 7. Essential Studio for Windows Forms is installed. @@ -131,7 +136,7 @@ To install through the Command Line in Silent mode, follow the steps below. ### Command Line Uninstallation -Syncfusion Essential Windows Forms can be uninstalled silently using the Command Line. +Syncfusion Essential Studio for Windows Forms can be uninstalled silently using the Command Line. 1. Run the Syncfusion Windows Forms installer by double-clicking it. The Installer Wizard automatically opens and extracts the package. 2. The file syncfusionessentialwindowsforms_(version).exe file will be extracted into the Temp directory. @@ -140,11 +145,7 @@ Syncfusion Essential Windows Forms can be uninstalled silently using the Command 5. Exit the Wizard. 6. Run Command Prompt in administrator mode and enter the following arguments. - **Arguments:** “Copied installer file path\syncfusionessentialwindowsforms_(version).exe” /uninstall silent  + **Arguments:** "Copied installer file path\syncfusionessentialwindowsforms_(version).exe" /uninstall silent - **Example:** “D:\Temp\syncfusionessentialwindowsforms_x.x.x.x.exe" /uninstall silent - - -7. Essential Studio for Windows Forms is uninstalled. - - + **Example:** "D:\Temp\syncfusionessentialwindowsforms_x.x.x.x.exe" /uninstall silent +7. Essential Studio for Windows Forms is uninstalled. \ No newline at end of file diff --git a/WindowsForms/Installation/web-installer/how-to-download.md b/WindowsForms/Installation/web-installer/how-to-download.md index 49b3431c5..fac6f2351 100644 --- a/WindowsForms/Installation/web-installer/how-to-download.md +++ b/WindowsForms/Installation/web-installer/how-to-download.md @@ -46,7 +46,7 @@ You should initiate an evaluation if you have already obtained our components th ![Trial and downloads of Syncfusion Essential Studio](images/start-trial-download.png) -2. To access this page, you must sign up\log in with your Syncfusion account. +2. To access this page, you must sign up or log in with your Syncfusion account. 3. Begin your trial by selecting the Windows Forms product. N> If you've already used the trial products and they haven't expired, you won't be able to start the trial for the same product again. @@ -64,8 +64,8 @@ You should initiate an evaluation if you have already obtained our components th 2. You can view all the licenses (both active and expired) associated with your account. 3. Click the Download (element 1 in the screenshot below) button to download the Windows Forms web installer. 4. The most recent version of the installer will be downloaded from this page. -5. To download older version installers, go to [Downloads Older Versions](https://www.syncfusion.com/account/downloads/studio) (element 2 in the screenshot below). -6. You can download other platform\add-on installers by going to More Downloads Options (element 3 in the screenshot below). +5. To download older version installers, go to [Download Older Versions](https://www.syncfusion.com/account/downloads/studio) (element 2 in the screenshot below). +6. You can download other platform or add-on installers by going to More Downloads Options (element 3 in the screenshot below). ![License and downloads of Syncfusion Essential Studio](images/license-download.png) @@ -75,6 +75,6 @@ You should initiate an evaluation if you have already obtained our components th 8. After downloading, the Syncfusion Windows Forms web installer can be unlocked using Syncfusion registered login credential. - N> For Syncfusion trial and licensed products, there is no separate web installer. Based on your account license, Syncfusion trial or licensed products will be installed via web installer. + N> For Syncfusion trial and licensed products, there is no separate web installer. Based on your account license,Syncfusion trial or licensed products will be installed via web installer. -You can also refer to the [**web installer**](https://help.syncfusion.com/windowsforms/installation/web-installer/how-to-install) links for step-by-step installation guidelines. +You can also refer to the [**web installer**](https://help.syncfusion.com/windowsforms/installation/web-installer/how-to-install) links for step-by-step installation guidelines. \ No newline at end of file diff --git a/WindowsForms/Installation/web-installer/how-to-install.md b/WindowsForms/Installation/web-installer/how-to-install.md index 6dcfd023a..d42ad296a 100644 --- a/WindowsForms/Installation/web-installer/how-to-install.md +++ b/WindowsForms/Installation/web-installer/how-to-install.md @@ -7,24 +7,25 @@ control: Installation and Deployment documentation: ug --- -# Installaing Syncfusion Windows Forms Web Installer - +# Installing Syncfusion Windows Forms Web Installer ## Overview -For the Essential Studio Windows Forms product, Syncfusion offers a Web Installer. This installer alleviates the burden of downloading a larger installer. You can simply download and run the online installer, which will be smaller in size and will download and install the Essential Studio products you have chosen. You can get the most recent version of Essential Studio Web Installer [here](https://www.syncfusion.com/downloads/latest-version). +For the Essential Studio for Windows Forms product, Syncfusion offers a Web Installer. This installer alleviates the burden of downloading a larger installer. You can simply download and run the online installer, which will be smaller in size and will download and install the Essential Studio products you have chosen. You can get the most recent version of Essential Studio Web Installer [here](https://www.syncfusion.com/downloads/latest-version). ## Installation -The steps below show how to install Essential Studio Windows Forms Web Installer. +Before starting the installation, close all Visual Studio instances and any running Syncfusion applications. Verify that your machine has an active internet connection, since the web installer downloads the product packages at install time. + +The steps below show how to install Essential Studio for Windows Forms Web Installer. -1. Open the Syncfusion Essential Studio Windows Forms Web Installer file from downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. +1. Open the Syncfusion Essential Studio for Windows Forms Web Installer file from the downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. ![Installer Extraction Wizard](images/Step-by-Step-Installation_img1.png) - N> The installer wizard extracts the syncfusionessentialwpfwebinstaller_{version}.exe dialog, which displays the package's unzip operation. + N> The installer wizard extracts the `syncfusionessentialwindowsformswebinstaller_{version}.exe` dialog, which displays the package's unzip operation. 2. The Syncfusion Windows Forms Web Installer's welcome wizard will be displayed. Click the Next button. @@ -66,7 +67,7 @@ The steps below show how to install Essential Studio Windows Forms Web Installer ![Confirmation for install/uninstall](images/Step-by-Step-Installation_img15.png) - N> By clicking the **Download Size and Installation** Size links, you can determine the approximate size of the download and installation + N> By clicking the **Download Size** and **Installation Size** links, you can determine the approximate size of the download and installation. 7. The Configuration Wizard will appear. You can change the Download, Install, and Demos locations from here. You can also change the Additional settings on a product-by-product basis. Click Next to install with the default settings. @@ -75,8 +76,8 @@ The steps below show how to install Essential Studio Windows Forms Web Installer **Additional settings** - * Select the **Install Demos** check box to install Syncfusion samples, or leave the check box unchecked, if you do not want to install Syncfusion samples - * Select the **Register Syncfusion Assemblies in GAC** check box to install the latest Syncfusion assemblies in GAC, or clear this check box when you do not want to install the latest assemblies in GAC. + * Select the **Install Demos** check box to install Syncfusion samples, or leave the check box unchecked if you do not want to install Syncfusion samples. + * Select the **Register Syncfusion Assemblies in GAC** check box to install the latest Syncfusion assemblies in the Global Assembly Cache (GAC), or clear this check box when you do not want to install the latest assemblies in the GAC. * Select the **Configure Syncfusion controls in Visual Studio** check box to configure the Syncfusion controls in the Visual Studio toolbox, or clear this check box when you do not want to configure the Syncfusion controls in the Visual Studio toolbox during installation. Note that you must also select the Register Syncfusion assemblies in GAC check box when you select this check box. * Select the **Configure Syncfusion Extensions controls in Visual Studio** checkbox to configure the Syncfusion Extensions in Visual Studio or clear this check box when you do not want to configure the Syncfusion Extensions in Visual Studio. * Check the **Create Desktop Shortcut** checkbox to add a desktop shortcut for Syncfusion Control Panel @@ -92,7 +93,7 @@ The steps below show how to install Essential Studio Windows Forms Web Installer I> The products you have chosen will be installed based on your Syncfusion License (Trial or Licensed). -10. The download and installation\uninstallation progress will be displayed as shown below. +10. The download and installation/uninstallation progress will be displayed as shown below. ![Download and Installation progress install](images/Step-by-Step-Installation_img10.png) @@ -106,8 +107,6 @@ The steps below show how to install Essential Studio Windows Forms Web Installer ![Control Panel](images/Step-by-Step-Installation_img19.png) - - ## Uninstallation Syncfusion Windows Forms installer can be uninstalled in two ways. @@ -115,7 +114,7 @@ Syncfusion Windows Forms installer can be uninstalled in two ways. * Uninstall the Windows Forms using the Syncfusion Windows Forms web installer * Uninstall the Windows Forms from Windows Control Panel -Follow either one of the option below to uninstall Syncfusion Essential Studio Windows Forms installer. +Follow either of the options below to uninstall Syncfusion Essential Studio for Windows Forms installer. **Option 1: Uninstall the Windows Forms using the Syncfusion Windows Forms web installer** @@ -130,9 +129,9 @@ You can uninstall all the installed products by selecting the **Syncfusion Essen ![Control Panel](images/Step-by-Step-Installation_img22.png) -N> If the **Syncfusion Essential Studio for Windows Forms {version}** entry is selected from the Windows control panel, the Syncfusion Essential Studio Windows Forms alone will be removed and the below default MSI uninstallation window will be displayed. +N> If the **Syncfusion Essential Studio for Windows Forms {version}** entry is selected from the Windows control panel, only the Syncfusion Essential Studio for Windows Forms will be removed and the Web Installer will launch so you can complete the uninstallation. Follow the steps below. -1. The Syncfusion Windows Forms Web Installer's welcome wizard will be displayed. Click the Next button +1. The Syncfusion Windows Forms Web Installer's welcome wizard will be displayed. Click the Next button. ![Welcome wizard uninstall](images/Step-by-Step-Installation_img2.png) @@ -160,7 +159,7 @@ N> If the **Syncfusion Essential Studio for Windows Forms {version}** entry is s ![Confirmation for install/uninstall](images/Step-by-Step-Installation_img15.png) - N> By clicking the **Download Size and Installation** Size links, you can determine the approximate size of the download and installation + N> By clicking the **Download Size** and **Installation Size** links, you can determine the approximate size of the download and installation. 6. The Configuration Wizard will appear. You can change the Download, Install, and Demos locations from here. You can also change the Additional settings on a product-by-product basis. Click Next to install with the default settings. @@ -178,7 +177,7 @@ N> If the **Syncfusion Essential Studio for Windows Forms {version}** entry is s ![Download and Installation progress install/uninstall](images/Step-by-Step-Installation_img17.png) -10. When the installation is finished, the **Summary** wizard will appear. Here you can see the list of products that have been successfully and unsuccessfully installed/uninstalled. To close the Summary wizard, click Finish. +10. When the installation is finished, the **Summary** wizard will appear. Here you can see the list of products that have been installed/uninstalled successfully or unsuccessfully. To close the Summary wizard, click Finish. ![Summary install/uninstall](images/Step-by-Step-Installation_img18.png) diff --git a/WindowsForms/Licensing/how-to-generate.md b/WindowsForms/Licensing/how-to-generate.md index ef859ba71..2c2f37565 100644 --- a/WindowsForms/Licensing/how-to-generate.md +++ b/WindowsForms/Licensing/how-to-generate.md @@ -8,36 +8,36 @@ documentation: ug --- -# Generate Syncfusion Windows Forms License key +# Generate Syncfusion Windows Forms License Key -License keys for Windows Forms can be generated from the [License & Downloads](https://syncfusion.com/account/downloads) or [Trail & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) section from your Syncfusion account. +License keys for Windows Forms can be generated from the [License & Downloads](https://www.syncfusion.com/account/downloads) or [Trial & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) section from your Syncfusion account. ![Get License Key](licensing-images/generate-license.png) I> * Syncfusion license keys are **version and platform specific**, refer to the [KB](https://support.syncfusion.com/kb/article/7898/how-to-generate-license-key-for-licensed-products) to generate the license key for the required version and platform. * Refer this [KB](https://support.syncfusion.com/kb/article/7865/which-version-syncfusion-license-key-should-i-use-in-my-application) to know about which version of the Syncfusion license key should be used in the application. -## Claim License key +## Claim License Key -Syncfusion License keys can also be generated from the **"Claim License Key"** page based on the trial or valid license associated with your Syncfusion account. +Syncfusion license keys can also be generated from the **"Claim License Key"** page based on the trial or valid license associated with your Syncfusion account. You can get the license key, based on license availability in your Syncfusion account. ### Active License -If you have a Syncfusion account associated with valid license, license key will be generated from claim license key page. +If you have a Syncfusion account associated with a valid license, the license key will be generated from the claim license key page. ![Active License](licensing-images/active-license.png) ### Active Trial -If you have a Syncfusion account associated with valid trial license, license key will be generated from claim license key page with expiry date. +If you have a Syncfusion account associated with a valid trial license, the license key will be generated from the claim license key page with an expiry date. ![Active Trial](licensing-images/active-trial.png) ### Expired License -If you have a Syncfusion account with an expired license, your license subscription must be renewed in order to obtain a valid license key for the latest Essential Studio version. Meanwhile, a temporary license key with a 5-day validity period will be generated. +If you have a Syncfusion account with an expired license, your license subscription must be renewed to obtain a valid license key for the latest Essential Studio version. Meanwhile, a temporary license key with a 5-day validity period will be generated. ![Expired License](licensing-images/expired-license.png) @@ -49,4 +49,4 @@ If the Syncfusion account is not associated with a trial, license, or expired tr ## See Also -* [How to Register Syncfusion License Key in Windows Forms Application?](https://github.com/syncfusion-content/windowsforms-docs/blob/master/WindowsForms/Licensing/how-to-register-in-an-application.md) \ No newline at end of file +* [How to Register Syncfusion License Key in Windows Forms Application?](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) \ No newline at end of file diff --git a/WindowsForms/Licensing/how-to-register-in-an-application.md b/WindowsForms/Licensing/how-to-register-in-an-application.md index 5965a152b..3762c5b6e 100644 --- a/WindowsForms/Licensing/how-to-register-in-an-application.md +++ b/WindowsForms/Licensing/how-to-register-in-an-application.md @@ -44,7 +44,7 @@ I> Syncfusion license keys can be validated during the Continuous Integration (C ### Windows Forms -You can register the licensing code in static void main method before calling **Application.Run()** method in C#. In Visual Basic, register the licensing code in **Application.designer.vb** file constructor. +You can register the licensing code in the `static void Main` method before calling the `Application.Run()` method in C#. In Visual Basic, register the licensing code in **Application.designer.vb** file constructor. N> * If the **Application.Designer.vb** file is not included by default in the project, it will be generated in the **My Project** folder in your VB project directory. * Ensure to register the license key at the beginning of the application's entry point class. diff --git a/WindowsForms/Licensing/licensing-errors.md b/WindowsForms/Licensing/licensing-errors.md index 5a5d472d6..b74d50711 100644 --- a/WindowsForms/Licensing/licensing-errors.md +++ b/WindowsForms/Licensing/licensing-errors.md @@ -9,77 +9,73 @@ documentation: ug # Syncfusion Licensing Errors -Licensing error popup is displayed with various messages under different circumstances. Here are some ways to resolve different issues. +A licensing error pop-up is displayed with various messages under different circumstances. Here are some ways to resolve different issues. ## Licensing errors -### License key not registered\Trial Expired +### License key not registered / Trial Expired -The following error message will be shown if a Syncfusion license key has not been registered in your application or if the trial key has expired after 30 days. +The following error message will be shown if a Syncfusion license key has not been registered in your application or if the trial key has expired after 30 days. -**Error message:** This application was built using a trial version of Syncfusion Essential Studio. You should include the valid license key to remove the license validation message permanently. +**Error message:** "This application was built using a trial version of Syncfusion Essential Studio. You should include the valid license key to remove the license validation message permanently." ![License key not registered](licensing-images/new-licensing-alert.png) -**Solution:** - -* Generate a valid license key from here [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform or License keys can also be generated from the Claim License Key page by clicking the **"Claim License"** button click from Syncfusion licensing warning message. Refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-generate#Claim-License-Key) for more details. +**Solution:** +* Generate a valid license key from [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform. License keys can also be generated from the Claim License Key page by clicking the **"Claim License"** button on the Syncfusion licensing warning message. Refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-generate#claim-license-key) for more details. * In your application, register the generated license key. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) for information on registering the license key. ### Invalid key -If the application is registered with an invalid key, another version of license key, or another platform's license key, the following error message will pop up when launching the application. +If the application is registered with an invalid key, another version of license key, or another platform's license key, the following error message will pop up when launching the application. -**Error Message:** The included Syncfusion license key is invalid. +**Error Message:** "The included Syncfusion license key is invalid." -![License key not registered](licensing-images/new-invalid-key.png) +![Invalid license key error](licensing-images/new-invalid-key.png) **Solution:** -* Generate a valid license key from here [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform or License keys can also be generated from the Claim License Key page by clicking the **"Claim License"** button click from Syncfusion licensing warning message. Refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-generate#Claim-License-Key) for more details.. - +* Generate a valid license key from [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform. License keys can also be generated from the Claim License Key page by clicking the **"Claim License"** button on the Syncfusion licensing warning message. Refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-generate#claim-license-key) for more details. * In your application, register the generated license key. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) for information on registering the license key. Refer to the license key [generation](https://help.syncfusion.com/windowsforms/licensing/how-to-generate) and [registration](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) topic. ## Licensing errors from version 16.2.0* to 20.3.0* -### License key not registered +### License key not registered -The following error message will be shown if a Syncfusion license key has not been registered in your application. +The following error message will be shown if a Syncfusion license key has not been registered in your application. -**Error message:** This application was built using a trial version of Syncfusion Essential Studio. Please include a valid license to permanently remove this license validation message. You can also obtain a free 30 day evaluation license to temporarily remove this message during the evaluation period. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#license-key-not-registered) for more information. +**Error message:** "This application was built using a trial version of Syncfusion Essential Studio. Please include a valid license to permanently remove this license validation message. You can also obtain a free 30 day evaluation license to temporarily remove this message during the evaluation period. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#license-key-not-registered) for more information." ![License key not registered](licensing-images/licensing-alert.png) **Solution:** -* Generate a valid license key from here [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform. - +* Generate a valid license key from [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform. * In your application, register the generated license key. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) for information on registering the license key. ### Invalid key If the application is registered with an invalid key, another version of license key, or another platform's license key, the following error message will pop up when launching the application. -**Error Message:** The included Syncfusion license is invalid. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#invalid-key) for more information. +**Error Message:** "The included Syncfusion license is invalid. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#invalid-key) for more information." ![License key not registered](licensing-images/invalid-key.png) **Solution:** -* Generate a valid license key from here [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform. - +* Generate a valid license key from [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform. * In your application, register the generated license key. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) for information on registering the license key. ### Trial Expired The following error message will be shown if the trial key has expired after 30 days. -**Error Message:** Your Syncfusion trial license has expired. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#trial-expired) for more information. +**Error Message:** "Your Syncfusion trial license has expired. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#trial-expired) for more information." -![License key not registered](licensing-images/trial-expired.png) +![Trial expired](licensing-images/trial-expired.png) **Solution:** Purchase from [here](https://www.syncfusion.com/sales/teamlicense) to get a valid Syncfusion license. @@ -89,7 +85,7 @@ If the application is registered with another platform's license key, the follow **Error Message:**The included Syncfusion license is invalid (Platform mismatch). Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#platform-mismatch) for more information. -![License key not registered](licensing-images/platform-mismatch.png) +![Platform mismatch](licensing-images/platform-mismatch.png) **Solution:** * Generate a valid license key from here [Licensed users](https://www.syncfusion.com/account/downloads) or [Trial users](https://www.syncfusion.com/account/manage-trials/downloads) for a specific version and platform. @@ -100,9 +96,9 @@ If the application is registered with another platform's license key, the follow If the application is registered with another version's license key, the following error message will pop up when launching the application. -**Error Message:**The included Syncfusion license ({Registered Version}) is invalid for version {Required version}. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#version-mismatch) for more information. +**Error Message:** "The included Syncfusion license ({Registered Version}) is invalid for version {Required version}. Please refer to this [help topic](https://help.syncfusion.com/windowsforms/licensing/licensing-errors#version-mismatch) for more information." -![License key not registered](licensing-images/version-mismatch.png) +![Version mismatch](licensing-images/version-mismatch.png) **Solution:** @@ -122,12 +118,4 @@ Set “CopyLocal” as True for Syncfusion.Licensing.dll along with all other Sy ![Output folder](licensing-images/OutputFolder.png) -Refer to this knowledge base articles to set [copy local](https://www.syncfusion.com/kb/4808/how-to-resolve-server-error-could-not-load-or-assembly-when-publishing-an-application) as true. - - - - - - - - +Refer to this knowledge base articles to set [copy local](https://www.syncfusion.com/kb/4808/how-to-resolve-server-error-could-not-load-or-assembly-when-publishing-an-application) as true. \ No newline at end of file diff --git a/WindowsForms/Licensing/licensing-faq/CI-license-validation.md b/WindowsForms/Licensing/licensing-faq/CI-license-validation.md index f74fad49a..f2df7112a 100644 --- a/WindowsForms/Licensing/licensing-faq/CI-license-validation.md +++ b/WindowsForms/Licensing/licensing-faq/CI-license-validation.md @@ -20,7 +20,7 @@ documentation: ug # Syncfusion License Key Validation in CI Services -Syncfusion license key validation in CI services ensures that Syncfusion Essential Studio components are properly licensed during CI processes. Validating the license key at the CI level can prevent licensing errors during deployment. Set up the continuous integration process to fail when the license key validation fails by surfacing a non-zero exit code from the validation script. +Syncfusion license key validation in CI services ensures that Syncfusion Essential Studio components are properly licensed during CI processes. Validating the license key at the CI level can prevent licensing errors during deployment. Set up the CI process to fail when the license key validation fails by surfacing a non-zero exit code from the validation script. The following sections show how to validate the Syncfusion license key in CI services. @@ -29,7 +29,7 @@ The following sections show how to validate the Syncfusion license key in CI ser * Open the `LicenseKeyValidation.ps1` PowerShell script in a text or code editor, as shown in the example below. {% tabs %} -{% highlight c# tabtitle="v34.1.29 and later" %} +{% highlight powershell tabtitle="v34.1.29 and later" %} # Replace the parameters with the desired platform, version, and actual license key. $result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"UIComponent" /version:"34.1.29" /licensekey:"Your License Key" @@ -37,7 +37,7 @@ $result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"UIComponen Write-Host $result {% endhighlight %} -{% highlight c# tabtitle="Before v34.1.29" %} +{% highlight powershell tabtitle="Before v34.1.29" %} # Replace the parameters with the desired platform, version, and actual license key. $result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"WindowsForms" /version:"26.2.4" /licensekey:"Your License Key" @@ -48,9 +48,9 @@ Write-Host $result * Update the parameters in the script: - **Platform:** Set /platform:"**UIComponent**" for v34.1.29 and later, or /platform:"**WindowsForms**" for earlier versions (use the relevant Syncfusion platform as needed). + **Platform:** Set `/platform:"UIComponent"` for v34.1.29 and later, or `/platform:"WindowsForms"` for earlier versions (use the relevant Syncfusion platform as needed). - **Version:** Change the value for `/version:` to the required version (e.g., `"26.2.4"`). + **Version:** Change the value for `/version:` to the required version (e.g., `"34.1.29"`). **License Key:** Replace the value for `/licensekey:` with your actual license key (e.g., `"YOUR LICENSE KEY"`). @@ -67,7 +67,7 @@ Write-Host $result The following example shows the syntax for Windows build agents. {% tabs %} -{% highlight c# tabtitle="YAML" %} +{% highlight yaml tabtitle="YAML" %} pool: vmImage: 'windows-latest' @@ -97,7 +97,7 @@ steps: The following example shows the syntax for validating the Syncfusion license key in GitHub Actions. {% tabs %} -{% highlight c# tabtitle="YAML" %} +{% highlight yaml tabtitle="YAML" %} steps: - name: Syncfusion License Validation shell: pwsh @@ -134,9 +134,9 @@ pipeline { ## Validate the License Key By Using the ValidateLicense() Method -* Register the license key properly by calling RegisterLicense("License Key") method with the license key. +* Register the license key properly by calling `RegisterLicense("License Key")` with the license key. -* Once the license key is registered, it can be validated by using the `ValidateLicense(Platform.WindowsForms)` method. This ensures that the license key is valid for the platform and version you are using. Refer to the following example. +* Once the license key is registered, it can be validated by using the `ValidateLicense(Platform.WindowsForms)` method (or `ValidateLicense(new[] { Platform.UIComponent })` for v34.1.29+). . This ensures that the license key is valid for the platform and version you are using. Refer to the following example. {% tabs %} {% highlight c# tabtitle="v34.1.29 and later" %} @@ -163,9 +163,8 @@ bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.WindowsForms); N> Use `Platform.UIComponent` for UI component license validation in v34.1.29 and later. `Platform.WindowsForms` is not supported from v34.1.29 onwards. -* If the ValidateLicense() method returns true, registered license key is valid and can proceed with deployment. - -* If the ValidateLicense() method returns false, there will be invalid license errors in deployment due to either an invalid license key or an incorrect assembly or package version that is referenced in the project. Please ensure that all the referenced Syncfusion assemblies or NuGet packages are all on the same version as the license key’s version before deployment. +* If the `ValidateLicense()` method returns `true`, the registered license key is valid and the build can proceed with deployment. +* If the `ValidateLicense()` method returns `false`, the deployment will report invalid license errors. This typically means the license key is invalid or the referenced assembly/package version does not match the license key's version. Please ensure that all the referenced Syncfusion assemblies or NuGet packages are on the same version as the license key's version before deployment. ## Validate the License Key By Using the Unit Test Project @@ -184,7 +183,7 @@ N> * Place the license key between double quotes (e.g., `RegisterLicense("YOUR L * Refer to the following example, which demonstrates how to register and validate the license key in the unit test project. {% tabs %} -{% highlight c# %} +{% highlight c# tabtitle="NUnit" %} public void TestSyncfusionWindowsFormsLicense() { var platform = Platform.WindowsForms; @@ -203,7 +202,7 @@ public void TestSyncfusionWindowsFormsLicense() {% endhighlight %} {% endtabs %} -* Once the unit test is executed, if the license key validation passes for the specified platform, the output similar to the following will be displayed in the Test Explorer window. +* After running the test, the output below appears in the Test Explorer window on success. ![License Validation Success Message](licensing-images/unit-test-success-message.png) @@ -213,7 +212,7 @@ public void TestSyncfusionWindowsFormsLicense() ### Troubleshooting -License validation fails due to either an invalid license key or an incorrect assembly or package version referenced in the project. In such cases: +License validation fails due to either an invalid license key or an incorrect assembly or package version referenced in the project. Perform the following steps: 1. Verify that you are using a valid license key for the platform. 2. Ensure that the assembly or package versions referenced in the project match the version of the license key. diff --git a/WindowsForms/Licensing/licensing-faq/Is-an-internet-connection-required-for-Syncfusion-Essential-Studio-license-validation.md b/WindowsForms/Licensing/licensing-faq/Is-an-internet-connection-required-for-Syncfusion-Essential-Studio-license-validation.md index cc5ed5c82..f6a5b8632 100644 --- a/WindowsForms/Licensing/licensing-faq/Is-an-internet-connection-required-for-Syncfusion-Essential-Studio-license-validation.md +++ b/WindowsForms/Licensing/licensing-faq/Is-an-internet-connection-required-for-Syncfusion-Essential-Studio-license-validation.md @@ -1,7 +1,7 @@ --- layout: post title: Licensing FAQ – Net need for ES license validation | Syncfusion -description: Learn here some information about whether syncfusion Essential Studio license validation needs internet conncetion. +description: Learn here some information about whether syncfusion Essential Studio license validation needs internet connection. platform: WindowsForms control: Essential Studio documentation: ug @@ -9,6 +9,6 @@ documentation: ug # Is an internet required for Essential Studio license validation? -* Syncfusion license validation is done offline during application execution and does not require internet access. +* Syncfusion license validation is performed offline during application execution and does not require internet access. * Apps registered with a Syncfusion license key can be deployed on any system that does not have an internet connection. \ No newline at end of file diff --git a/WindowsForms/Licensing/licensing-faq/how-to-upgrade-from-trial-version-after-purchasing-a-license.md b/WindowsForms/Licensing/licensing-faq/how-to-upgrade-from-trial-version-after-purchasing-a-license.md index b4263a870..35c07c9a6 100644 --- a/WindowsForms/Licensing/licensing-faq/how-to-upgrade-from-trial-version-after-purchasing-a-license.md +++ b/WindowsForms/Licensing/licensing-faq/how-to-upgrade-from-trial-version-after-purchasing-a-license.md @@ -7,11 +7,10 @@ control: Essential Studio documentation: ug --- -# How to upgrade from Trial version after purchasing a license? +# How to upgrade from Trial version after purchasing a license To upgrade from trial version, there are two possible solutions. -* Uninstall the trial version and install the fully licensed build from the [License & Downloads](https://www.syncfusion.com/account/downloads) section of our website. -* If you are using Syncfusion controls from [nuget.org](https://www.nuget.org/packages?q=syncfusion), replace the currently used trial license key with a paid license key that can be generated from the [License & Downloads](https://www.syncfusion.com/account/downloads) section of our website. Refer to [this](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) topic for more information regarding registering the license in the application. - -N> License registration is not required if you reference Syncfusion assemblies from Licensed installer. These licensing changes applicable to all evaluators who refers the Syncfusion assemblies from evaluation installer and those who use Syncfusion NuGet packages from [nuget.org](https://www.nuget.org/). \ No newline at end of file +1. Uninstall the trial version and install the fully licensed build from the [License & Downloads](https://www.syncfusion.com/account/downloads) section of our website. +2. If you are using Syncfusion controls from [nuget.org](https://www.nuget.org/packages?q=syncfusion), replace the currently used trial license key with a paid license key that can be generated from the [License & Downloads](https://www.syncfusion.com/account/downloads) section of our website. Refer to [this](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) topic for more information regarding registering the license in the application. +N> License registration is not required if you reference Syncfusion assemblies from a Licensed installer. These licensing changes apply to all evaluators who reference the Syncfusion assemblies from the evaluation installer and those who use Syncfusion NuGet packages from [nuget.org](https://www.nuget.org/). \ No newline at end of file diff --git a/WindowsForms/Licensing/licensing-faq/registering-syncfusion-account-for-nuget-org-user.md b/WindowsForms/Licensing/licensing-faq/registering-syncfusion-account-for-nuget-org-user.md index d79094ea2..1542ff434 100644 --- a/WindowsForms/Licensing/licensing-faq/registering-syncfusion-account-for-nuget-org-user.md +++ b/WindowsForms/Licensing/licensing-faq/registering-syncfusion-account-for-nuget-org-user.md @@ -7,11 +7,10 @@ control: Essential Studio documentation: ug --- -# Registering Syncfusion account for direct NuGet.org user +# Registering Syncfusion account for direct NuGet.org users -If you have directly obtained Syncfusion assemblies from [NuGet.org](https://www.nuget.org/) and do not have a Syncfusion account, follow the steps to obtain a free 30-day trial license key: +If you have directly obtained Syncfusion assemblies from [NuGet.org](https://www.nuget.org/) and do not have a Syncfusion account, follow these steps to obtain a free 30-day trial license key: * Register for a free Syncfusion account [here](https://www.syncfusion.com/account/register) * Go to the start trials [page](https://syncfusion.com/account/manage-trials/start-trials) and start a trial -* Finally proceed to the [Trial & Downloads section](https://www.syncfusion.com/account/manage-trials/downloads) to obtain the [license key](https://help.syncfusion.com/windowsforms/licensing/how-to-generate) - +* Finally proceed to the [Trial & Downloads section](https://www.syncfusion.com/account/manage-trials/downloads) to obtain the [license key](https://help.syncfusion.com/windowsforms/licensing/how-to-generate) \ No newline at end of file diff --git a/WindowsForms/Licensing/licensing-faq/where-can-i-get-a-license-key.md b/WindowsForms/Licensing/licensing-faq/where-can-i-get-a-license-key.md index 95df4f795..60781bc10 100644 --- a/WindowsForms/Licensing/licensing-faq/where-can-i-get-a-license-key.md +++ b/WindowsForms/Licensing/licensing-faq/where-can-i-get-a-license-key.md @@ -7,16 +7,11 @@ control: Essential Studio documentation: ug --- -# Where can I get a license key? +# Where can I get a license key License keys can be generated from the [License & Downloads](https://syncfusion.com/account/downloads) or [Trial & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) section of the Syncfusion website. -![Get License Key](licensing-images/generate-license.png) +![Generate the Windows Forms license key](licensing-images/generate-license.png) I> * Syncfusion license keys are **version and platform specific**, refer to the [KB](https://support.syncfusion.com/kb/article/7898/how-to-generate-license-key-for-licensed-products) to generate the license key for the required version and platform. -* Refer this [KB](https://support.syncfusion.com/kb/article/7865/which-version-syncfusion-license-key-should-i-use-in-my-application) to know about which version of the Syncfusion license key should be used in the application. - - - - - +* Refer this [KB](https://support.syncfusion.com/kb/article/7865/which-version-syncfusion-license-key-should-i-use-in-my-application) to know about which version of the Syncfusion license key should be used in the application. \ No newline at end of file diff --git a/WindowsForms/Licensing/overview.md b/WindowsForms/Licensing/overview.md index fa78b8426..732bb18e2 100644 --- a/WindowsForms/Licensing/overview.md +++ b/WindowsForms/Licensing/overview.md @@ -44,3 +44,4 @@ This application was built using a trial version of Syncfusion Essential Studio. * [How to Generate Syncfusion WindowsForms License Key?](https://help.syncfusion.com/windowsforms/licensing/how-to-generate) * [How to Register Syncfusion License Key in WindowsForms Application?](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) +* For CI validation, see the [CI License Validation](https://help.syncfusion.com/windowsforms/licensing/licensing-faq/ci-license-validation) topic. \ No newline at end of file diff --git a/WindowsForms/Localization.md b/WindowsForms/Localization.md index 777c060a2..1ac04a65b 100644 --- a/WindowsForms/Localization.md +++ b/WindowsForms/Localization.md @@ -1,7 +1,7 @@ --- layout: post title: Localization in Windows Forms | Syncfusion® -description: Learn about Localization support in Syncfusion® WF UI Contorls using .RESX files and also explains editing default strings of WF controls. +description: Learn about Localization support in Syncfusion® WF UI Controls using .RESX files and also explains editing default strings of WF controls. platform: windowsforms control: Localization documentation: ug @@ -10,9 +10,9 @@ documentation: ug # Localization of Syncfusion® WF Controls -Localization is the process of making application multilingual by formatting the content according to the cultures. This involves configuring the application for a specific language. Culture is the combination of language and location. For example, `en-US` is the culture for English spoken in United States; `en-GB` is the culture for English spoken in Great Britain. +Localization is the process of making an application multilingual by formatting the content according to the cultures. This involves configuring the application for a specific language. Culture is the combination of language and location. For example, `en-US` is the culture for English spoken in the United States; `en-GB` is the culture for English spoken in Great Britain. -Syncfusion® components support localization and have their own neutral resources. These resources can be localized as per the customer requirement and they can be localized in three ways are, +Syncfusion® components support localization and have their own neutral resources. These resources can be localized as per the customer requirement in three ways, * Using [ILocalizationProvider](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.ILocalizationProvider.html) * Using Satellite Assemblies @@ -217,7 +217,7 @@ N> In above section, Latest Essential Studio® version details has be 2. Inside the NeutralResources folder, there are four resource files corresponding to the Tools package. These resources contain the string representations for the English culture, both default and neutral. -3. Microsoft Visual Studio.NET ships with a tool called Resource Editor (ResEditor) that can be used to localize the string resources. It provides a graphical interface that allows to construct resource files containing bitmaps, icons, and strings. +3. Microsoft Visual Studio.NET ships with a tool called Resource Editor (ResEditor) that can be used to localize the string resources. It provides a graphical interface that allows you to construct resource files containing bitmaps, icons, and strings. 4. Compile the source code by using the build.bat command in the Microsoft Visual Studio 2008 Command prompt. The following figure shows how the Resource Editor looks when it first opens. @@ -237,7 +237,7 @@ N> In above section, Latest Essential Studio® version details has be 9. Click File -> Save As and select the culture to be localized. In this case, German-Germany. Now, a new resource file with the name `Syncfusion.Windows.Forms.Tools.XPMenus.CustomizationPanel.de-DE.resources` is added to the source path. -10. Repeat the process for other resources and save it. Now, in the Visual Studio.NET Command Prompt, enter the following command and press Enter. Make sure that sf.public snk file is available from the Localization folder. +10. Repeat the process for other resources and save it. Now, in the Visual Studio.NET Command Prompt, enter the following command and press Enter. Make sure that the sf.publicsnk file is available from the Localization folder. For **Tools.Windows** @@ -286,7 +286,7 @@ sn –Vr Syncfusion.Tools.Windows.resources.dll {% endcapture %} {{ codesnippet7 | OrderList_Indent_Level_1 }} -13. Drop this assembly into an appropriate sub-directory under .EXE’s directory (bin\Debug), based on the naming conventions enforced in .NET. and it can placed in the `de-DE` sub-directory when this assembly contains resources from the German (Germany) culture. +13. Drop this assembly into an appropriate subdirectory under the .EXE’s directory (bin\Debug), based on the naming conventions enforced in .NET, and it can be placed in the `de-DE` subdirectory when this assembly contains resources from the German (Germany) culture. 14. Finally, application can refer German resources during runtime by using the following code example. To change the UI culture of the current thread, add this code in the Forms constructor before the `InitializeComponent()`. @@ -309,7 +309,7 @@ Thread.CurrentThread.CurrentUICulture = New System.Globalization.CultureInfo("de {% endcapture %} {{ codesnippet8 | OrderList_Indent_Level_1 }} -15. Now, Run the application that contains the Syncfusion® Toolbar and Menu controls and open the Customization dialog. The dialog appears in German as shown in the following figure: +15. Now, run the application that contains the Syncfusion® Toolbar and Menu controls and open the Customization dialog. The dialog appears in German as shown in the following figure: ![Windows Form Localization Customization dialog German culture](Localization_images/WindowsForm-Localization-CustomizationDialog.png) diff --git a/WindowsForms/Overview.md b/WindowsForms/Overview.md index e34d0343e..6f1a97586 100644 --- a/WindowsForms/Overview.md +++ b/WindowsForms/Overview.md @@ -11,13 +11,13 @@ documentation: ug # Welcome to Syncfusion® Essential® Windows Forms -Syncfusion® Essential Studio® for Windows Forms is a comprehensive collection of over 100+ Essential® Windows Forms controls like Grids, Charts, Diagram, Scheduler and Tools for building powerful line-of-business applications faster. Syncfusion® Windows Forms controls provides unparalleled performance, stunning built-in themes, touch-friendly UI, localization and seamless integration with Visual Studio. +Syncfusion® Essential Studio® for Windows Forms is a comprehensive collection of over 100 Essential® Windows Forms controls like Grids, Charts, Diagram, Scheduler, and Tools for building powerful line-of-business applications faster. Syncfusion® Windows Forms controls provide unparalleled performance, stunning built-in themes, touch-friendly UI, localization and seamless integration with Visual Studio. ## How to best read this user guide -* The best way to get started is to read the “Getting Started” section of the documentation for the component you need. The “Getting Started” guide gives information needed before writing the code. All the other information can be referred when required. -* Now, that you are familiar with the basics of using the component, the next step is to start integrating the component into your application. A good starting point is to refer to the code examples in the sample browser that contains hundreds of code samples. It is very likely that you can find a code example that resembles your intended usage scenario. -* After you have integrated the component into your application by using one of the sample code examples as a starting point, that you would need additional information on specific features and API. The best option is to search the specific topic by using the search box available at the top of the user guide. +* The best way to get started is to read the “Getting Started” section of the documentation for the component you need. The “Getting Started” guide gives information needed before writing the code. All the other information can be referred to when required. +* Now that you are familiar with the basics of using the component, the next step is to start integrating the component into your application. A good starting point is to refer to the code examples in the sample browser that contains hundreds of code samples. It is very likely that you can find a code example that resembles your intended usage scenario. +* After you have integrated the component into your application by using one of the sample code examples as a starting point, you may need additional information on specific features and API. The best option is to search the specific topic by using the search box available at the top of the user guide. * Another valuable resource is the API reference that provides detailed information on the object hierarchy as well as the settings available on every object. ## Controls list @@ -246,7 +246,7 @@ background-color:transparent!important; Metro Form - MISCELLEANEOUS + MISCELLANEOUS BannerTextProvider @@ -345,10 +345,10 @@ Refer [licensing](https://help.syncfusion.com/common/essential-studio/licensing/ The [Knowledge Base](https://support.syncfusion.com/kb/desktop/category/82) section contains responses to most of the common questions that other customers have asked in the past, so this would be a good place to search for topics that are not covered in the User Guide. -Similar to the [Knowledge Base](https://support.syncfusion.com/kb/desktop/category/82), the [Forum](https://www.syncfusion.com/forums/windowsforms) section also contains responses to questions that other customers has asked us in the past. +Similar to the [Knowledge Base](https://support.syncfusion.com/kb/desktop/category/82), the [Forum](https://www.syncfusion.com/forums/windowsforms) section also contains responses to questions that other customers have asked us in the past. ## Support and feedback If you are unable to find the information that you are looking for in the self-help resources mentioned above then you contact us by creating a [support ticket](https://internalsupport.bolddesk.com/agent/tickets/create). -Don’t see what you need? Please request it in our [feedback portal](https://www.syncfusion.com/feedback/winforms). +Don’t see what you need? Please request it in our [Feedback portal](https://www.syncfusion.com/feedback/winforms). diff --git a/WindowsForms/Section508Compliance/VPAT.md b/WindowsForms/Section508Compliance/VPAT.md index eab494951..a3baedcc1 100644 --- a/WindowsForms/Section508Compliance/VPAT.md +++ b/WindowsForms/Section508Compliance/VPAT.md @@ -1,6 +1,6 @@ --- layout: post -title: Section 508 Compilance for Syncfusion Windows Forms products +title: Section 508 Compliance for Syncfusion Windows Forms products description: Learn here all about Voluntary Product Accessibility Template of Syncfusion Windows Forms products and more. platform: WindowsForms control: General diff --git a/WindowsForms/System-Requirements.md b/WindowsForms/System-Requirements.md index cee27831d..bd1581a93 100644 --- a/WindowsForms/System-Requirements.md +++ b/WindowsForms/System-Requirements.md @@ -27,13 +27,13 @@ This section describes the system requirements to use Syncfusion® Wi ### Hardware Environment * Processor: x86 or x64 -* RAM : 512 MB (minimum), 1 GB (recommended) -* Hard disk: up to 4 GB of space may be required. However, even if you install in a different drive, 400 MB of free space is required in the boot drive. +* RAM: 512 MB (minimum), 1 GB (recommended) +* Hard disk: up to 4 GB of space may be required. However, even if you install in a different drive, 400 MB of free space is required in the system drive. ### Development Environment * Microsoft Visual Studio 2015/2017/2019/2022 * .NET Framework 4.6.2 -* Lower Syncfusion® .NET frameworks can be used in applications because they are compatible with .NET 4.7, .NET 4.7.1, .NET 4.7.2, and .NET 4.8. For example, in the application, the Syncfusion® 4.6.2 .NET framework assembly can be referred to as 4.7 or higher target versions. -* .NET 8.0, .NET 9.0. +* Earlier Syncfusion® .NET frameworks can be used in applications because they are compatible with .NET 4.7, .NET 4.7.1, .NET 4.7.2, and .NET 4.8. For example, in the application, the Syncfusion® 4.6.2 .NET framework assembly can be referred to as 4.7 or higher target versions. +* .NET 8.0, .NET 9.0, .NET 10.0. diff --git a/WindowsForms/Touch-Support.md b/WindowsForms/Touch-Support.md index e2f834bf3..b24e601a1 100644 --- a/WindowsForms/Touch-Support.md +++ b/WindowsForms/Touch-Support.md @@ -11,7 +11,8 @@ documentation: ug ## Gesture -Gestures determine whether a finger or stylus has moved over a control. Syncfusion® WinForms controls support the following touch gestures: Tap, Swipe, Pinch, and Hold.
+Gestures detect whether a finger or stylus has moved over a control. Syncfusion® WinForms controls support the following touch gestures: Tap, Swipe, Pinch, and Hold. + This table shows the gesture mappings for each control. @@ -30,7 +31,7 @@ Grids
Cell Grid Selection, Scrolling - -Click and select +Click and Select Right-Click
@@ -187,7 +188,7 @@ Context Menu
-TabbedMdI Manager +TabbedMDI Manager TabMove - Click diff --git a/WindowsForms/Upgrade/how-to-upgrade-syncfusion-components-using-vs-extensions.md b/WindowsForms/Upgrade/how-to-upgrade-syncfusion-components-using-vs-extensions.md index f4ab8764e..0b9acdf91 100644 --- a/WindowsForms/Upgrade/how-to-upgrade-syncfusion-components-using-vs-extensions.md +++ b/WindowsForms/Upgrade/how-to-upgrade-syncfusion-components-using-vs-extensions.md @@ -1,28 +1,36 @@ --- layout: post -title: Upgrading Syncfusion WinForms components to a latest version +title: Upgrading Syncfusion WinForms components to the latest version description: Learn here about the how upgrade Syncfusion WinForms components to a latest version from NuGet manager and migrate. platform: WindowsForms control: Essential Studio documentation: ug --- -# Upgrading Syncfusion Windows Forms components to latest version +# Upgrading Syncfusion Windows Forms components to the latest version -Syncfusion publishes the Visual Studio extension in the [Visual Studio marketplace](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.Windows-Extensions) for every Syncfusion Volume releases, with exciting new features and Service Pack release with major bug fixes in the volume releases. +Syncfusion publishes the Visual Studio extension in the [Visual Studio marketplace](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.Windows-Extensions) for every Syncfusion Volume release, with exciting new features, and a Service Pack release with major bug fixes in the volume release. You can upgrade to our latest version from any installed Syncfusion version. ## Upgrading to the latest version -1. In Visual Studio go to Extensions -> Manage Extensions -> Updates and find the Syncfusion WinForms extension. +Before starting the upgrade, close all Visual Studio instances and stop any running debugging sessions. Updating the extension while Visual Studio is running requires closing Visual Studio during the install step. - N> In Visual Studio 2017 or lower, go to Tools -> Extensions and Updates. +1. In Visual Studio go to **Extensions -> Manage Extensions -> Updates** and find the Syncfusion WinForms extension. -2. Then, click on the Update button to update the extension. + N> In Visual Studio 2017 or earlier, go to **Tools -> Extensions and Updates**. + +2. Then, click on the **Update** button to update the extension. ![Update WinForms Extensions](images/UpdateExtensionUI.png) -3. Now close the Visual Studio and click on the Modify button in VSIX installer dialog. +3. Close Visual Studio and click **Modify** in the VSIX installer dialog. + + ![Update WinForms Extensions](images/InstallUpdatedVersion.png) + +4. After the VSIX installer finishes, restart Visual Studio. Open **Extensions -> Manage Extensions -> Installed** and verify the Syncfusion WinForms extension shows the new version. + +### Toolbox recovery - ![Update WinForms Extensions](images/InstallUpdatedVersion.png) \ No newline at end of file +If the Syncfusion toolbox controls disappear after the extension update, run the Syncfusion installer (or re-run the extension installer) with the **Configure Syncfusion controls in Visual Studio** option enabled. This re-registers the toolbox items for the current Visual Studio version. \ No newline at end of file diff --git a/WindowsForms/Upgrade/how-to-upgrade.md b/WindowsForms/Upgrade/how-to-upgrade.md index bf94c9268..f07e53f8c 100644 --- a/WindowsForms/Upgrade/how-to-upgrade.md +++ b/WindowsForms/Upgrade/how-to-upgrade.md @@ -1,13 +1,13 @@ --- layout: post -title: Upgrading Syncfusion Windows Forms installer to latest version +title: Upgrading Syncfusion Windows Forms installer to the latest version description: Learn here about the how upgrade Syncfusion Windows Forms installer to a latest version from website and control panel. platform: WindowsForms control: Essential Studio documentation: ug --- -# Upgrading Syncfusion Windows Forms installer to a latest version +# Upgrading Syncfusion Windows Forms installer to the latest version Syncfusion releases new volumes once every three months, with exciting new features. There will be one Service Pack release for these volume releases. Service Pack releases are provided to address major bug fixes in the volume releases. @@ -18,13 +18,14 @@ See our "[**Upgrade Guide**](https://help.syncfusion.com/upgrade-guide/winforms- ## Upgrading to the latest version +Before starting the upgrade, close all Visual Studio instances and any running Syncfusion applications. + The most recent version of Syncfusion Windows Forms can be downloaded and installed by clicking on the "Latest Version: {Version}" link at the top of the Syncfusion Windows Forms Control Panel. ![Control Panel](images/upgrade-control-panel.png) You can also upgrade to the latest version just by downloading and installing the products you require from [this](https://www.syncfusion.com/account/downloads) link. The existing installed versions are not required to be uninstalled. - It is not required to install the Volume release before installing the Service Pack release. As releases for Volume and Service Packs work independently, you can install the latest version with major bug fixes directly. @@ -35,5 +36,4 @@ To upgrade from trial version, there are two possible solutions. * Uninstall the trial version and install the fully licensed build from the [License & Downloads](https://www.syncfusion.com/account/downloads) section of our website. * If you are using Syncfusion controls from [nuget.org](https://www.nuget.org/packages?q=syncfusion), replace the currently used trial license key with a paid license key that can be generated from the [License & Downloads](https://www.syncfusion.com/account/downloads) section of our website. Refer to [this](https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application) topic for more information regarding registering the license in the application. -N> License registration is not required if you reference Syncfusion assemblies from Licensed installer. These licensing changes applicable to all evaluators who refers the Syncfusion assemblies from evaluation installer and those who use Syncfusion NuGet packages from [nuget.org](https://www.nuget.org/packages?q=syncfusion). - +N> License registration is not required if you reference Syncfusion assemblies from Licensed installer. These licensing changes applicable to all evaluators who refers the Syncfusion assemblies from evaluation installer and those who use Syncfusion NuGet packages from [nuget.org](https://www.nuget.org/packages?q=syncfusion). \ No newline at end of file diff --git a/WindowsForms/Upgrade/upgrade-syncfusion-winforms-nuget-packages.md b/WindowsForms/Upgrade/upgrade-syncfusion-winforms-nuget-packages.md index a50c4bc65..6a32c3ff0 100644 --- a/WindowsForms/Upgrade/upgrade-syncfusion-winforms-nuget-packages.md +++ b/WindowsForms/Upgrade/upgrade-syncfusion-winforms-nuget-packages.md @@ -1,17 +1,17 @@ --- layout: post -title: Upgrade Syncfusion WinForms NuGet packages to a latest version -description: Learn here about the how to upgrading Syncfusion WinForms NuGet packages to a latest version using NuGet manager and package manager UI. +title: Upgrade Syncfusion WinForms NuGet packages to the latest version +description: Learn here about the how to upgrade Syncfusion WinForms NuGet packages to the latest version using the NuGet manager and package manager UI. platform: WindowsForms control: Essential Studio documentation: ug --- -# Upgrading Syncfusion WinForms NuGet packages to a latest version +# Upgrading Syncfusion WinForms NuGet packages to the latest version Every three months, Syncfusion releases new volumes with interesting new features. For this volume, there will be weekly NuGet releases and a service pack. Syncfusion WinForms NuGet packages are released on a weekly basis to address critical issue fixes. -From any Syncfusion WinForms NuGet version you have installed; you can update to our most recent version. +From any Syncfusion WinForms NuGet version you have installed, you can update to our most recent version. ## Upgrade NuGet packages through Package Manager UI @@ -27,13 +27,15 @@ The NuGet **Package Manager UI** in Visual Studio allows you to easily install, > The [nuget.org](https://api.nuget.org/v3/index.json) package source is selected by default in the Package source drop-down. If your Visual Studio does not have nuget.org configured, follow the instructions in the [Microsoft documents](https://docs.microsoft.com/en-us/nuget/tools/package-manager-ui#package-sources) to set up the nuget.org feed URL. -3. By default, the package selected with latest version. You can select the required version and click the **Update** button and accept the license terms. The package will be upgraded to selected version in your WinForms application. +3. By default, the package is selected with the latest version. You can select the required version and click the **Update** button and accept the license terms. The package will be upgraded to the selected version in your WinForms application. ![Winforms Upgrade](images/NuGetUpgrade.png) You can choose the multiple NuGet packages by selecting the checkbox like below and click the **Update** button to update the multiple Syncfusion NuGet packages in your application. - ![Winform NuGet Upgrade](images/MultipleNuGetUpgrade.png) + ![Select multiple Syncfusion NuGet packages for upgrade](images/MultipleNuGetUpgrade.png) + +4. After the upgrade, perform a **Clean** and then **Rebuild** of the solution. Verify the upgraded version in the `.csproj`/`.vbproj` file or in the **Installed** tab of the NuGet Package Manager. ## Upgrade NuGet packages through .NET CLI @@ -48,31 +50,32 @@ To specify a version, add the -v parameter: The **Package Manager Console** saves NuGet packages upgrade time since you don't have to search for the package you want to update, and you can just type the command to update the appropriate Syncfusion WinForms NuGet package. Follow the steps below to upgrade the installed Syncfusion NuGet packages using the Package Manager Console in your WinForms application. 1. To show the Package Manager Console, open your WinForms application in Visual Studio and navigate to **Tools** in the Visual Studio menu and after hovering **NuGet Package Manager**, select **Package Manager Console**. - ![Package Manager Console](images/console.png) -2. The Package Manager Console will be shown at the bottom of the screen. You can install the Syncfusion WinForms NuGet packages by enter the following NuGet update commands. +2. The **Package Manager Console** will be shown at the bottom of the screen. You can update the Syncfusion WinForms NuGet packages by entering the following NuGet update commands. - ***Update specified Syncfusion WinForms NuGet package*** + ### Updating a specified Syncfusion WinForms NuGet package - The below command will update the Syncfusion WinForms NuGet package in the default WinForms application + The command below updates the Syncfusion WinForms NuGet package in the default WinForms application. ```Update-Package ``` **For example:** Update-Package Syncfusion.Grid.Windows - ***Update specified Syncfusion WinForms NuGet package in specified WinForms application*** + ### Updating a specified Syncfusion WinForms NuGet package in a specified WinForms application - The below command will update the Syncfusion WinForms NuGet package in the given WinForms application alone + The command below updates the Syncfusion WinForms NuGet package in the given WinForms application. ```Update-Package -ProjectName ``` - **For example:** Update-Package Syncfusion.Grid.Windows -ProjectName SyncfusionWinformsApp + **For example:** `Update-Package Syncfusion.Grid.Windows -ProjectName SyncfusionWinformsApp` 3. By default, the package will be installed with latest version. You can give the required version with the -Version term like below to install the Syncfusion WinForms NuGet packages in the appropriate version. - ```Update-Package Syncfusion.Grid.Windows -Version 19.2.0.59``` + ```Update-Package Syncfusion.Grid.Windows -Version 19.2.0.59``` ![Package Manager Console Output](images/UpdateConsole.png) -4. The NuGet package manager will update the Syncfusion WinForms NuGet package as well as the dependencies it has. \ No newline at end of file +4. The NuGet package manager will update the Syncfusion WinForms NuGet package as well as its dependencies. When the update is complete, the console shows the updated package version. + +5. After the upgrade, perform a **Clean** and then **Rebuild** of the solution. Verify the upgraded version in the **Installed** tab of the NuGet Package Manager or in the `.csproj`/`.vbproj` file. \ No newline at end of file diff --git a/WindowsForms/Visual-Studio-Integration/Add-References.md b/WindowsForms/Visual-Studio-Integration/Add-References.md index f9329b57d..0ffb6700a 100644 --- a/WindowsForms/Visual-Studio-Integration/Add-References.md +++ b/WindowsForms/Visual-Studio-Integration/Add-References.md @@ -1,7 +1,7 @@ --- layout: post -title: Add a Syncfusion References| WinForms | Syncfusion -description: Syncfusion Reference Manger extension is add-in to add the Syncfusion references into the WinForms application +title: Add a Syncfusion Reference | WinForms | Syncfusion +description: The Syncfusion Reference Manager extension is an add-in that adds the required Syncfusion references to a WinForms application. platform: windowsforms control: Syncfusion Extensions documentation: ug @@ -19,19 +19,19 @@ Follow the given steps to add the Syncfusion® references in Visual Studio: 1. Open a new or existing **WinForms** application. -2. To open Syncfusion® Reference Manager Wizard, follow either one of the options below: +2. To open the Syncfusion® Reference Manager, follow either of the options below: **Option 1:** - Click **Extensions->Syncfusion Menu** and choose **Essential Studio® for WinForms > Add References…** or any other Form in **Visual Studio**. + Click **Extensions -> Syncfusion Menu** and choose **Essential Studio® for WinForms -> Add References…** or any other Form in **Visual Studio**. ![Syncfusion Reference Manager via Syncfusion Menu](Syncfusion-Reference-Manger_images/Syncfusion_Menu_AddReference-latest.png) - N> In Visual Studio 2017 or lower, you can see the Syncfusion menu directly in the Visual Studio menu. + N> In Visual Studio 2017 or lower, the Syncfusion® menu is available directly in the Visual Studio main menu. [Syncfusion Reference Manager via Syncfusion Menu](Syncfusion-Reference-Manger_images/Syncfusion_Menu_AddReference.png) **Option 2:** - Right-click the selected project file from Solution Explorer, then select **Syncfusion® Reference Manager…** from **Context Menu**. The following screenshot shows this option in Visual Studio. + Right-click the selected project file in **Solution Explorer**, then select **Syncfusion® Reference Manager…** from the context menu. The following screenshot shows this option in Visual Studio. ![Syncfusion Reference Manager add-in](Syncfusion-Reference-Manger_images/Syncfusion-Reference-Manger-img1.png) @@ -53,26 +53,18 @@ Follow the given steps to add the Syncfusion® references in Visual Studio: ![Assembly location option in Syncfusion Reference Manger](Syncfusion-Reference-Manger_images/Syncfusion-Reference-Manger1-img4.png) - - N> Window Forms (.NET Core 3.1 and .NET 5.0) application in Visual Studio 2019 is supported from 18.2.0.44 version and .NET 6.0 application in Visual Studio 2022 is supported from 19.4.0.38 and .NET 7.0 application in Visual Studio 2022 is supported from 20.4.0.38 and .NET 8.0 application in Visual Studio 2022 is supported from 23.2.4. Version combobox is not visible for nuget option. - + N> Windows Forms (.NET Core 3.1 and .NET 5.0) applications in Visual Studio 2019 are supported from 18.2.0.44. .NET 6.0 applications in Visual Studio 2022 are supported from 19.4.0.38. .NET 7.0 applications in Visual Studio 2022 are supported from 20.4.0.38. .NET 8.0 applications in Visual Studio 2022 are supported from 23.2.4. The Version combobox is not visible for the NuGet option. 4. Choose the required controls that you want to include in the project. Then, click Done to add the required assemblies for the selected controls into the project. The following screenshot shows the list of required assemblies for the selected controls to be added. ![Syncfusion Reference Manager new assemblies add information dialog](Syncfusion-Reference-Manger_images/Syncfusion-Reference-Manger-img5.png) -5. Click **OK**. The listed Syncfusion assemblies are added to project. Then it notifies “Syncfusion assemblies have been added successfully” in Visual Studio status bar. +5. Click **OK**. The listed Syncfusion assemblies are added to the project. A notification **"Syncfusion assemblies have been added successfully"** appears in the Visual Studio status bar. - ![Syncfusion Reference Manager success status in Visual Studio status bar](Syncfusion-Reference-Manger_images/Syncfusion-Reference-Manger-img6.png) + ![Syncfusion Reference Manager success status in the Visual Studio status bar](Syncfusion-Reference-Manger_images/Syncfusion-Reference-Manger-img6.png) 6. 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®. ![Syncfusion license registration required information dialog in Syncfusion Reference Manager](Syncfusion-Reference-Manger_images/Syncfusion-Reference-Manger-img7.png) -N> Syncfusion® provides Reference Manager support for specific .NET Framework versions, based on the assemblies shipped with the Syncfusion® Essential Studio® setup. If you attempt to add Syncfusion® assemblies to a project whose target framework is not supported by the selected Syncfusion® version, a dialog will appear with the following message: **“Current build v{version} does not support this framework v{Framework Version}.”** - - - - - - +N> Syncfusion® provides Reference Manager support for specific .NET Framework versions, based on the assemblies shipped with the Syncfusion® Essential Studio® setup. If you attempt to add Syncfusion® assemblies to a project whose target framework is not supported by the selected Syncfusion® version, a dialog will appear with the following message: **“Current build v{version} does not support this framework v{Framework Version}.”** \ No newline at end of file diff --git a/WindowsForms/Visual-Studio-Integration/Check-for-Updates.md b/WindowsForms/Visual-Studio-Integration/Check-for-Updates.md index fb3ded4fd..ac3a998ae 100644 --- a/WindowsForms/Visual-Studio-Integration/Check-for-Updates.md +++ b/WindowsForms/Visual-Studio-Integration/Check-for-Updates.md @@ -9,21 +9,21 @@ documentation: ug # Check for Updates in Syncfusion® Essential Windows Forms -Syncfusion® provides the check for update extensions to find the latest version of the essential release. If it is available, then provide the option to update to the most recent version of the Essential Studio® release. So that you always get the latest features, fixes, and improvements by installing the latest version. +Syncfusion® provides the Check for Updates extension to find the latest version of the Essential Studio® release. If an update is available, the extension provides the option to update to the most recent version. This ensures you always get the latest features, fixes, and improvements by installing the most recent version. -I> The Syncfusion® Check for updates is available from v17.1.0.32. +I> The Syncfusion® Check for Updates feature is available from v17.1.0.32. -You can check updates availability in Visual Studio, and then install the update version if required. +You can check for available updates in Visual Studio, and then install the update version if required. 1. Choose **Extensions->Syncfusion -> Check for Updates…** in the Visual Studio menu ![Syncfusion check for updates menu](Check-for-Updates_images/Check-for-Updates_images-img1-latest.png) - N> In Visual Studio 2017 or lower, you can see the Syncfusion menu directly in the Visual Studio menu. + N> In Visual Studio 2017 or lower, the Syncfusion® menu is available directly in the Visual Studio main menu. ![Syncfusion check for updates menu](Check-for-Updates_images/Check-for-Updates_images-img1.png) -2. When there is an update, **Update** dialog box opens. +2. The **Check for Updates** dialog opens. If no update is available, the dialog indicates that you are using the latest version. If an update is available, the dialog lists the latest version and provides the **Update** option. ![Syncfusion check for updates wizard](Check-for-Updates_images/Check-for-Updates_images-img2.png) diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template.md b/WindowsForms/Visual-Studio-Integration/Item-Template.md index dcf7cbaf2..29c1d0b97 100644 --- a/WindowsForms/Visual-Studio-Integration/Item-Template.md +++ b/WindowsForms/Visual-Studio-Integration/Item-Template.md @@ -15,39 +15,35 @@ I> The Syncfusion® Windows Forms item templates are available from v13.1.0.21. The following steps will guide you in adding the Syncfusion® WinForms components to your Visual Studio WinForms application. -> 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. +> Check whether the **Syncfusion WinForms** extension is installed in Visual Studio Extension Manager by going to **Extensions → Manage Extensions → Installed** for Visual Studio 2019 or later, and to **Tools → Extensions and Updates → Installed** for Visual Studio 2017 or lower. If this extension is not installed, 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. ## Add components using Syncfusion® Item Template -1. Open a new or existing WinForms application. +1. Open a new or existing **WinForms** project. Then choose one of the following options to open the wizard: - **Option 1:** + - **Option 1:** In **Solution Explorer**, right-click the WinForms project and choose **Add Syncfusion Item...**. -2. From the **Solution Explorer, right-click** on the WinForms application. Choose **Add Syncfusion Item...**. + ![Add Syncfusion Item option in the Solution Explorer context menu](Item-Template-images/Add-syncfusion-item.png) - ![Choose Add Syncfusion Item option from right click project](Item-Template-images/Add-syncfusion-item.png) + - **Option 2:** Click **Extensions → Essential Studio® for WinForms → Add Syncfusion Item…** in Visual Studio. - **Option 2:** + ![Add Syncfusion Item option in the Extensions menu](Item-Template-images/Add-item.png) -3. Click **Extensions > Essential Studio® for WinForms > Add Syncfusion Item…** in Visual Studio. +2. The Syncfusion® WinForms Item Template wizard opens as shown below. - ![Choose Add Syncfusion Item option from menu](Item-Template-images/Add-item.png) + ![Syncfusion® WinForms Item Template wizard showing available forms and components](Item-Template-images/Add-syncfusion-ui.png) -4. The Syncfusion® WinForms Item Template wizard will be launched as follows. +3. Choose one of the following scenarios to add a Syncfusion® form in your application: - ![Syncfusion WinForms Item template components](Item-Template-images/Add-syncfusion-ui.png) + **Default Form with Syncfusion® Component:** If you select the **Default** form and then choose any Syncfusion® component and the specific features that are essential for your project, the selected component is added with the default Microsoft WinForms layout. -5. Please choose one of the following scenarios to add Syncfusion Forms in your application: + ![Default form with a Syncfusion® component added](Item-Template-images/Default-Form-with-Syncfusion-Component.png) - **Default Form with Syncfusion Component:** If you select the **Default** form and then choose any Syncfusion® component and the specific features that are essential for your project, the selected component will be added with the default Microsoft form layout. + **Syncfusion® Form with Syncfusion® Component:** If you select a Syncfusion® form and then choose any Syncfusion® component and the specific features that are essential for your project, the selected component is added with the layout of the selected Syncfusion® form. - ![Default Form with Syncfusion Component](Item-Template-images/Default-Form-with-Syncfusion-Component.png) + ![Syncfusion® form with a Syncfusion® component added](Item-Template-images/Syncfusion-Form-with-Syncfusion-Component.png) - **Syncfusion Form with Syncfusion Component:** If you select a Syncfusion® form and then choose any Syncfusion® component and the specific features that are essential for your project, the selected component will be added with the layout of the selected Syncfusion® form. - - ![Syncfusion Form with Syncfusion Component](Item-Template-images/Syncfusion-Form-with-Syncfusion-Component.png) - - **Syncfusion Form without Syncfusion Components:** If you select a Syncfusion® form and then choose the **Blank** option from the Syncfusion® component list, a blank Syncfusion® form will be added without any Syncfusion® components. + **Syncfusion® Form without Syncfusion® Components:** If you select a Syncfusion® form and then choose **Blank** from the Syncfusion® component list, a blank Syncfusion® form is added without any Syncfusion® components. ![Syncfusion Form without Syncfusion Components](Item-Template-images/Syncfusion-Form-without-Syncfusion-Components.png) diff --git a/WindowsForms/Visual-Studio-Integration/Overview.md b/WindowsForms/Visual-Studio-Integration/Overview.md index 804638c0e..c4a8d6b7a 100644 --- a/WindowsForms/Visual-Studio-Integration/Overview.md +++ b/WindowsForms/Visual-Studio-Integration/Overview.md @@ -17,27 +17,27 @@ N> Syncfusion® Extension is published in Visual Studio Marketplace. We provided [Visual Studio 2019 or lower](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.Windows-Extensions). -I> The Syncfusion® WinForms menu option is available from v17.1.0.32. +I> The Syncfusion® WinForms menu option is available from v17.1.0.32. The same availability note also applies to the [Check for Updates](https://help.syncfusion.com/windowsforms/visual-studio-integration/check-for-updates) feature. -The Syncfusion® provides the following supports in Visual Studio: +Syncfusion® provides the following features in Visual Studio: -1. [Create Project](https://help.syncfusion.com/windowsforms/Visual-Studio-Integration/Create-Project): Creates the Syncfusion® WinForms application by adding the required Syncfusion® assemblies and forms. -2. [Item Template](https://help.syncfusion.com/windowsforms/Visual-Studio-Integration/Item-Template): Add predefined Syncfusion® items (Forms) and the required Syncfusion® assemblies in WinForms Application. -3. [Add References](https://help.syncfusion.com/windowsforms/Visual-Studio-Integration/Add-References): Add the required Syncfusion® assembly to Windows project reference based on the selected control(s). +1. [Create Project](https://help.syncfusion.com/windowsforms/visual-studio-integration/template-studio): Creates the Syncfusion® WinForms application by adding the required Syncfusion® assemblies and forms. +2. [Item Template](https://help.syncfusion.com/windowsforms/visual-studio-integration/item-template): Add predefined Syncfusion® items (Forms) and the required Syncfusion® assemblies in WinForms Application. +3. [Add References](https://help.syncfusion.com/windowsforms/visual-studio-integration/add-references): Add the required Syncfusion® assembly to Windows project reference based on the selected control(s). 4. [Toolbox](https://help.syncfusion.com/windowsforms/visual-studio-integration/toolbox-configuration): Configure the Syncfusion® controls into the Visual Studio .NET toolbox. -5. [Troubleshooting](https://help.syncfusion.com/windowsforms/Visual-Studio-Integration/Troubleshooting): Troubleshoots the project with the Syncfusion® configuration and apply the fix like, wrong Framework Syncfusion® assembly added to the project or missing any Syncfusion® dependent assembly of a referred assembly. +5. [Troubleshooting](https://help.syncfusion.com/windowsforms/visual-studio-integration/troubleshooting): Troubleshoots the project with the Syncfusion® configuration and apply the fix like, wrong Framework Syncfusion® assembly added to the project or missing any Syncfusion® dependent assembly of a referred assembly. -**No project selected in Visual Studio** +**Figure 1: Syncfusion® menu when no project is selected in Visual Studio** -![Syncfusion Menu when No project selected in Visual Studio](Overview-images/Syncfusion_Menu_OverView1.png) +![Syncfusion® menu when no project is selected in Visual Studio](Overview-images/Syncfusion_Menu_OverView1.png) -**Selected Microsoft WinForms application in Visual Studio** +**Figure 2: Syncfusion® menu when a Microsoft WinForms application is selected in Visual Studio** -![Syncfusion Menu when Selected Microsoft WinForms application in Visual Studio](Overview-images/Syncfusion_Menu_OverView2.png) +![Syncfusion® menu when a Microsoft WinForms application is selected in Visual Studio](Overview-images/Syncfusion_Menu_OverView2.png) -**Selected Syncfusion® WinForms application in Visual Studio** +**Figure 3: Syncfusion® menu when a Syncfusion® WinForms application is selected in Visual Studio** -![Syncfusion Menu when Selected Synfusion WinForms application in Visual Studio](Overview-images/Syncfusion_Menu_OverView3.png) +![Syncfusion® menu when a Syncfusion® WinForms application is selected in Visual Studio](Overview-images/Syncfusion_Menu_OverView3.png) N> In Visual Studio 2017 or lower, you can see the Syncfusion menu directly in the Visual Studio menu. diff --git a/WindowsForms/Visual-Studio-Integration/Syncfusion-Notifications.md b/WindowsForms/Visual-Studio-Integration/Syncfusion-Notifications.md index 49873efe6..955c28d4c 100644 --- a/WindowsForms/Visual-Studio-Integration/Syncfusion-Notifications.md +++ b/WindowsForms/Visual-Studio-Integration/Syncfusion-Notifications.md @@ -15,11 +15,19 @@ N> The Syncfusion® Notification feature is available from Essential Studio® v2 ## Notification Configuration -The Syncfusion® Options page allows you to configure notification settings. Customise trial and newer version notifications with a simple true or false toggle. +The Syncfusion® Options page allows you to configure notification settings. Each notification can be toggled **on** (true) or **off** (false). Toggling a notification off suppresses that notification at runtime, while leaving the others active. -It can be accessed by clicking **Tools -> Options -> Syncfusion -> Winforms** +To configure a notification: -![Option Page](images/winforms-optionPage.png) +1. Open Visual Studio. +2. Navigate to **Tools → Options → Syncfusion → WinForms**. +3. Locate the notification to disable. +4. Set its value to **False** to disable the notification or **True** to enable it. +5. Click **OK**. + +The toggles are per-user settings stored in the Visual Studio profile, and they persist across Visual Studio upgrades on the same machine. + +![Syncfusion® WinForms Options page listing the notification toggles](images/winforms-optionPage.png) ## Notification Types diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio.md b/WindowsForms/Visual-Studio-Integration/Template-Studio.md index 8d7b43380..7ef10fa69 100644 --- a/WindowsForms/Visual-Studio-Integration/Template-Studio.md +++ b/WindowsForms/Visual-Studio-Integration/Template-Studio.md @@ -20,9 +20,9 @@ Create the Syncfusion® WinForms project using the Visual Studio Project Templat > 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. +1. Open Visual Studio 2017, 2019, or 2022. -2. Select one of the following options to create the Syncfusion® WinForms application +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. @@ -52,17 +52,17 @@ Create the Syncfusion® WinForms project using the Visual Studio Project Templat ![Syncfusion WinForms project type selection wizard](Template-Studio-Images/WF-4.png) - **Predefined template:** Choose this option to select from 5 predefined templates, including Calendar, Contact, Outlook, Docking Manager, and Spreadsheet. By choosing one of these templates, you can create your application without needing to follow any further steps. + **Predefined template:** Choose this option to select from 5 predefined templates, including Calendar, Contact, Outlook, Docking Manager, and Spreadsheet. You can create your application without further steps. ![Syncfusion WinForms Predefined template wizard](Template-Studio-Images/WF-10.png) - **Project type:** Choose this option to select from 4 project types, including Blank, Menu Bar, Ribbon, and Tabbed Form. + **Project type:** Choose this option to select from 4 project types, including Blank, Menu Bar, Ribbon, and Tabbed Form. Blank creates an empty project, Menu Bar creates a project with a top menu bar, Ribbon creates a project with a ribbon, and Tabbed Form creates a project with a tabbed MDI layout. 6. Click **Next** or navigate to the **Pages** tab to access a list of available Syncfusion® WinForms components you can add to the application. ![Syncfusion WinForms pages selection wizard](Template-Studio-Images/WF-6.png) - To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details. + To unselect an added control, click the X icon next to the corresponding control in the **Project Details** list. N> The Control Features option is not accessible for Blank Pages. @@ -74,8 +74,8 @@ Create the Syncfusion® WinForms project using the Visual Studio Project Templat ![Syncfusion WinForms app features selection wizard](Template-Studio-Images/WF-7.png) - N> The App Features option is not accessible for .NET Framework. - + N> 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. @@ -88,6 +88,8 @@ Create the Syncfusion® WinForms project using the Visual Studio Project Templat ![NuGetEntry](Template-Studio-Images/NuGetEntry.png) + N> After the project is created, open the **Package Manager Console** or the **NuGet Package Manager** and confirm that all Syncfusion® packages restored successfully. If any package shows a warning, run **Update-Package -reinstall** for that package. + 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. 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. The **ConfigureServices** method in the **Program.cs** file establishes this DI setup by managing the application’s services, view models, and views. Here’s a detailed breakdown: @@ -125,7 +127,7 @@ Here's a simple explanation: ![Resources](Template-Studio-Images/Resources.png) - > The .NET 8.0 and .NET 9.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: + > The .NET 8.0, .NET 9.0, and .NET 10.0 options are available in the **Select a framework version** dropdown only if the respective .NET SDKs are installed on the system. The table below outlines the .NET versions, the product versions from which they are available, and the Visual Studio versions that support them: > > > @@ -145,6 +147,11 @@ Here's a simple explanation: > > > + > + > + > + > + > > >
v27.2.2Visual Studio 2022
.NET 10.0v28.1.6Visual Studio 2022
diff --git a/WindowsForms/Visual-Studio-Integration/Toolbox-Configuration.md b/WindowsForms/Visual-Studio-Integration/Toolbox-Configuration.md index b22820652..e3ac7a30e 100644 --- a/WindowsForms/Visual-Studio-Integration/Toolbox-Configuration.md +++ b/WindowsForms/Visual-Studio-Integration/Toolbox-Configuration.md @@ -17,7 +17,9 @@ Syncfusion® controls will be automatically configured in the Visual Use the following steps to add the Syncfusion® WinForms controls through the Syncfusion® Toolbox Installer: -1. To launch Toolbox configuration utility, follow either one of the options below: +N> The Syncfusion® Essential Studio® WinForms installer must be installed before running the Toolbox Installer. If multiple Visual Studio versions are installed on the same machine, run the Toolbox Installer once and select each Visual Studio version to configure. + +1. To launch the Toolbox Configuration utility, follow either of the options below: **Option 1:** To open the Syncfusion Control Panel, click **Add On and Utilities > Toolbox Installer**. @@ -45,7 +47,7 @@ Use the following steps to add the Syncfusion® WinForms controls through the Sy N> You can also configure Syncfusion® controls from a lower version Framework assembly to higher version of Visual Studio. -3. The successful configuration of Toolbox is indicated by an Information message. Click **OK**. +3. The successful configuration of the Toolbox is indicated by an information message. Click **OK**. ![Toolbox Installer](Toolbox-Configuration_images/Toolbox-Configuration_img3.png) diff --git a/WindowsForms/Visual-Studio-Integration/Troubleshooting.md b/WindowsForms/Visual-Studio-Integration/Troubleshooting.md index b1520934e..8464e1b6c 100644 --- a/WindowsForms/Visual-Studio-Integration/Troubleshooting.md +++ b/WindowsForms/Visual-Studio-Integration/Troubleshooting.md @@ -9,10 +9,10 @@ documentation: ug # Troubleshoot the project -Troubleshoot your project for Syncfusion® configuration issues and apply necessary fixes, such as adding a Syncfusion® assembly targeting the incorrect .NET Framework version or resolving missing dependent Syncfusion® assemblies. The Syncfusion Troubleshooter is capable of performing the following tasks: +Troubleshoot your project for Syncfusion® configuration issues. Apply fixes such as adding a Syncfusion® assembly that targets the correct .NET Framework version, or resolving missing dependent Syncfusion® assemblies. The Syncfusion® Troubleshooter performs the following tasks: -* Report the Configuration issues. +* Report the configuration issues. * Apply the solution. ## Report the Configuration issues diff --git a/WindowsForms/Visual-Studio-Integration/download-and-installation.md b/WindowsForms/Visual-Studio-Integration/download-and-installation.md index 935a187ad..c7cb1bf20 100644 --- a/WindowsForms/Visual-Studio-Integration/download-and-installation.md +++ b/WindowsForms/Visual-Studio-Integration/download-and-installation.md @@ -1,6 +1,6 @@ --- layout: post -title: Downloand and Installation | WinForms | Syncfusion +title: Download and Installation | WinForms | Syncfusion description: this section provide the information about how to download and install the extensions in Visual Studio. platform: windowsforms control: Syncfusion Extensions @@ -19,7 +19,7 @@ Syncfusion® publishes its Visual Studio extension on the Visual Stud The following software prerequisites must be installed to use the Syncfusion® WinForms extension for creating projects, adding code snippets, converting, and upgrading Syncfusion® WinForms applications. -* [Visual Studio 2010 or later](https://visualstudio.microsoft.com/downloads). +* [Visual Studio 2015 or later](https://visualstudio.microsoft.com/downloads). ## Install through the Visual Studio Manage Extensions diff --git a/WindowsForms/ai-tools/ai-powered-development.md b/WindowsForms/ai-tools/ai-powered-development.md index 3973bf79b..7591f1e91 100644 --- a/WindowsForms/ai-tools/ai-powered-development.md +++ b/WindowsForms/ai-tools/ai-powered-development.md @@ -100,7 +100,6 @@ Choose one of these two options: The MCP Server establishes a direct connection between your IDE-integrated AI and Syncfusion WinForms documentation, enabling the AI to retrieve real-time information for unfamiliar controls. Using Retrieval-Augmented Generation (RAG), it injects relevant documentation into the AI's context to generate accurate and up-to-date code suggestions. - **What you get:** - Complete documentation for all 145+ WinForms controls - Live API references (properties, methods, events) @@ -190,7 +189,7 @@ public partial class EmployeeForm : Form InitializeComponent(); SetupGrid(); } - + private void SetupGrid() { employeeGrid = new GridControl(); @@ -213,7 +212,7 @@ public partial class EmployeeForm : Form this.Controls.Add(employeeGrid); LoadEmployees(); } - + private void LoadEmployees() { // Load employee data @@ -249,7 +248,6 @@ If you encounter unexpected results, use this as a quick diagnostic reference: | Data binding not working | Incorrect binding setup or DataSource not assigned | Set DataSource property correctly; use WinForms binding patterns with GridControl and other bound controls | | NuGet package conflicts | Multiple incompatible Syncfusion versions installed | Use matching Syncfusion versions for all components in your project | - ## Quick Reference | If you want... | Do this... | diff --git a/WindowsForms/arm-support.md b/WindowsForms/arm-support.md index 2a3e02dd5..91e6f7a80 100644 --- a/WindowsForms/arm-support.md +++ b/WindowsForms/arm-support.md @@ -9,7 +9,7 @@ documentation: ug # ARM support in Windows Forms Controls -The Syncfusion WinForms components are compatible with ARM64 devices. You can build the application with our components. The following components/features are alone yet to be supported for ARM64 device compatibility. Based on the feasibility, we will provide the support for the below components/features soon, +The Syncfusion WinForms components are compatible with ARM64 devices. You can build the application with our components. The following components/features are not yet supported for ARM64 device compatibility. Based on the feasibility, we will provide support for the below components/features soon, * PDF library: HTML to PDF conversion * PDF library: OCR Processing diff --git a/WindowsForms/dotnet-core-compatibility.md b/WindowsForms/dotnet-core-compatibility.md index 0238ee74e..607db2ce7 100644 --- a/WindowsForms/dotnet-core-compatibility.md +++ b/WindowsForms/dotnet-core-compatibility.md @@ -7,15 +7,15 @@ control: .NET Core documentation: ug --- -# WinForms Applications using .NET Core and Syncfusion® WinForms Controls +# Using Syncfusion WinForms with .NET Core -Syncfusion® Essential Studio® for Windows Forms suits .NET core assemblies for building Windows Forms .NET Core applications using Syncfusion® Controls. This section explains how to create the project in .NET Core application and using Syncfusion® Windows Forms controls. +Syncfusion® Essential Studio® for Windows Forms provides .NET Core assemblies for building Windows Forms .NET Core applications using Syncfusion® Controls. This section explains how to create the project in a .NET Core application and using Syncfusion® Windows Forms controls. -N> All Syncfusion® Windows Forms controls supports .NET Core Framework except the controls labeled as `classic`. +N> All Syncfusion® Windows Forms controls support .NET Core Framework except the controls labeled as `classic`. ## Create a .NET Core project -**Step 1**: Open Visual Studio, go to **File > New > Project...** and you can now see **Create a new project** dialog. Here, select **Windows Forms App (.NET Core)** template and click **Next**. +**Step 1**: Open Visual Studio, go to **File > New > Project...** and the following **Create a new project** dialog appears. Here, select **Windows Forms App (.NET Core)** template and click **Next**. NETcore showing create the project @@ -25,7 +25,7 @@ N> All Syncfusion® Windows Forms controls supports .NET Core Framewo **Step 3**: In the Additional information window, select .NET 6.0 (Long-term support) for the Framework setting, and then click **Create**. -NETcore showing the Framework setting selected version +NETcore showing the Framework setting — selected version **Step 4**: Finally, Windows Forms (.NET Core) sample project is created. @@ -67,8 +67,8 @@ We are now going to see a demo on how to add **ButtonAdv** control in WinForms . {% highlight c# %} ButtonAdv button = new ButtonAdv(); -button.Text = ”ButtonAdv”; -this.controls.add(button); +button.Text = "ButtonAdv"; +this.Controls.Add(button); {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/dotnet-core-designtime-feature.md b/WindowsForms/dotnet-core-designtime-feature.md index 3645ae3f3..228ff5f1b 100644 --- a/WindowsForms/dotnet-core-designtime-feature.md +++ b/WindowsForms/dotnet-core-designtime-feature.md @@ -11,7 +11,7 @@ documentation: ug ## Overview -We have expanded design-time support—such as Smart Tags, Custom Collection Editors, and Custom Forms for UITypeEditor—to include controls targeting .NET 6 and higher, which were previously available only in the .NET Framework. +We have added design-time support—such as Smart Tags, Custom Collection Editors, and Custom Forms for UITypeEditor—to include controls targeting .NET 6 and higher, which were previously available only in the .NET Framework. ## Why We Use the WinForms Designer SDK Microsoft has introduced the **WinForms Designer SDK** NuGet package to support custom design-time experiences in Visual Studio for .NET Core and later versions. This SDK replaces the traditional designer APIs that were previously part of the .NET Framework and Windows OS. @@ -22,11 +22,11 @@ The new Designer SDK offers several key advantages: * Not reliant on the .NET Framework * Fully integrated with Visual Studio -It provides essential extension points and base classes that allow developers to implement advanced design-time features such as, **Smart Tags, Custom Collection Editors, Custom Forms for UITypeEditor**. +It provides essential extension points and base classes that allow developers to implement advanced design-time features such as **Smart Tags, Custom Collection Editors, Custom Forms for UITypeEditor**. These features are now available for controls targeting .NET 6 and higher. -To enable this functionality, we have included the **WinForms Designer SDK** as a dependency in our control NuGet packages starting from this version **v26.1.35**. This ensures a consistent and enhanced design-time experience across modern .NET platforms. +To enable this functionality, we have added the **WinForms Designer SDK** as a dependency in our control NuGet packages starting from this version **v26.1.35**. This ensures a consistent and enhanced design-time experience across modern .NET platforms, including .NET 6, .NET 7, .NET 8, .NET 9, and later. ## Control Package Details We have added the **WinForms Designer SDK** as a dependency in the following control packages. Please refer to the table below for details: @@ -145,6 +145,6 @@ N> The listed package assemblies are built against the Designer SDK to provide i Certain controls properties in .NET Core WinForms have known design‑time limitations. These issues are largely caused by the out‑of‑process WinForms Designer architecture, which results in UITypeEditors, collection editors, and smart tags having only limited communication with the design surface. -We have documented these details in the following Knowledge Base article. Please refer to it for comprehensive information. +We have documented these details in the following Knowledge Base article. Please refer to it for comprehensive information. Refer to the [Visual Studio version requirements](https://learn.microsoft.com/en-us/visualstudio/releases/2022/release-notes) for the .NET 6 and later WinForms Designer SDK support. **KB Link** : [Known Design-Time Limitations in .NET Core WinForms and Syncfusion Controls](https://support.syncfusion.com/kb/article/22154/known-design-time-limitations-in-net-core-winforms-and-syncfusion-controls) diff --git a/WindowsForms/dotnet-framework-compatibility.md b/WindowsForms/dotnet-framework-compatibility.md index 9e58bd47d..50a6d24af 100644 --- a/WindowsForms/dotnet-framework-compatibility.md +++ b/WindowsForms/dotnet-framework-compatibility.md @@ -9,11 +9,11 @@ documentation: ug # .NET Framework and .NET Core Compatibility -Syncfusion® Windows Forms Controls are always compatible latest .NET Framework and .NET Core versions. +Syncfusion® Windows Forms Controls are always compatible with the latest .NET Framework and .NET Core versions. ## Version Compatibility -Below table represents the supported Syncfusion® Essential Studio® version for .NET Framework and .NET Core versions. +The following table summarizes the supported Syncfusion® Essential Studio® versions for .NET Framework and .NET Core versions. diff --git a/WindowsForms/right-to-left.md b/WindowsForms/right-to-left.md index a7645d577..4b7d811d5 100644 --- a/WindowsForms/right-to-left.md +++ b/WindowsForms/right-to-left.md @@ -9,6 +9,6 @@ documentation: ug # Right to Left support in Syncfusion Windows Forms Controls -Right to Left (RTL) support displays the content from right-to-left direction by setting the [RightToLeft](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.control.righttoleft?redirectedfrom=MSDN&view=netframework-4.8#System_Windows_Forms_Control_RightToLeft) property to `Yes`. This is helpful to support the Right-to-Left scripted languages like Arabic, Hebrew, Urdu, etc., +Right to Left (RTL) support displays the content from right-to-left direction by setting the [RightToLeft](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.control.righttoleft?redirectedfrom=MSDN&view=netframework-4.8#System_Windows_Forms_Control_RightToLeft) property to `Yes`. This is useful for supporting the Right-to-Left scripted languages like Arabic, Hebrew, Urdu, etc. -All Windows Forms Syncfusion controls supports Right-to-Left (RTL) based on FlowDirection property. In addition to that, all controls provides [localization](https://help.syncfusion.com/windowsforms/localization) support to change language of strings used in control specific to any culture. +All Windows Forms Syncfusion controls support Right-to-Left (RTL). In addition to that, all controls provide [localization](https://help.syncfusion.com/windowsforms/localization) support to change the language of strings used in a control specific to any culture. \ No newline at end of file diff --git a/WindowsForms/skills/component-skills.md b/WindowsForms/skills/component-skills.md index b4fba710d..b62bffa66 100644 --- a/WindowsForms/skills/component-skills.md +++ b/WindowsForms/skills/component-skills.md @@ -10,7 +10,7 @@ domainurl: ##DomainURL## # Syncfusion Windows Forms Agent Skills for AI Assistants -This guide introduces **Syncfusion Windows Forms Skills**, a knowledge package that enables AI assistants (VS Code, Cursor, CodeStudio, etc.) to understand and generate accurate Windows Forms code using official APIs, patterns, and theming guidelines. +This guide introduces **Syncfusion Windows Forms Skills**, a knowledge package that enables AI assistants (Visual Studio Code, Cursor, CodeStudio, etc.) to understand and generate accurate Windows Forms code using official APIs, patterns, and theming guidelines. These skills eliminate common issues with generic AI suggestions by grounding the assistant in accurate component usage patterns, API structures, supported features, and project‑specific configuration. @@ -20,7 +20,7 @@ Before installing Syncfusion® Windows Forms - Required [Node.js](https://nodejs.org/en/) version >= 16 - Windows Forms application (existing or new); see [Overview](https://help.syncfusion.com/windowsforms/overview) -- A supported AI agent or IDE that integrates with the Skills CLI (VS Code, Syncfusion® Code Studio, Cursor, etc.) +- A supported AI agent or IDE that integrates with the Skills CLI (Visual Studio Code, Syncfusion® Code Studio, Cursor, etc.) ## Key Benefits @@ -37,7 +37,7 @@ Before installing Syncfusion® Windows Forms **Design‑System Guidance** - Theme usage, including light and dark variants -- VisualStyle patterns and customization approaches +- [VisualStyle](https://help.syncfusion.com/windowsforms/visualstyle) patterns and customization approaches - Consistent design alignment across Syncfusion® Windows Forms components ## Installation @@ -68,8 +68,7 @@ npx skills add syncfusion/winforms-ui-components-skills {% endhighlight %} {% endtabs %} -The terminal will display a list of available skills. Use the arrow keys to navigate, the space bar to select the desired skills, and the Enter key to confirm. -{% tabs %} +The terminal will display a list of available skills. Use the **arrow keys** to move between skills, the **space bar** to toggle a skill on or off, and the **Enter** key to confirm. {% highlight bash tabtitle="CMD" %} Select skills to install (space to toggle) @@ -125,7 +124,7 @@ Choose your installation scope (project-level or global), then confirm to comple {% endhighlight %} {% endtabs %} -This registers the Syncfusion® skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills). +This registers the Syncfusion® skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills). After installation, restart your IDE (or use the **Reload Window** command) so the IDE can detect the newly added skill files. To learn more about the Skills CLI, refer [here](https://www.skills.sh/docs). @@ -144,7 +143,7 @@ To learn more about the Skills CLI, refer [here](https://www.skills.sh/docs). Once skills are installed, the assistant can be used to generate and update Syncfusion® Windows Forms code for tasks such as: - "Add a DataGrid with paging, sorting, and filtering." -- "Create a Scheduler with week view and drag‑drop." +- "Create a Schedule control with week view and drag‑drop." ## Skills CLI Commands @@ -212,9 +211,10 @@ Yes. Once installed, supported agents automatically detect and load relevant ski **Skills are not being loaded** -Verify that skills are installed in the correct agent directory, restart the IDE, and confirm that the agent supports external skill files. +Verify that skills are installed in the correct agent directory (for example, `.agents/skills/`), confirm with `npx skills list`, restart the IDE (or run the **Reload Window** command), and confirm that the agent supports external skill files. ## See also - [Agent Skills Standards](https://agentskills.io/home) -- [Skills CLI](https://www.skills.sh/docs) \ No newline at end of file +- [Skills CLI](https://www.skills.sh/docs) +- [VisualStyle](https://help.syncfusion.com/windowsforms/visualstyle) \ No newline at end of file diff --git a/WindowsForms/skills/ui-builder-skill.md b/WindowsForms/skills/ui-builder-skill.md index 3e2fdba36..bdeca9bc2 100644 --- a/WindowsForms/skills/ui-builder-skill.md +++ b/WindowsForms/skills/ui-builder-skill.md @@ -136,7 +136,7 @@ Key enforcement points: After installing Windows Forms UI Builder with APM, the relevant agent and skill files are added to your project under: -- `.agent/skills/` (skill files) +- `.agents/skills/` (skill files) - `.github/agents/` (Windows Forms UI builder agent configuration, based on the selected target) To start using the skill: @@ -159,7 +159,7 @@ Create a CMS Admin Dashboard UI featuring a collapsible TreeView in a left panel {% endpromptcard %} {% endpromptcards %} -Generated code follows Windows Forms best practices with proper control layout, event handling, data bindings, strong C# typing, and built-in security measures such as input validation and avoidance of hardcore secrets. The code is fully compatible with Visual Studio designer and Windows Forms conventions. +Generated code follows Windows Forms best practices with proper control layout, event handling, data bindings, strong C# typing, and built-in security measures such as input validation and avoidance of hard-coded secrets. The code is fully compatible with Visual Studio designer and Windows Forms conventions. ## Best Practices @@ -173,7 +173,7 @@ Follow these guidelines to get the most out of UI Builder and ensure high-qualit ## Troubleshooting -- **APM installation failure**: Refer to this [documentation](https://microsoft.github.io/apm/getting-started/installation/#troubleshooting) +- **APM installation failure**: Refer to this [documentation](https://microsoft.github.io/apm/getting-started/installation/#troubleshooting). - **Skills not loading**: Ensure the **.agent/** and **.github/agents/** folders exist in your project and that the skill was installed successfully using APM. Verify that the correct agent is selected from the Agent dropdown in your IDE. @@ -194,9 +194,12 @@ Yes. Supported agents automatically load relevant skills based on your query. Yes — the generated Windows Forms controls include clear integration points for style adjustments. **Does it modify files automatically?** -The skill proposes changes and requires confirmation for insertion; automatic dependency installation may be offered depending on agent permissions. +The skill proposes changes and requires confirmation for insertion. Automatic dependency installation may be offered depending on agent permissions ## See also - [Agent Skills Standards](https://agentskills.io/home) - [Agent Package Manager](https://microsoft.github.io/apm/getting-started/quick-start/) +- [Theme Studio](https://help.syncfusion.com/windowsforms/skinmanager/theme-studio) +- [VisualStyle](https://help.syncfusion.com/windowsforms/visualstyle) +- [Licensing](https://help.syncfusion.com/windowsforms/licensing) diff --git a/WindowsForms/skins/Getting-Started.md b/WindowsForms/skins/Getting-Started.md index dc69e2a4b..4d983221f 100644 --- a/WindowsForms/skins/Getting-Started.md +++ b/WindowsForms/skins/Getting-Started.md @@ -13,7 +13,7 @@ This section briefly describes how to create a new Windows Forms project in Visu ## Assembly deployment and theme assemblies -SkinManager presents in the `Syncfusion.Shared.Base` assembly. +SkinManager is present in the `Syncfusion.Shared.Base` assembly.
@@ -74,13 +74,17 @@ SkinManager.LoadAssembly(GetType(Syncfusion.WinForms.Themes.Office2016Theme).Ass {% endtabs %} -## Adding skin manager component +## Adding SkinManager component ## Through designer -1) Create a new Windows Forms application in Visual Studio. +1 Create a new Windows Forms application in Visual Studio. -2) The `SkinManager` component can be added to designer by dragging it from the toolbox to the design view. +2) Open the target form in the designer. + +3) Drag the `SkinManager` component from the toolbox and drop it onto the designer. + +4) Select the `SkinManager` component and use the `Controls` property in the Properties window to choose the control or form to which the theme should be applied. The following dependent assemblies will be added automatically: @@ -98,13 +102,13 @@ N> SkinManager does not support the custom themes ( themes generated using Theme ### Applying theme to the form -Skin manager supports to apply theme for all the control in the form or a container by applying theme to the form or container. So, you do not need to apply theme for each control. +SkinManager supports applying a theme for all controls in the form or a container by applying the theme to the form or container. So, you do not need to apply the theme for each control. ![WinForms Skin Manager apply theme to entire form](skin_images/winforms-skin-manager-apply-theme-to-the-entire-form.png) ## Through code -Theme for a control or form can be applied by settings `Controls` property of `SkinManager`. +Theme for a control or form can be applied by setting the `Controls` property of `SkinManager`. {% tabs %} @@ -132,7 +136,7 @@ skinManager1.Controls = treeViewAdv1 ### Applying theme to the form -Skin manager supports to apply theme for all the control in the form or a container by applying theme to the form or container. So, you do not need to apply theme for each control. +SkinManager supports applying a theme for all controls in the form or a container by applying the theme to the form or container. So, you do not need to apply the theme for each control. {% tabs %} @@ -156,27 +160,27 @@ skinManager1.VisualTheme = VisualTheme.Office2016Black ## Apply Themes to entire application -Skin manager allows to apply theme for all the controls and forms in an application by setting the [ApplicationVisualTheme](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.SkinManager.html#Syncfusion_Windows_Forms_SkinManager_ApplicationVisualTheme) property. It allows you to theme entire application using single `ApplicationVisualTheme` property. +SkinManager allows you to apply a theme to all controls and forms in an application by setting the [ApplicationVisualTheme](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.SkinManager.html#Syncfusion_Windows_Forms_SkinManager_ApplicationVisualTheme) property. It allows you to theme the entire application using a single `ApplicationVisualTheme` property. {% tabs %} {% highlight c# %} static void Main() { - SkinManager.ApplicationVisualTheme = "Office2019Colourful"; + SkinManager.ApplicationVisualTheme = "Office2019Colorful"; Application.EnableVisualStyles(); Application.SetCompatibleTextRenderingDefault(false); Application.Run(new Form1()); } -{% endhighlight c# %} +{% endhighlight %} {% endtabs %} -N> Set the `ApplicationVisualTheme` property before main form is initialized. +N> Set the `ApplicationVisualTheme` property before the main form is initialized. ## Apply theme for individual control -Theme can be applied to individual component using skin manager or by setting the `ThemeName` property. You need to call the [LoadAssembly](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.SkinManager.html#Syncfusion_Windows_Forms_SkinManager_LoadAssembly_System_Reflection_Assembly_) method for required themes when applying using the `ThemeName` property also. +Theme can be applied to an individual control using SkinManager or by setting the `ThemeName` property. You need to call the [LoadAssembly](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.SkinManager.html#Syncfusion_Windows_Forms_SkinManager_LoadAssembly_System_Reflection_Assembly_) method for required themes when applying using the `ThemeName` property also. {% tabs %} @@ -198,13 +202,15 @@ Me.treeViewAdv1.ThemeName = "Office2019Colorful" ## Theme studio based themes -The Office2019Colorful and HighContrastBlack themes can be customized using the WinForms theme studio. Refer to the theme studio documentation to know how to create custom themes. +The Office2019Colorful and HighContrastBlack themes can be customized using the WinForms Theme Studio. Refer to the Theme Studio documentation to know how to create custom themes. + +Use `Office2019Colorful` for a colorful, modern look and `HighContrastBlack` for high-contrast accessibility scenarios. -N> Appearance customization settings done in control level will not take effect when theme studio based theme is applied. So, for customization, refer to the Style section. +N> Appearance customization settings done at the control level will not take effect when a Theme Studio based theme is applied. So, for customization, refer to the Style section. ### Change font for entire application -When using theme studio based themes, the font for entire application can be customized by setting the [CanOverrideFontFamily](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Theme.FontHelper.html#Syncfusion_WinForms_Theme_FontHelper_CanOverrideFontFamily) property to true. This property is used only in constructor. +When using Theme Studio based themes, the font for the entire application can be customized by setting the [CanOverrideFontFamily](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Theme.FontHelper.html#Syncfusion_WinForms_Theme_FontHelper_CanOverrideFontFamily) property to true. This property is used only in a constructor. {% tabs %} @@ -228,11 +234,11 @@ FontHelper.FontFamily = New FontFamily("Algerian") ### Styles -When using theme studio based themes, the appearance for each control or component can be customized using the `ThemeStyle` property. +When using Theme Studio based themes, the appearance for each control or component can be customized using the `ThemeStyle` property. N> If the control name starts with **Sf**, you can access appearance properties using the `Style` property, and for the remaining controls, use the `ThemeStyle` property. -For example, in the following code, different style of each control has been changed. +For example, in the following code, the style of each control has been changed. {% tabs %} @@ -262,9 +268,9 @@ Me.treeViewAdv1.ThemeStyle.TreeNodeAdvStyle.TextColor = System.Drawing.Color.Red ### Overriding user customization when applying theme -You can customize the appearance of control using the `Style` or `ThemeStyle` property when using theme studio based themes. Syncfusion control provides option whether theme can override style settings using the `CanOverrideStyle` property. +You can customize the appearance of a control using the `Style` or `ThemeStyle` property when using Theme Studio based themes. The Syncfusion control provides an option for whether the theme can override style settings using the `CanOverrideStyle` property. -For example, in the following code, TreeView fore color is customized, and theme is applied after that line. If you run the application, theme will not override the fore color settings since the default value of `CanOverrideStyle` is `false`. If you set the `CanOverrideStyle` property to `true` before setting the theme, then fore color setting will be overridden by theme. +For example, in the following code, the TreeView foreground color is customized, and the theme is applied after that line. If you run the application, the theme will not override the foreground color settings since the default value of `CanOverrideStyle` is `false`. If you set the `CanOverrideStyle` property to `true` before setting the theme, then the foreground color setting will be overridden by the theme. {% tabs %} @@ -286,4 +292,4 @@ Me.treeViewAdv1.ThemeStyle.TreeNodeAdvStyle.TextColor = System.Drawing.Color.Red {% endtabs %} -![WinForms Skin Manager shows Office2019 theme applied in control](skin_images/winforms-skin-manager-shows-office2019-theme.png) +![WinForms Skin Manager shows Office2019 theme applied in control](skin_images/winforms-skin-manager-shows-office2019-theme.png) \ No newline at end of file diff --git a/WindowsForms/skins/Overview.md b/WindowsForms/skins/Overview.md index 03468570c..d88bdf53d 100644 --- a/WindowsForms/skins/Overview.md +++ b/WindowsForms/skins/Overview.md @@ -24,9 +24,9 @@ This feature enables you to easily apply uniform style for all the child control ## IT scenarios -When you create an application with multiple controls, you can apply uniform color for the entire form using this feature. +When you create an application with multiple Syncfusion controls, you can apply a uniform color for the entire form using the SkinManager component. -Properties and Methods Tables for Skin Manager +## Properties and Methods Tables for Skin Manager ### Properties @@ -73,4 +73,4 @@ Overloads: 1) (Control, String) 2) (Control,VisualTheme) -
NA Void NA
+
\ No newline at end of file diff --git a/WindowsForms/theme-studio/theme-studio.md b/WindowsForms/theme-studio/theme-studio.md index ed7494c48..11e73b005 100644 --- a/WindowsForms/theme-studio/theme-studio.md +++ b/WindowsForms/theme-studio/theme-studio.md @@ -9,79 +9,81 @@ documentation: ug # Getting Started With Windows Forms Theme Studio -Theme Studio for WinForms can be used to create and apply new theme for Syncfusion® controls from an existing theme. The primary goal here is to deliver an appearance rich Syncfusion® controls that suits bests for every user application, based on their needs. +Theme Studio for WinForms can be used to create and apply a new theme for Syncfusion® controls from an existing theme. The primary goal here is to deliver appearance-rich Syncfusion® controls that best suit every user application, based on the application's needs. -## Customizing theme color from theme studio +## Customizing Theme Color in Theme Studio -In theme studio utility, each theme has a unique common variable list. When user change the common variable color code value, it will reflect in all the Syncfusion® WinForms controls. All Syncfusion® WinForms control styles are derived from these theme-based common variables. This common variable list is handled inside the theme studio application for customizing theme-based colors. +In the Theme Studio utility, each theme has a unique common variable list. When the user changes a common variable's color code value, it will reflect in all the Syncfusion® WinForms controls. All Syncfusion® WinForms control styles are derived from these theme-based common variables. -Let us now see the step-by-step procedure to launch and work with the theme studio utility below. +The following steps describe how to launch and work with the Theme Studio utility. **Step 1:** -On installing the "Syncfusion® Windows Forms" suite, launch and select "Theme Studio" from the start-up panel. +After installing the "Syncfusion® Windows Forms" suite, launch and select "Theme Studio" from the start-up panel. ![Theme Studio for Windows Forms](ThemeStudio_images/Built-In-Themes.png) **Step 2:** -The theme studio application form has been divided into two sections: the controls preview section on the right, and the theme customization section on the left. +The Theme Studio window is divided into two sections: a controls preview on the right and a theme-customization panel on the left. ![Theme Studio for Windows Forms](ThemeStudio_images/theme-studio.png) **Step 3:** -Click the color pickers in the theme customization section to select the desired color. +Click a color picker in the theme-customization section to select a color. ![Choose color in Theme Studio for Windows Forms](ThemeStudio_images/color-selected-in-theme-studio.png) **Step 4:** -The Syncfusion® WinForms controls will be rendered with the newly selected colors in the preview section, after selecting the desired color. +The Syncfusion® WinForms controls render with the newly selected colors in the preview section. ![Color reflected in controls loaded inside Theme Studio for Windows Forms](ThemeStudio_images/color-reflected-theme-studio.png) -## Export the customized theme +## Export the Customized Theme You can export the custom theme after changing the theme colors. **Step 1:** -Click the Export button in the bottom left corner of the theme studio application. +Click the Export button in the bottom left corner of the Theme Studio application. ![Export option in Theme Studio for Windows Forms](ThemeStudio_images/Export-Theme-studio.png) **Step 2:** -Now the export dialog appears with an option to select either entire controls or just the desired control(s). This option is useful when you have integrated a selective list of Syncfusion® WinForms controls in your application. The theme studio will filter only the selected controls and customize the final output for those controls alone thereby reducing the final output assembly size. +Now the export dialog appears with an option to select either all controls or just the desired control(s). This option is useful when you have integrated a selective list of Syncfusion® WinForms controls in your application. The Theme Studio will filter only the selected controls and customize the final output for those controls alone, thereby reducing the final output assembly size. ![Export dialog in Theme Studio for Windows Forms](ThemeStudio_images/Export-dialog-theme-studio.png) **Step 3:** -The download theme will come as an assembly (*.dll) file that contains color codes for the selected Syncfusion® WinForms controls. +The exported theme is delivered as an assembly (*.dll) file that contains color codes for the selected Syncfusion® WinForms controls. ![Export Theme assembly from Theme Studio for Windows Forms](ThemeStudio_images/Theme-Assembly-Theme-studio.png) -N> You can enter the assembly name of your own choice while exporting. But remember that the assembly (*.dll) name will be custom theme name, when you refer it in your WinForms application. +**Note:** You can enter the assembly name of your own choice while exporting. But remember that the assembly (*.dll) name will be the custom theme name, when you refer to it in your WinForms application. -## Using customized theme in a Windows Forms application +## Using the Customized Theme in a Windows Forms Application -You can now add the exported assembly in your Windows Forms application and set the custom theme to the appropriate controls. In this illustration, we are going to witness the custom theme set for SfDataGrid. +You can now add the exported assembly to your Windows Forms application and set the custom theme to the appropriate controls. In the following example, the custom theme is applied to the SfDataGrid control. **Step 1:** -Attach the exported assembly (*.dll) in your Windows Forms project. +Add the exported assembly (*.dll) as a reference in your Windows Forms project (for example, right-click the project in **Solution Explorer** and choose **Add** → **Reference** → **Browse**, select the exported assembly file). + +**Note:** Close Theme Studio before referencing the exported assembly file to avoid file locking errors. ![Export dialog in Theme Studio for Windows Forms](ThemeStudio_images/Export-dialog-theme-studio.png) @@ -90,7 +92,8 @@ Attach the exported assembly (*.dll) in your Windows Forms project. Load the Theme assembly in Program.cs of your application and the initialize a SfDataGrid control in the main form and set it’s "ThemeName" property exactly to the assembly name. {% tabs %} -{% highlight c# %} + +{% highlight C# %} static class Program { @@ -100,24 +103,26 @@ Load the Theme assembly in Program.cs of your application and the initialize a S [STAThread] static void Main() { - Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense(DemoCommon.FindLicenseKey()); + Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense(DemoCommon.FindLicenseKey()); SkinManager.LoadAssembly(typeof(VioletTheme).Assembly); Application.EnableVisualStyles(); Application.SetCompatibleTextRenderingDefault(false); Application.Run(new Form1()); } } - + sfDataGrid1.ThemeName = "VioletTheme"; - + {% endhighlight %} -{% highlight vb %} + +{% highlight VB %} Module Program - Private Sub Main() + Private Sub Main() Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense(DemoCommon.FindLicenseKey()) SkinManager.LoadAssembly(GetType(VioletTheme).Assembly) + Application.EnableVisualStyles() Application.SetCompatibleTextRenderingDefault(False) Application.Run(New Form1()) @@ -127,10 +132,11 @@ End Module sfDataGrid1.ThemeName = "VioletTheme" {% endhighlight %} + {% endtabs %} **Step 3:** Compile and run the Windows Forms application and you can now witness the custom theme applied to SfDataGrid control at run-time. -![Theme applied in SfDataGrid](ThemeStudio_images/Theme-applied-SfDataGrid.png) +![Theme applied in SfDataGrid](ThemeStudio_images/Theme-applied-SfDataGrid.png) \ No newline at end of file