diff --git a/WindowsForms/DataGrid/Paging.md b/WindowsForms/DataGrid/Paging.md index 73a4c939e..a78fe93c6 100644 --- a/WindowsForms/DataGrid/Paging.md +++ b/WindowsForms/DataGrid/Paging.md @@ -399,8 +399,8 @@ Follow the below steps to load the DataSource for page in on-demand, 1. Set [SfDataPager.AllowOnDemandPaging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html#Syncfusion_WinForms_DataPager_SfDataPager_AllowOnDemandPaging) as `true`. 2. Set [SfDataPager.PageCount](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html#Syncfusion_WinForms_DataPager_SfDataPager_PageCount) based on total number of records and [SfDataPager.PageSize](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Data.PagedCollectionView.html#Syncfusion_Data_PagedCollectionView_PageSize) property. -3. Use [OnDemandLoading](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html) event to load the DataSource for current page using [LoadDynamicData](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html#Syncfusion_WinForms_DataPager_SfDataPager_LoadDynamicData_System_Int32_System_Collections_IEnumerable_) method. -4. [OnDemandLoading](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html) event is raised when SfDataPager moves to another page and you can load the DataSource for corresponding page through OnDemandLoading event. +3. Use [OnDemandLoading](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html#Syncfusion_WinForms_DataPager_SfDataPager_OnDemandLoading) event to load the DataSource for current page using [LoadDynamicData](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html#Syncfusion_WinForms_DataPager_SfDataPager_LoadDynamicData_System_Int32_System_Collections_IEnumerable_) method. +4. [OnDemandLoading](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html#Syncfusion_WinForms_DataPager_SfDataPager_OnDemandLoading) event is raised when SfDataPager moves to another page and you can load the DataSource for corresponding page through OnDemandLoading event. [OnDemandLoadingEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.Events.OnDemandLoadingEventArgs.html#Syncfusion_WinForms_DataPager_Events_OnDemandLoadingEventArgs_StartRowIndex) has the following members, @@ -518,7 +518,7 @@ TryCast(sfDataPager1.PagedSource, PagedCollectionView).ResetCacheForPage(Me.sfDa {% endtabs %} ### Loading data from database in on-demand -You can read the data from database in on-demand (here, records are retrieved from Northwind data provider) in [OnDemandLoading](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html) event handler. +You can read the data from database in on-demand (here, records are retrieved from Northwind data provider) in [OnDemandLoading](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataPager.SfDataPager.html#Syncfusion_WinForms_DataPager_SfDataPager_OnDemandLoading) event handler. {% tabs %} {% highlight c# %} @@ -681,7 +681,7 @@ Here, records are filtered based on the textbox text in clicking event of Filter You can refer the [sample](https://github.com/SyncfusionExamples/how-to-change-the-PageCount-at-runtime-when-data-loaded-on-demand-is-filtered-in-winforms-datapager) from here. ### Sorting complete collection -You can sort the complete collection with on-demand paging by using [SfDataGrid.SortColumnsChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html) event. +You can sort the complete collection with on-demand paging by using [SfDataGrid.SortColumnsChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_SortColumnsChanging) event. In this event, you can sort the complete underlying collection instead of sorting current page alone by resetting the caches. {% tabs %} diff --git a/WindowsForms/Status-Bar/StatusBarAdv-Overview.md b/WindowsForms/Status-Bar/StatusBarAdv-Overview.md index 400f3519c..26eb19d07 100644 --- a/WindowsForms/Status-Bar/StatusBarAdv-Overview.md +++ b/WindowsForms/Status-Bar/StatusBarAdv-Overview.md @@ -2,7 +2,7 @@ layout: post title: About Windows Forms Status Bar control | Syncfusion description: Learn here all about introduction of Syncfusion Windows Forms Status Bar (StatusBarAdv) control, its elements and more details. -platform: WindowsForms +platform: windowsforms control: StatusBarAdv documentation: ug --- @@ -11,7 +11,7 @@ documentation: ug The various sections of StatusBarAdv and their descriptions are given below. -![Overview_img63](Overview_images/Overview_img63.jpeg) +![Windows Forms Status Bar overview.](overview_images/windows-forms-status-bar-overview.jpeg) diff --git a/WindowsForms/Status-Bar/Overview_images/Overview_img63.jpeg b/WindowsForms/Status-Bar/overview_images/windows-forms-status-bar-overview.jpeg similarity index 100% rename from WindowsForms/Status-Bar/Overview_images/Overview_img63.jpeg rename to WindowsForms/Status-Bar/overview_images/windows-forms-status-bar-overview.jpeg diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template-images/Add-syncfusion-ui.png b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Add-syncfusion-ui.png index b943a259e..ca0f6dd49 100644 Binary files a/WindowsForms/Visual-Studio-Integration/Item-Template-images/Add-syncfusion-ui.png and b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Add-syncfusion-ui.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template-images/Default-Form-with-Syncfusion-Component.png b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Default-Form-with-Syncfusion-Component.png new file mode 100644 index 000000000..ca0f6dd49 Binary files /dev/null and b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Default-Form-with-Syncfusion-Component.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template-images/Form-Change-CSharp.png b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Form-Change-CSharp.png new file mode 100644 index 000000000..d1bbe9192 Binary files /dev/null and b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Form-Change-CSharp.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template-images/Form-Change-VB.png b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Form-Change-VB.png new file mode 100644 index 000000000..8d3e283be Binary files /dev/null and b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Form-Change-VB.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template-images/Syncfusion-Form-with-Syncfusion-Component.png b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Syncfusion-Form-with-Syncfusion-Component.png new file mode 100644 index 000000000..476f37cb6 Binary files /dev/null and b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Syncfusion-Form-with-Syncfusion-Component.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template-images/Syncfusion-Form-without-Syncfusion-Components.png b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Syncfusion-Form-without-Syncfusion-Components.png new file mode 100644 index 000000000..e6495b117 Binary files /dev/null and b/WindowsForms/Visual-Studio-Integration/Item-Template-images/Syncfusion-Form-without-Syncfusion-Components.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Item-Template.md b/WindowsForms/Visual-Studio-Integration/Item-Template.md index 9b71a76a9..6d1d59646 100644 --- a/WindowsForms/Visual-Studio-Integration/Item-Template.md +++ b/WindowsForms/Visual-Studio-Integration/Item-Template.md @@ -7,9 +7,9 @@ control: Syncfusion Extensions documentation: ug --- -# Add Syncfusion Components to the WinForms Application +# Add Syncfusion components to the WinForms Application -Syncfusion supports Visual Studio Item Templates to add Syncfusion WinForms Components to a WinForms application with Syncfusion WinForms references. +Syncfusion provides robust support for Visual Studio Item Templates, which facilitate the seamless integration of Syncfusion WinForms components and preconfigured forms into your WinForms application. These templates include all necessary Syncfusion WinForms libraries, ensuring a smooth development experience. I> The Syncfusion Windows Forms item templates are available from v13.1.0.21. @@ -17,7 +17,7 @@ The following steps will guide you in adding the Syncfusion WinForms components > 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. -## Add Components using Syncfusion Item Template +## Add components using Syncfusion Item Template 1. Open a new or existing WinForms application. @@ -33,25 +33,46 @@ The following steps will guide you in adding the Syncfusion WinForms components ![Choose Add Syncfusion Item option from menu](Item-Template-images/Add-item.png) - 4. The Syncfusion WinForms Item Template wizard will be launched as follows. - ![Syncfusion WinForms Item template Components](Item-Template-images/Add-syncfusion-ui.png) + ![Syncfusion WinForms Item template components](Item-Template-images/Add-syncfusion-ui.png) + +5. Please choose one of the following scenarios to add Syncfusion Forms in your application: + + **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. + + ![Default Form with Syncfusion Component](Item-Template-images/Default-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) -5. Select the WinForms Components from the Component list within your WinForms Item Template. The features associated with the selected Component will be presented. From here, choose the specific features that are essential for your project. + **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](Item-Template-images/Syncfusion-Form-without-Syncfusion-Components.png) 6. Choose an assembly reference option such as GAC location, Essential Studio installed location, or NuGet packages to specify where the required Syncfusion assemblies are added to the project. - N> If the Syncfusion Essential WindowsForm build is installed, the Installed location and GAC options will be enabled. Without installing the Syncfusion Essential WindowsForm setup, use the NuGet option. The GAC option will not be available when using the Syncfusion WinForms Components in a .NET Core application. The Version drop-down lists the installed WinForms versions. + N> If the Syncfusion Essential WindowsForm build is installed, the Installed location and GAC options will be enabled. Without installing the Syncfusion Essential WindowsForm setup, use the NuGet option. The GAC option will not be available when using the Syncfusion WinForms components in a .NET Core application. The Version drop-down lists the installed WinForms versions. -7. Click **Add**, and a pop-up will appear providing information about adding Component **files** and **NuGet/Assemblies** details. +7. Click **Add**, and a pop-up will appear providing information about adding component **files** and **NuGet/Assemblies** details. ![Syncfusion WinForms Item template details](Item-Template-images/Add-syncfusion-item-3.png) -8. Click **OK** to incorporate the chosen Components into the WinForms application, along with the necessary Syncfusion assemblies. +8. Click **OK** to incorporate the chosen components into the WinForms application, along with the necessary Syncfusion assemblies. ![Syncfusion WinForms Item template Gallery](Item-Template-images/Add-syncfusion-item-details.png) 9. Then, Syncfusion licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio. - ![Syncfusion WinForms Item template Gallery](Item-Template-images/Syncfusion-Item-Template-Gallery-7.png) \ No newline at end of file + ![Syncfusion WinForms Item template Gallery](Item-Template-images/Syncfusion-Item-Template-Gallery-7.png) + +10. To run the application using the selected Syncfusion form, set the added Syncfusion Form as the startup form in your application. This ensures that when you launch the application, it opens with the selected Syncfusion Form. + + **For C#:** Open the **Program.cs** file in your project. Locate the line of code where the main form is being instantiated and set as the startup form. + + ![Syncfusion WinForms Item template Gallery](Item-Template-images/Form-Change-CSharp.png) + + **For VB:** Open the **Application.Designer.vb** file in your project. Locate the line of code where the main form is being instantiated and set as the startup form. + + ![Syncfusion WinForms Item template Gallery](Item-Template-images/Form-Change-VB.png) \ No newline at end of file diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-10.png b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-10.png new file mode 100644 index 000000000..148e894ee Binary files /dev/null and b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-10.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-15.png b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-15.png index d45d8eb27..a0bbcc037 100644 Binary files a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-15.png and b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-15.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-4.png b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-4.png index ead293db2..b121d9c18 100644 Binary files a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-4.png and b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-4.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-5.png b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-5.png index 136ae526e..a6801bcfa 100644 Binary files a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-5.png and b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-5.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-6.png b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-6.png index 9510f42b7..0cba23fb3 100644 Binary files a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-6.png and b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-6.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-7.png b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-7.png index eac43f3f1..8d381511f 100644 Binary files a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-7.png and b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-7.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-8.png b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-8.png index e84dacf94..ddb921261 100644 Binary files a/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-8.png and b/WindowsForms/Visual-Studio-Integration/Template-Studio-Images/WF-8.png differ diff --git a/WindowsForms/Visual-Studio-Integration/Template-Studio.md b/WindowsForms/Visual-Studio-Integration/Template-Studio.md index 4492bb37a..46970b2b4 100644 --- a/WindowsForms/Visual-Studio-Integration/Template-Studio.md +++ b/WindowsForms/Visual-Studio-Integration/Template-Studio.md @@ -48,27 +48,33 @@ Create the Syncfusion WinForms project using the Visual Studio Project Template I> Visual Basic Language support is available in WinForms Template Studio starting from version 25.1.35. -5. Navigate to the **Project type** tab and choose the Syncfusion WinForms application type you want—there are four types: Blank, MenuBar, Ribbon and Tabbed Form. Click **Next** to proceed. +5. Navigate to the **Type** tab and choose the Syncfusion WinForms application type you want. When selecting the type of template for your application, you have two options: ![Syncfusion WinForms project type selection wizard](Template-Studio-Images/WF-4.png) -6. Click **Next** or navigate to the **Pages** tab to access a list of available Syncfusion WinForms components you can add to the application. + **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. - ![Syncfusion WinForms pages selection wizard](Template-Studio-Images/WF-6.png) + ![Syncfusion WinForms Predefined template wizard](Template-Studio-Images/WF-10.png) - To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details. + **Project type:** Choose this option to select from 4 project types, including Blank, Menu Bar, Ribbon, and Tabbed Form. - N> The Control Features option is not accessible for Blank Pages. + 1. Click **Next** or navigate to the **Pages** tab to access a list of available Syncfusion WinForms components you can add to the application. -7. Click **Next** or navigate to the **Control Features** tab to view the listed features for the selected controls. From here, choose the features needed. + ![Syncfusion WinForms pages selection wizard](Template-Studio-Images/WF-6.png) - ![Syncfusion WinForms control features selection wizard](Template-Studio-Images/WF-15.png) + To unselect the added control(s), Click ‘x’ for the corresponding control in the control list from the Project Details. -8. Click **Next** or navigate the **App Features** tab to select the desired application features. + N> The Control Features option is not accessible for Blank Pages. - ![Syncfusion WinForms app features selection wizard](Template-Studio-Images/WF-7.png) + 2. Click **Next** or navigate to the **Control Features** tab to view the listed features for the selected controls. From here, choose the features needed. - N> The App Features option is not accessible for .NET Framework. + ![Syncfusion WinForms control features selection wizard](Template-Studio-Images/WF-15.png) + + 3. Click **Next** or navigate the **App Features** tab to select the desired application features. + + ![Syncfusion WinForms app features selection wizard](Template-Studio-Images/WF-7.png) + + N> The App Features option is not accessible for .NET Framework. **Project Details Section** @@ -76,13 +82,13 @@ Create the Syncfusion WinForms project using the Visual Studio Project Template ![Syncfusion WinForms project details selection and unselection wizard](Template-Studio-Images/WF-8.png) -9. Click **Create** to initiate the process. This action generates the Syncfusion WinForms application. The resulting Syncfusion WinForms app has the necessary Syncfusion NuGet packages, styles, and rendering code specific to the chosen Syncfusion component. +6. Click **Create** to initiate the process. This action generates the Syncfusion WinForms application. The resulting Syncfusion WinForms app has the necessary Syncfusion NuGet packages, styles, and rendering code specific to the chosen Syncfusion component. ![Syncfusion WinForms project created with readme](Template-Studio-Images/WF-9.png) -10. 10. The Syncfusion WinForms app is set up with the latest Syncfusion WinForms NuGet packages, including the right namespaces and rendering code. This ensures smooth integration of Syncfusion components. +7. The Syncfusion WinForms app is set up with the latest Syncfusion WinForms NuGet packages, including the right namespaces and rendering code. This ensures smooth integration of Syncfusion components. - N> The .Net 6.0, .Net 7.0, and .Net 8.0 option will be listed in Select a framework version when only the .Net 6.0, .Net 7.0, and .Net 8.0 SDK setup has been installed. + N> The .NET 6.0, .NET 7.0, and .NET 8.0 option will be listed in Select a framework version when only the .NET 6.0, .NET 7.0, and .NET 8.0 SDK setup has been installed. > .NET 6.0 version is available from v19.4.0.38 and it support from Visual Studio 2022. @@ -90,6 +96,6 @@ Create the Syncfusion WinForms project using the Visual Studio Project Template > .NET 8.0 version is available from v23.2.4 and it support from Visual Studio 2022. -11. 11. If you install the trial setup or NuGet packages from nuget.org, you must register the Syncfusion license key to your application since Syncfusion introduced the licensing system from the 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key)to generate and register the Syncfusion license key to your application. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio. +8. If you install the trial setup or NuGet packages from nuget.org, you must register the Syncfusion license key to your application since Syncfusion introduced the licensing system from the 2018 Volume 2 (v16.2.0.41) Essential Studio release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) to generate and register the Syncfusion license key to your application. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio. ![Syncfusion license registration required information dialog in Syncfusion WinForms project](Template-Studio-Images/Syncfusion-Project-Template-Gallery-8.png) \ No newline at end of file