From 08a1b7716784ba8ed9633c0debf7ca2c664b8841 Mon Sep 17 00:00:00 2001 From: Nithi-22 <90109517+Nithi-22@users.noreply.github.com> Date: Wed, 8 Jul 2026 08:56:09 +0530 Subject: [PATCH 01/36] committed --- WindowsForms/ComboBox/GettingStarted.md | 36 ++++++---- WindowsForms/ComboBox/Overview.md | 42 ++++++------ WindowsForms/ListView/GettingStarted.md | 50 +++++++++----- WindowsForms/Syntax-Editor/Getting-Started.md | 48 ++++++++------ WindowsForms/Syntax-Editor/Overview.md | 66 +++++++++---------- 5 files changed, 141 insertions(+), 101 deletions(-) diff --git a/WindowsForms/ComboBox/GettingStarted.md b/WindowsForms/ComboBox/GettingStarted.md index fcd9590d9..660b36e6c 100644 --- a/WindowsForms/ComboBox/GettingStarted.md +++ b/WindowsForms/ComboBox/GettingStarted.md @@ -8,26 +8,36 @@ documentation: ug --- # Getting Started with Windows Forms ComboBox (SfComboBox) -This section provides a quick overview for working with combo box in WinForms. +This section provides a quick overview for working with the ComboBox in WinForms. + +> **Prerequisites** +> - Visual Studio 2017 or later with the **.NET desktop development** workload installed. +> - A WinForms project that targets a .NET Framework (4.5+) or .NET (Core 3.1 / 5 / 6 / 7 / 8) version supported by your Syncfusion WinForms release. +> - Syncfusion WinForms controls installed locally, or a reference to the `Syncfusion.ComboBox.WinForms` NuGet package (see [Assembly Deployment](#assembly-deployment)). ## Assembly Deployment -Refer [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sfcombobox) section to get the list of assemblies or NuGet package needs to be added as reference to use the control in any application. +Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sfcombobox) section for the list of assemblies or NuGet package that must be referenced to use the control in any application. + +To install via NuGet Package Manager Console, run: +``` +Install-Package Syncfusion.SfListView.WinForms +``` ## Creating Application with SfComboBox control -In this walk through, user will create a WinForms application that contains SfComboBox control. +In this walkthrough, you will create a WinForms application that contains the SfComboBox control. ### Creating the Project -Create a new Windows Forms Project in Visual Studio to display the SfCombobox control. +Create a new Windows Forms project in Visual Studio to display the SfComboBox control. ### Adding Control via Designer -The SfCombobox control can be added to the application by dragging it from the toolbox and dropping it in designer. The required assembly references will be added automatically. +The SfComboBox control can be added to the application by dragging it from the toolbox and dropping it in the designer. The required assembly references will be added automatically. ![GettingStarted_img1](GettingStarted_images/GettingStarted_img1.png) ### Adding Control in Code -To add control manually, follow the steps: +To add the control manually, follow these steps: -1. Add the below required assembly references to the project, +1. Add the required assembly references below to the project. * Syncfusion.Core.WinForms @@ -38,7 +48,7 @@ To add control manually, follow the steps: * Syncfusion.SfListView.WinForms -2. Create the SfComboBox control instance and add it to the control collection of Form. +2. Create the SfComboBox control instance and add it to the control collection of the form. {% capture codesnippet1 %} {% tabs %} @@ -80,7 +90,7 @@ End Namespace ### Binding to data -To bind the SfComboBox to data, set the [SfComboBox.DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_DataSource) property to `IEnumerable` implementation. You can bind a property of the underlying data source to display for SfComboBox by using the [DisplayMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_DisplayMember) property and you can bind a property to use as the actual value for the items by using the [ValueMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_ValueMember) property. +To bind the SfComboBox to data, set the [SfComboBox.DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_DataSource) property to an `IEnumerable` implementation. You can bind a property of the underlying data source to display for SfComboBox by using the [DisplayMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_DisplayMember) property, and you can bind a property to use as the actual value for the items by using the [ValueMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_ValueMember) property. {% tabs %} {% highlight c# %} @@ -111,10 +121,12 @@ sfComboBox1.DataSource = usStates {% endhighlight %} {% endtabs %} +> When the underlying data is a primitive type such as `string` or `int`, `DisplayMember` and `ValueMember` are not required. + ![GettingStarted_img2](GettingStarted_images/GettingStarted_img2.png) ## Auto complete -Auto complete provides three different ways to display suggestions in drop-down list. +Auto complete provides three different ways to display suggestions in the drop-down list. They are, @@ -124,7 +136,7 @@ They are, * SuggestAppend: Both of these. -Auto complete can be set by using the [AutoCompleteMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_AutoCompleteMode) property. +Auto complete can be set by using the [AutoCompleteMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_AutoCompleteMode) property. Use the [AutoCompleteSuggestMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_AutoCompleteSuggestMode) property to control case sensitivity (e.g., `StartsWith`, `Contains`, `Equals`). {% tabs %} {% highlight c# %} @@ -153,6 +165,6 @@ sfComboBox1.ComboBoxMode = ComboBoxMode.MultiSelection ## Selected Items -Index of the selected item can be retrieved by using the [SelectedIndex](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_SelectedIndex) property. The value of the selected item can be retrieved by using the [SelectedValue](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_SelectedValue) property. It returns the value of the property bound to the `ValueMember` property. If the `ValueMember` is not initialized, it will return the value of the property bound to the `DisplayMember`. The selected item of the SfComboBox can be retrieved by using the [SelectedItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_SelectedItem) property. +The index of the selected item can be retrieved by using the [SelectedIndex](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_SelectedIndex) property. The value of the selected item can be retrieved by using the [SelectedValue](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_SelectedValue) property. It returns the value of the property bound to the `ValueMember` property. If the `ValueMember` is not initialized, it returns the value of the property bound to the `DisplayMember`. The selected item of the SfComboBox can be retrieved by using the [SelectedItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_SelectedItem) property. In `MultiSelection` mode, use the [SelectedItems](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_SelectedItems) collection to retrieve all selected values. N> You can also explore our [WinForms ComboBox example](https://github.com/syncfusion/winforms-demos/tree/master/sfcombobox) that shows how to allows users to type a value, choose an item, or choose multiple items using a multiselect option. \ No newline at end of file diff --git a/WindowsForms/ComboBox/Overview.md b/WindowsForms/ComboBox/Overview.md index 5816b83b2..632eb6bd7 100644 --- a/WindowsForms/ComboBox/Overview.md +++ b/WindowsForms/ComboBox/Overview.md @@ -9,51 +9,51 @@ documentation: ug # Windows Forms ComboBox (SfComboBox) Overview -[WinForms Combo box](https://www.syncfusion.com/winforms-ui-controls/combobox) is a text box component that allows user to type a value or choose an option from a list of predefined options. It has several out of the box features such as data binding, filtering, UI customization, accessibility, and more. +[WinForms ComboBox](https://www.syncfusion.com/winforms-ui-controls/combobox) is a text box component that allows a user to type a value or choose an option from a list of predefined options. It has several out-of-the-box features such as data binding, filtering, UI customization, accessibility, and more. Key features are: -* Data binding: Support to bind IEnumerable type data sources. +* Data binding: Support to bind `IEnumerable` type data sources. * Auto complete: Supports different modes of auto complete actions. -* Multi selection: Support to select multiple values from drop-down list. -* Select all items: Supports choosing all items in a multi select combo box. -* Watermark: Helps to prompt user by providing additional hints about the data that should be entered into the text box. -* Tooltip: Support to show the tooltip when selecting more values in the multi select combo box. +* Multi selection: Support to select multiple values from the drop-down list. +* Select all items: Supports choosing all items in a multi-select combo box. +* Watermark: Helps to prompt users by providing additional hints about the data that should be entered into the text box. +* Tooltip: Support to show the tooltip when selecting multiple values in the multi-select combo box. * Styling: Supports customizing styles and appearance of the SfComboBox control. -* Pop-up resizing: Supports resizing the drop-down container using a resize gripper placed at the bottom of pop-up control. -* Accessibility: Supports various accessibility features to make applications available to wide variety of users. +* Pop-up resizing: Supports resizing the drop-down container using a resize gripper placed at the bottom of the pop-up control. +* Accessibility: Supports various accessibility features to make applications available to a wide variety of users. * Theme: Supports several built-in Office 2016 themes. -## Choose between different combobox controls +## Choose between different ComboBox controls -Syncfusion WinForms suite comes up with the following different combobox: +The Syncfusion WinForms suite comes with the following ComboBox controls: * [SfComboBox](https://www.syncfusion.com/winforms-ui-controls/combobox) -* [ComboBoxAdv](https://help.syncfusion.com/windowsforms/classic/combobox/overview ) +* [ComboBoxAdv](https://help.syncfusion.com/windowsforms/classic/combobox/overview) * [MultiSelectionComboBox](https://www.syncfusion.com/winforms-ui-controls/combobox/multiselect-combobox) * [ComboBoxAutoComplete](https://help.syncfusion.com/windowsforms/classic/autocomplete/overview) -* [MultiColumnComboBox](https://www.syncfusion.com/winforms-ui-controls/multicolumn-combobox) +* [MultiColumnComboBox](https://help.syncfusion.com/windowsforms/multicolumn-combobox/overview) ### SfComboBox -The [SfComboBox](https://help.syncfusion.com/windowsforms/combobox/overview) textbox component allows the users to type a value or choose an option from a list of predefined options. It has several out of box features such as data binding filtering, UI customization, accessibility, and more. +The [SfComboBox](https://help.syncfusion.com/windowsforms/combobox/overview) textbox component allows the users to type a value or choose an option from a list of predefined options. It has several out-of-box features such as data binding, filtering, UI customization, accessibility, and more. ### ComboBoxAdv -The [ComboBoxAdv](https://help.syncfusion.com/windowsforms/classic/combobox/overview ) is an advanced combobox control that provides similar object model as the framework of the combobox control with additional features. It allows the user to select multiple items and display the default text when none of the item is selected. +The [ComboBoxAdv](https://help.syncfusion.com/windowsforms/classic/combobox/overview) is an advanced ComboBox control that provides a similar object model to the framework ComboBox control with additional features. It allows the user to select multiple items and display the default text when none of the items is selected. ### MultiSelectionComboBox -[MultiSelectionComboBox](https://help.syncfusion.com/windowsforms/classic/multiselectioncombobox/overview ) is a type of combobox control with multiple items selection and auto suggestion capabilities. When you type a character into the text area, the control performs search operation and suggest a list of possible matching results to select. +[MultiSelectionComboBox](https://help.syncfusion.com/windowsforms/classic/multiselectioncombobox/overview) is a type of ComboBox control with multiple item selection and auto-suggest capabilities. When you type a character into the text area, the control performs a search operation and suggests a list of possible matching results to select. ### ComboBoxAutoComplete -The [comboBoxAutoComplete](https://help.syncfusion.com/windowsforms/classic/autocomplete/overview ) control combines the ComboBox control with AutoComplete control for autocompletion to that instance of combobox. It can be used on a form for autocompletion of one or several edit controls (textbox and combobox). +The [ComboBoxAutoComplete](https://help.syncfusion.com/windowsforms/classic/autocomplete/overview) control combines the ComboBox control with the AutoComplete control for autocompletion within that instance of ComboBox. It can be used on a form for autocompletion of one or several edit controls (textbox and combobox). -### MultColumnComboBox +### MultiColumnComboBox -The [MultiColumnComboBox](https://help.syncfusion.com/windowsforms/multicolumn-combobox/overview ) advanced combobox control has the capability to show multiple columns in the drop-down list. You can also display headers for the multiple columns. +The [MultiColumnComboBox](https://help.syncfusion.com/windowsforms/multicolumn-combobox/overview) advanced ComboBox control has the capability to show multiple columns in the drop-down list. You can also display headers for the multiple columns. ### SfComboBox vs MultiSelectionComboBox vs ComboBoxAdv @@ -229,7 +229,7 @@ Selects {{'[multiple items](https://help.syncfusion.com/windowsforms/combobox/se Loading custom user control in dropdown -Shows the header and footer items in drop-down by enabling the {{'[ShowHeader](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_ShowHeader)'| markdownify }} and {{'[ShowFooter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_ShowFooter)'| markdownify }} properties. To learn more about loading custom user control, refer to {{'[here](https://help.syncfusion.com/windowsforms/combobox/dropdown#load-custom-control-in-drop-down)'| markdownify }}. +Shows the header and footer items in the drop-down by enabling the {{'[ShowHeader](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_ShowHeader)'| markdownify }} and {{'[ShowFooter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfComboBox.html#Syncfusion_WinForms_ListView_SfComboBox_ShowFooter)'| markdownify }} properties. To learn more about loading custom user controls, refer {{'[here](https://help.syncfusion.com/windowsforms/combobox/dropdown#load-custom-control-in-drop-down)'| markdownify }}. @@ -238,7 +238,7 @@ Shows the header and footer items in drop-down by enabling the {{'[ShowHeader](h Watermark -Sets the {{'[watermark](https://help.syncfusion.com/windowsforms/combobox/watermark )'| markdownify }} text to display hint in the editor portion when combobox has empty string. +Sets the {{'[watermark](https://help.syncfusion.com/windowsforms/combobox/watermark)'| markdownify }} text to display a hint in the editor portion when the ComboBox has an empty string. @@ -247,7 +247,7 @@ Sets the {{'[watermark](https://help.syncfusion.com/windowsforms/combobox/waterm Sorting -{{'[Sort](https://help.syncfusion.com/windowsforms/combobox/sorting )'| markdownify }} the data either in ascending or descending order using the {{'[SfComboBox.DropDownListView.View.SortDescriptors](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_SortDescriptors)'| markdownify }} property. +{{'[Sort](https://help.syncfusion.com/windowsforms/combobox/sorting)'| markdownify }} the data either in ascending or descending order using the {{'[SfComboBox.DropDownListView.View.SortDescriptors](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_SortDescriptors)'| markdownify }} property. diff --git a/WindowsForms/ListView/GettingStarted.md b/WindowsForms/ListView/GettingStarted.md index 7ac9ae3cc..769fce722 100644 --- a/WindowsForms/ListView/GettingStarted.md +++ b/WindowsForms/ListView/GettingStarted.md @@ -8,19 +8,29 @@ documentation: ug --- # Getting Started with Windows Forms ListView (SfListView) -This section provides a quick overview for getting started with SfListView for WinForms. Walk through the entire process of creating the real world SfListView. +This section provides a quick overview for getting started with SfListView for WinForms. Walk through the entire process of creating a real-world SfListView. + +> **Prerequisites** +> - Visual Studio 2017 or later with the **.NET desktop development** workload installed. +> - A WinForms project that targets a .NET Framework (4.5+) or .NET (Core 3.1 / 5 / 6 / 7 / 8) version supported by your Syncfusion WinForms release. +> - Syncfusion WinForms controls installed locally, or a reference to the `Syncfusion.ListView.WinForms` NuGet package (see [Assembly Deployment](#assembly-deployment)). ## Assembly Deployment -Refer [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sflistview) section to get the list of assemblies or NuGet package needs to be added as reference to use the control in any application. +Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sflistview) section for the list of assemblies or NuGet package that must be referenced to use the control in any application. + +To install via NuGet Package Manager Console, run: +``` +Install-Package Syncfusion.ListView.WinForms +``` ## Creating Application with SfListView control -In this walk through, user will create WinForms application that contains SfListView control. +In this walkthrough, you will create a WinForms application that contains the SfListView control. ### Creating the Project Create a new Windows Forms project in Visual Studio to display the SfListView with data objects. ### Adding Control via Designer -The SfListView control can be added to the application by dragging it from the toolbox and dropping it in designer. The required assembly references will be added automatically. +The SfListView control can be added to the application by dragging it from the toolbox and dropping it in the designer. The required assembly references will be added automatically. ![Drag and drop the SfListView control into WF application](GettingStarted_images/GettingStarted_img1.png) @@ -80,11 +90,11 @@ End Namespace {% endcapture %} {{ codesnippet1 | OrderList_Indent_Level_1 }} -### Creating data for sample application +### Creating data for the sample application -To create the data for sample application, follow the steps: +To create the data for the sample application, follow these steps: -1. Create a data object class, name it as “CountryInfo” and declare the properties. +1. Create a data object class named `CountryInfo` and declare its properties. {% capture codesnippet2 %} {% tabs %} @@ -107,7 +117,7 @@ Public Class CountryInfo {% endcapture %} {{ codesnippet2 | OrderList_Indent_Level_1 }} -2. Create a List collection initialized in GetDataSource method to add several data objects. +2. Create a `List` collection initialized in a `GetDataSource` method to add several data objects. {% capture codesnippet3 %} {% tabs %} @@ -187,8 +197,7 @@ End Function ### Binding to data To bind the SfListView to data, set the [SfListView.DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_DataSource) property to an `IEnumerable` implementation. -You can bind a property of the underlying data source to display the SfListView by using the [DisplayMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_DisplayMember) property. - +You can bind a property of the underlying data source to display the SfListView by using the [DisplayMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_DisplayMember) property. {% tabs %} {% highlight c# %} @@ -203,10 +212,10 @@ sfListView1.DisplayMember = "CountryName" {% endhighlight %} {% endtabs %} -![Date binding in WF SfListView Control](GettingStarted_images/GettingStarted_img2.png) +![Data binding in WF SfListView Control](GettingStarted_images/GettingStarted_img2.png) ## Grouping -The Windows Forms ListView (SfListView) allows displaying the items in a group by using the [SfListView.View.GroupDescriptors](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_GroupDescriptors) property. Create a [GroupDescriptor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.GroupDescriptor.html) for the property to be grouped and add it in the View.GroupDescriptors collection. +The Windows Forms ListView (SfListView) can display its items in groups by using the [SfListView.View.GroupDescriptors](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_GroupDescriptors) property. Create a [GroupDescriptor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.GroupDescriptor.html) for the property to be grouped and add it to the `View.GroupDescriptors` collection. GroupDescriptor object holds the following properties: @@ -235,7 +244,7 @@ listView.View.GroupDescriptors.Add(New GroupDescriptor() With {.PropertyName = ![Grouping in WF SfListView Control](GettingStarted_images/GettingStarted_img3.png) ## Sorting -The SfListView allows sorting on its data by using the [SfListView.View.SortDescriptors](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_SortDescriptors) property. Create a [SortDescriptor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.SortDescriptor.html) for the property to be sorted and add it into the View.SortDescriptors collection. +The SfListView allows sorting its data by using the [SfListView.View.SortDescriptors](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_SortDescriptors) property. Create a [SortDescriptor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.SortDescriptor.html) for the property to be sorted and add it to the `View.SortDescriptors` collection. SortDescriptor object holds the following three properties: @@ -263,13 +272,14 @@ listView.View.SortDescriptors.Add(New SortDescriptor() With {.PropertyName = “ ![Sorting in WF SfListView Control](GettingStarted_images/GettingStarted_img4.png) ## Filtering -The SfListView support to filter the records in view by setting predicate to the [SfListView.View.Filter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_Filter) property. Call the [View.RefreshFilter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_RefreshFilter) method after assigning the Filter property for refreshing the view. +The SfListView supports filtering the records in view by setting a predicate to the [SfListView.View.Filter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_Filter) property. Call the [View.RefreshFilter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.DataSource.DataSource.html#Syncfusion_DataSource_DataSource_RefreshFilter) method after assigning the Filter property to refresh the view. To filter the items based on the Continent property of the underlying data, follow the code example. {% tabs %} {% highlight c# %} listView.View.Filter = CustomFilter; listView.View.RefreshFilter(); + public bool CustomFilter(object obj) { if ((obj as Country).Continent == "Asia" || (obj as Country).Continent == "North America" || (obj as Country).Continent == "Oceania") @@ -291,9 +301,16 @@ public Boolean CustomFilter(Object obj) ![Filtering in WF SfListView Control](GettingStarted_images/GettingStarted_img5.png) ## Selection -SfListView selects an item by setting the [SfListView.SelectionMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectionMode) property to One, MultiSimple, MultiExtended, and None based on the requirements. Selected item information can be tracked by using the [SfListView.SelectedItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectedItem), [SfListView.SelectedIndex](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectedIndex), and [SfListView.SelectedItems](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectedItems) properties. +SfListView selects an item by setting the [SfListView.SelectionMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectionMode) property to one of `One`, `MultiSimple`, `MultiExtended`, or `None` based on the requirements. Selected item information can be tracked by using the [SfListView.SelectedItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectedItem), [SfListView.SelectedIndex](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectedIndex), and [SfListView.SelectedItems](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectedItems) properties. + +| SelectionMode | Description | +| --- | --- | +| `One` | Only a single item can be selected at a time. | +| `MultiSimple` | Multiple items can be selected without holding a modifier key. | +| `MultiExtended` | Multiple items can be selected using Ctrl/Shift. | +| `None` | Selection is disabled. | -The selection operations can be handled with the help of [SelectionChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectionChanging) and [SelectionChanged](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectionChanged) events of the SfListView. +The selection operations can be handled with the [SelectionChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectionChanging) and [SelectionChanged](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.ListView.SfListView.html#Syncfusion_WinForms_ListView_SfListView_SelectionChanged) events of the SfListView. {% tabs %} {% highlight c# %} @@ -305,3 +322,4 @@ The selection operations can be handled with the help of [SelectionChanging](htt {% endtabs %} ![Item selection in WF SfListView Control](GettingStarted_images/GettingStarted_img6.png) + diff --git a/WindowsForms/Syntax-Editor/Getting-Started.md b/WindowsForms/Syntax-Editor/Getting-Started.md index 2480c11d6..3e9c5c8ff 100644 --- a/WindowsForms/Syntax-Editor/Getting-Started.md +++ b/WindowsForms/Syntax-Editor/Getting-Started.md @@ -9,19 +9,30 @@ documentation: ug # Getting Started with Windows Forms Syntax Editor -This section explains how to create an interactive code editor application like Microsoft Visual Studio Editor by using the EditControl. +This section explains how to create an interactive code editor application like the Microsoft Visual Studio Editor by using the EditControl. + +> **Prerequisites** +> - Visual Studio 2017 or later with the **.NET desktop development** workload installed. +> - A WinForms project that targets a .NET Framework (4.5+) or .NET (Core 3.1 / 5 / 6 / 7 / 8) version supported by your Syncfusion WinForms release. +> - Syncfusion WinForms controls installed locally, or a NuGet reference to `Syncfusion.Edit.Windows` (see [Assembly Deployment](#assembly-deployment)). ## Assembly deployment -Refer to the [Control Dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#editcontrol) section to get the list of assemblies or details of NuGet package that needs to be added as reference to use the control in any application. +Refer to the [Control Dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#editcontrol) section for the list of assemblies or the NuGet package details that must be referenced to use the control in any application. + +Refer to [NuGet Packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to learn how to install NuGet packages in a Windows Forms application. -Refer to [NuGet Packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to learn how to install nuget packages in a Windows Forms application. +To install via the NuGet Package Manager Console, run: + +``` +Install-Package Syncfusion.Edit.Windows +``` ## Adding EditControl via designer 1. Create a new Windows Forms project in Visual Studio. -2. Add the [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html) to an application by dragging it from the toolbox to a designer view. The following dependent assemblies will be added automatically: +2. Add the [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html) to the application by dragging it from the toolbox to the designer surface. The following dependent assemblies are added automatically: * Syncfusion.Shared.Base * Syncfusion.Tools.Windows @@ -31,9 +42,9 @@ Refer to [NuGet Packages](https://help.syncfusion.com/windowsforms/installation/ ## Adding EditControl via code -To add the control manually in C#, follow the given steps: +To add the control manually, follow these steps: -1. Create a C# or VB application via Visual Studio. +1. Create a C# or VB.NET application in Visual Studio. 2. Add the following assembly references to the project: @@ -41,7 +52,7 @@ To add the control manually in C#, follow the given steps: * Syncfusion.Tools.Windows * Syncfusion.Edit.Windows -3. Create an instance of the [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html), and then add it to the form. +3. Create an instance of the [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html) and add it to the form. {% capture codesnippet1 %} {% tabs %} @@ -103,9 +114,9 @@ Me.Controls.Add(editControl1) ![Windows Forms showing EditControl](Getting-Started_images/Getting-Started_img3.png) -## Loading a file into document +## Loading a file into the document -This option helps to load a file into the EditControl. +This section explains how to load a file into the EditControl. {% tabs %} @@ -130,7 +141,7 @@ Me.editControl1.LoadFile(Path.GetDirectoryName(Application.ExecutablePath) + @"\ ## Syntax highlighting -The [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html) offers mostly-used languages such as C#, VB, XML, HTML, JScript, PowerShell, and SQL as built-in languages. It also provides support to configure a new custom language. +The [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html) offers built-in syntax highlighting for the most commonly used languages and also provides support for configuring a new custom language. The EditControl has built-in syntax highlighting support for the following languages: @@ -150,7 +161,7 @@ The EditControl has built-in syntax highlighting support for the following langu {% highlight C# %} -// Considering configuration settings for C# as an example. Using the [KnownLanguages](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.Enums.KnownLanguages.html) enumerator. +// Apply the built-in configuration for a known language. this.editControl1.ApplyConfiguration(KnownLanguages.CSharp); @@ -159,7 +170,7 @@ this.editControl1.ApplyConfiguration(KnownLanguages.CSharp); {% highlight VB %} -' Considering configuration settings for C# as an example. Using the [KnownLanguages](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.Enums.KnownLanguages.html) enumerator. +' Apply the built-in configuration for a known language. Me.editControl1.ApplyConfiguration(KnownLanguages.CSharp) @@ -171,9 +182,9 @@ Me.editControl1.ApplyConfiguration(KnownLanguages.CSharp) ## Custom language configuration -The EditControl provides supports custom language configuration. You can plug-in an external configuration file that defines a custom language to the EditControl using the [Configurator.Open](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html#Syncfusion_Windows_Forms_Edit_EditControl_Configurator) and [ApplyConfiguration](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html#Syncfusion_Windows_Forms_Edit_EditControl_ApplyConfiguration_Syncfusion_Windows_Forms_Edit_Enums_KnownLanguages_) functions. +The EditControl supports custom language configuration. You can plug in an external XML configuration file that defines a custom language and then apply it with the [Configurator.Open](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html#Syncfusion_Windows_Forms_Edit_EditControl_Configurator) and [ApplyConfiguration](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html#Syncfusion_Windows_Forms_Edit_EditControl_ApplyConfiguration_System_String_) methods. -1. Create a configuration file. +1. Create a configuration file (for example, `config.xml`) and set its **Copy to Output Directory** property to **Copy if newer**. {% capture codesnippet2 %} {% highlight xaml %} @@ -204,12 +215,11 @@ The EditControl provides supports custom language configuration. You can plug-in - {% endhighlight %} {% endcapture %} {{ codesnippet2 | OrderList_Indent_Level_1 }} -2. Apply the configuration file into the EditControl. +2. Apply the configuration file to the EditControl. {% capture codesnippet3 %} {% tabs %} @@ -217,7 +227,7 @@ The EditControl provides supports custom language configuration. You can plug-in private string configFile = Path.GetDirectoryName(Application.ExecutablePath) + @"\..\..\config.xml"; -// Plug-in an external configuration file. +// Plug in an external configuration file. this.editControl1.Configurator.Open(configFile); @@ -232,7 +242,7 @@ this.editControl1.ApplyConfiguration("LISP"); private string configFile = Path.GetDirectoryName(Application.ExecutablePath) + @"\..\..\config.xml"; -' Plug-in an external configuration file. +' Plug in an external configuration file. Me.editControl1.Configurator.Open(configFile) @@ -247,4 +257,4 @@ Me.editControl1.ApplyConfiguration("LISP") ![Windows Forms EditControl configured for custom language](Getting-Started_images/Getting-Started_img5.png) -N> You can refer to our [WinForms Syntax Editor](https://www.syncfusion.com/winforms-ui-controls/syntax-editor) feature tour page for its unique feature sets. You can also explore our [WinForms Syntax Editor example](https://github.com/syncfusion/winforms-demos/tree/master/edit) that shows how to create interactive code editor applications with syntax highlighting, text indentation, intellisense, etc,. \ No newline at end of file +N> You can refer to our [WinForms Syntax Editor](https://www.syncfusion.com/winforms-ui-controls/syntax-editor) feature tour page for its unique feature set. You can also explore our [WinForms Syntax Editor example](https://github.com/syncfusion/winforms-demos/tree/master/edit) that shows how to create interactive code-editor applications with syntax highlighting, text indentation, IntelliSense, and more. \ No newline at end of file diff --git a/WindowsForms/Syntax-Editor/Overview.md b/WindowsForms/Syntax-Editor/Overview.md index 92078cf20..008b27483 100644 --- a/WindowsForms/Syntax-Editor/Overview.md +++ b/WindowsForms/Syntax-Editor/Overview.md @@ -9,68 +9,68 @@ documentation: ug # Windows Forms Syntax Editor Overview -The [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html) is a powerful text editor control to create interactive code editor applications with its unique feature set. It has many efficient features such as editing, syntax highlighting, text indentation, intellisense, expand or collapse a block of code, and custom language configuration as in Microsoft Visual Studio Editor. +The [EditControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Edit.EditControl.html) is a powerful text-editor control for creating interactive code-editor applications with a rich feature set. It includes editing, syntax highlighting, text indentation, IntelliSense, expand/collapse of code blocks, and custom language configuration similar to the Microsoft Visual Studio Editor. -## Key features +## Key features -[Syntax highlighting](https://help.syncfusion.com/windowsforms/syntax-editor/syntax-highlighting) - Provides a built-in syntax highlighting and code editing experience in the most-popular languages such as C, C#, Delphi, VB, SQL, XML, HTML, Java, VBScript, JScript, PowerShell, and defined text. It also offers fully configurable syntax highlighting for general text editing purpose. +[Syntax highlighting](https://help.syncfusion.com/windowsforms/syntax-editor/syntax-highlighting) - Provides built-in syntax highlighting and a code-editing experience for popular languages such as C, C#, Delphi, VB, SQL, XML, HTML, Java, VBScript, JScript, PowerShell, and plain text. It also offers fully configurable syntax highlighting for general text editing. -[Custom language support](https://help.syncfusion.com/windowsforms/syntax-editor/syntax-highlighting#custom-language-using-xml) - Supports to user defined language configurations. Custom language configurations can be created easily and applied to the content in the EditControl. +[Custom language support](https://help.syncfusion.com/windowsforms/syntax-editor/syntax-highlighting#custom-language-using-xml) - Supports user-defined language configurations. Custom language configurations can be created easily and applied to the content of the EditControl. -[Editing support](https://help.syncfusion.com/windowsforms/syntax-editor/editing) - Allows end users to modify and edit the text documents and source code files. This includes clipboard support, unlimited undo and redo, drag and drop, block indent and outdent, and so on. +[Editing support](https://help.syncfusion.com/windowsforms/syntax-editor/editing) - Allows end users to modify and edit text documents and source-code files. This includes clipboard support, unlimited undo and redo, drag and drop, block indent and outdent, and more. -[Code outlining](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#outlining): Sections of code from the outlining blocks can be specified using the Configuration Settings. The EditControl defines different brackets for highlighting different languages. +[Code outlining](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#outlining) - Sections of code in the outlining blocks can be specified using configuration settings. The EditControl defines different brackets for highlighting different languages. -[Clipboard operations](https://help.syncfusion.com/windowsforms/syntax-editor/editing#clipboard-operations): Provides keyboard and programmatic support to Cut, Copy, and Paste. +[Clipboard operations](https://help.syncfusion.com/windowsforms/syntax-editor/editing#clipboard-operations) - Provides keyboard and programmatic support to Cut, Copy, and Paste. -[Selection mode](https://help.syncfusion.com/windowsforms/syntax-editor/editing#selection-modes): Supports normal selection and rectangular block selection to select lines from specific columns like Microsoft Visual Studio Text Editor. +[Selection mode](https://help.syncfusion.com/windowsforms/syntax-editor/editing#selection-modes) - Supports normal selection and rectangular block selection to select lines from specific columns, like the Microsoft Visual Studio text editor. -[Change tracking](https://help.syncfusion.com/windowsforms/syntax-editor/editing#line-modification-marker): Provides extensive support to track the changed lines by displaying markers at the beginning of lines after the last file save operation. +[Change tracking](https://help.syncfusion.com/windowsforms/syntax-editor/editing#line-modification-marker) - Provides extensive support to track the changed lines by displaying markers at the beginning of lines after the last file save operation. -[Line number](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#line-number): Supports to display line number at the starting position of text. +[Line number](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#line-number) - Supports displaying line numbers at the start of the text. -[Indentation support](https://help.syncfusion.com/windowsforms/syntax-editor/editing#indent-or-outdent): Supports text indent and outdent options like Microsoft Visual Studio Text Editor. +[Indentation support](https://help.syncfusion.com/windowsforms/syntax-editor/editing#indent-or-outdent) - Supports text indent and outdent options like the Microsoft Visual Studio text editor. -[Word wrap](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#word-wrap): Supports text wrapping to next line when it exceeds the control bound. +[Word wrap](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#word-wrap) - Supports wrapping text to the next line when it exceeds the control bounds. -[Auto complete](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense#auto-complete): Supports AutoComplete option predict and append the predefined data when user types. +[Auto complete](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense#auto-complete) - Supports an AutoComplete option that predicts and appends the predefined data as the user types. -[Auto correct](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense#auto-correct): Supports AutoCorrect option that automatically corrects misspellings and common typos. +[Auto correct](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense#auto-correct) - Supports an AutoCorrect option that automatically corrects misspellings and common typos. -[Fully functional Context menu](https://help.syncfusion.com/windowsforms/syntax-editor/editing#context-menu-options): Provides a built-in context menu with options to perform editing operations such as Undo, Redo, Cut, Copy, Paste, Select All, and so on. The EditControl also contains options to enable or disable the built-in context menu. +[Fully functional context menu](https://help.syncfusion.com/windowsforms/syntax-editor/editing#context-menu-options) - Provides a built-in context menu with options to perform editing operations such as Undo, Redo, Cut, Copy, Paste, Select All, and more. The EditControl also contains options to enable or disable the built-in context menu. -[Content dividers](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#content-dividers): Clearly distinguishes content sections with line dividers similar to Visual Basic to improve code readability. +[Content dividers](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#content-dividers) - Clearly distinguishes content sections with line dividers similar to Visual Basic to improve code readability. -[Intellisense](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense): Provides intellisense pop-up capabilities to add content easily like in Microsoft Visual Studio code editor. +[IntelliSense](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense) - Provides IntelliSense pop-up capabilities to add content easily, like in the Microsoft Visual Studio code editor. -[ToolTip](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense#configure-context-tooltip): Provides interactive tooltip support, which is built-in and appears automatically when the mouse pointer is placed over the collapsed block of text. +[ToolTip](https://help.syncfusion.com/windowsforms/syntax-editor/intellisense#configure-context-tooltip) - Provides interactive tooltip support that is built-in and appears automatically when the pointer is placed over a collapsed block of text. -[Highlight line](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#highlighting-current-line): Supports to highlight the line with customizable background color. +[Highlight line](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#highlighting-current-line) - Supports highlighting the current line with a customizable background color. -[Underline](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#underline): Provides an interactive support to format the text by underlining with various built-in options such as solid, dash, wave, dot lines, and so on. +[Underline](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#underline) - Provides support for formatting text by underlining with various built-in options such as solid, dash, wave, and dotted lines. -[Text navigation](https://help.syncfusion.com/windowsforms/syntax-editor/text-navigation): Provides extensive support for text navigation based on character, word, line, page, or entire document levels. +[Text navigation](https://help.syncfusion.com/windowsforms/syntax-editor/text-navigation) - Provides extensive support for text navigation based on character, word, line, page, or entire document levels. -[Bookmark and custom indicators](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#bookmark-indicators): Supports Microsoft Visual Studio text editor like bookmark and custom indicators. +[Bookmark and custom indicators](https://help.syncfusion.com/windowsforms/syntax-editor/text-visualization#bookmark-indicators) - Supports Microsoft Visual Studio text editor-style bookmarks and custom indicators. -[Search or Replace Dialog](https://help.syncfusion.com/windowsforms/syntax-editor/end-user-capability#find): Provides built-in Find and Replace dialog windows to search and highlight the desired text and replace as in Microsoft Visual Studio text editor. +[Search or Replace dialog](https://help.syncfusion.com/windowsforms/syntax-editor/end-user-capability#find) - Provides built-in Find and Replace dialog windows to search and highlight the desired text and replace it, as in the Microsoft Visual Studio text editor. -[Status bar](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#statusbar): Provides built-in status bar at the bottom of the control with different panels to display the essential information. It helps to track line, column number, caret index, and so on. +[Status bar](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#statusbar) - Provides a built-in status bar at the bottom of the control with different panels that display essential information. It helps to track line, column number, caret index, and more. -[Shortcut keys](https://help.syncfusion.com/windowsforms/syntax-editor/end-user-capability#key-binding): Provides shortcut key support for all editing and navigation operations. +[Shortcut keys](https://help.syncfusion.com/windowsforms/syntax-editor/end-user-capability#key-binding) - Provides shortcut key support for all editing and navigation operations. -[Split view](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#split-views): Provides a view-splitting function to split a single document in the EditControl into several views. +[Split view](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#split-views) - Provides a view-splitting function to split a single document in the EditControl into several views. -[Single line mode](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#single-line-mode): Supports single-line mode that is rendered just like a regular TextBox. This enables you to have a simple TextBox but with all syntax-highlighting, selection, IntelliPrompt, and other features that make SyntaxEditor great for editing code. +[Single line mode](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#single-line-mode) - Supports single-line mode that is rendered just like a regular TextBox. This enables you to have a simple TextBox but with all the syntax highlighting, selection, IntelliPrompt, and other features that make SyntaxEditor great for editing code. -[File support](https://help.syncfusion.com/windowsforms/syntax-editor/file-operation): Supports all file operations like Create New, Open, and Save. +[File support](https://help.syncfusion.com/windowsforms/syntax-editor/file-operation) - Supports file operations like Create New, Open, and Save. -[Globalization and localization](https://help.syncfusion.com/windowsforms/syntax-editor/localization): Supports complete localization to any desired language of all the dialogs and pre-defined text associated with it. +[Globalization and localization](https://help.syncfusion.com/windowsforms/syntax-editor/localization) - Supports complete localization of all the dialogs and pre-defined text to any desired language. -[Right to left](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#right-to-left-rtl-support): Supports laying out text in a left-to-right fashion that allows the control to develop forms for worldwide audiences. +[Right to left](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#right-to-left-rtl-support) - Supports laying out text in a right-to-left fashion, which allows the control to develop forms for worldwide audiences. -[Print](https://help.syncfusion.com/windowsforms/syntax-editor/printing): Supports Print option to print the loaded contents. +[Print](https://help.syncfusion.com/windowsforms/syntax-editor/printing) - Supports a Print option to print the loaded contents. -[Export](https://help.syncfusion.com/windowsforms/syntax-editor/export): Supports option to export contents in XML, RFT, and HTML formats. +[Export](https://help.syncfusion.com/windowsforms/syntax-editor/export) - Supports exporting contents to XML, RTF, and HTML formats. -[Scrolling](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#scrollbar): Provides extremely a smooth scrolling behavior even when large files are loaded in the EditControl. +[Scrolling](https://help.syncfusion.com/windowsforms/syntax-editor/appearance#scrollbar) - Provides extremely smooth scrolling behavior even when large files are loaded in the EditControl. From 0c2db713de6133833d37300e42707e33e0c98cb5 Mon Sep 17 00:00:00 2001 From: Usha4947 Date: Wed, 8 Jul 2026 10:40:00 +0530 Subject: [PATCH 02/36] Documentation(1039222): Update the UG Documentation for WinForms Controls --- WindowsForms/treeview/Appearance.md | 14 +-- WindowsForms/treeview/Data-Binding.md | 32 +++--- WindowsForms/treeview/Drag-And-Drop.md | 50 +++++---- WindowsForms/treeview/Editing.md | 100 ++++++++++-------- WindowsForms/treeview/Find-And-Replace.md | 32 +++--- WindowsForms/treeview/Getting-Started.md | 16 +-- WindowsForms/treeview/Overview.md | 26 +++-- WindowsForms/treeview/Performance.md | 10 +- WindowsForms/treeview/RunTime-Features.md | 64 ++++++----- WindowsForms/treeview/Save-And-Load-XML.md | 58 ++++++---- WindowsForms/treeview/Sorting.md | 14 +-- .../treeview/TreeNodeAdvCustomization.md | 18 ++-- WindowsForms/treeview/TreeView-Appearance.md | 57 ++++++---- WindowsForms/treeview/TreeViewAdv-Events.md | 24 ++--- WindowsForms/treeview/search-functionality.md | 20 ++-- 15 files changed, 304 insertions(+), 231 deletions(-) diff --git a/WindowsForms/treeview/Appearance.md b/WindowsForms/treeview/Appearance.md index be0f45841..968479066 100644 --- a/WindowsForms/treeview/Appearance.md +++ b/WindowsForms/treeview/Appearance.md @@ -20,15 +20,15 @@ BorderStyle Property has the following styles * None - If the BorderStyle set as none, border of TreeViewAdv will be collapsed + If the BorderStyle is set as `None`, the border of the TreeViewAdv will be collapsed. * FixedSingle (For 2D) - If the BorderStyle set as FixedSingle , then the border of the TreeViewAdv will be visible and we can customize the border + If the BorderStyle is set as `FixedSingle`, then the border of the TreeViewAdv will be visible and can be customized. * Fixed3D (Default) - If the BorderStyle set as Fixed3D, then the border of the TreeViewAdv will be visible in 3D and we can customize the border settings + If the BorderStyle is set as `Fixed3D`, then the border of the TreeViewAdv will be visible in 3D and the border settings can be customized. ### BorderSingle @@ -93,8 +93,8 @@ It has the following Styles >NOTE > ->The settings will have applied only when TreeViewAdv.BorderStyle property is set to FixedSingle or Fixed3D. -To customize the 2D border of TreeViewAdv, set the below properties as follows. +>The settings will be applied only when the TreeViewAdv.BorderStyle property is set to FixedSingle or Fixed3D. +To customize the 2D border of the TreeViewAdv, set the below properties as follows. Property Table @@ -286,7 +286,7 @@ Fore Color for the selected node when control loses focus can be set using Inact >NOTE: > ->The settings will have applied only when TreeViewAdv.HideSelection property should be set to false. +>These settings will be applied only when the TreeViewAdv.HideSelection property is set to false. {% tabs %} @@ -387,7 +387,7 @@ this.treeViewAdv1.Office2010ColorScheme = Syncfusion.Windows.Forms.Office2010The {% highlight vb %} Me.treeViewAdv1.Style = TreeStyle.Office2010 -Me.treeViewAdv1.Office2007ColorScheme = Syncfusion.Windows.Forms.Office2010Theme.Silver +Me.treeViewAdv1.Office2010ColorScheme = Syncfusion.Windows.Forms.Office2010Theme.Silver {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/treeview/Data-Binding.md b/WindowsForms/treeview/Data-Binding.md index e8cd7c300..7a8db851f 100644 --- a/WindowsForms/treeview/Data-Binding.md +++ b/WindowsForms/treeview/Data-Binding.md @@ -18,7 +18,7 @@ The following are the ways to bind various data sources to [TreeViewAdv](https:/ ## Binding to Self-Referencing Data In this type, [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) binds to self-referencing data where the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) is bound to single table instead of multiple related tables. -Parent-Child relationship for all the records is defined by setting the [ParentMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_ParentMember) and [ChildMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_ChildMember) properties to the respective fields in the data source. If the Parent ID of one record has the respective value in the Child ID of any other records from the table, then that record is considered to have parent. If not, then the record is considered to have no parents and, in such case, it won’t be visible in the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html). +Parent-Child relationship for all the records is defined by setting the [ParentMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_ParentMember) and [ChildMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_ChildMember) properties to the respective fields in the data source. If the Parent ID of one record has the respective value in the Child ID of any other record from the table, then that record is considered to have a parent. If not, then the record is considered to have no parent and, in such case, it will not be visible in the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html). If the value in [ParentMember](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_ParentMember) field of some records matches with the [TreeViewAdv.SelfRelationRootValue](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_SelfRelationRootValue), then those records are considered as root nodes of [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html). @@ -93,9 +93,9 @@ treeViewAdv1.DataSource = Table_1 {% endhighlight %} {% endtabs %} -N> -1) Root nodes are parent less (for example, see **"North America"** node in the image above). All root nodes must have their parent member values **(TreeViewAdv.ParentMember)** set to **TreeViewAdv.SelfRelationRootValue**property. If the property is not specified then, you may notice empty TreeViewAdv. So, to avoid this, we suggest that you always set parent member values with TreeViewAdv.SelfRelationRootValue for root nodes. -2) You must specify **TreeViewAdv.DisplayMember**, **TreeViewAdv.ParentMember**, **TreeViewAdv.ChildMember** properties mandatorily to populate the appropriate TreeViewAdv. +N> +1) Root nodes are parentless (for example, see the **"North America"** node in the image above). All root nodes must have their parent member values (**TreeViewAdv.ParentMember**) set to the **TreeViewAdv.SelfRelationRootValue** property. If the property is not specified, you may notice an empty TreeViewAdv. To avoid this, we recommend that you always set the parent member values to TreeViewAdv.SelfRelationRootValue for root nodes. +2) You must specify the **TreeViewAdv.DisplayMember**, **TreeViewAdv.ParentMember**, and **TreeViewAdv.ChildMember** properties to populate the TreeViewAdv. ## Binding to Data Relations In this type, [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) are bound to database where levels are created using [DataRelation](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_DataRelations) class. Each [DataRelation](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_DataRelations) class object describes the parent data being bound to, the child data being bound to and the data columns used to populate **Text** and selected **Value** properties of the nodes. @@ -119,7 +119,7 @@ Syncfusion.Windows.Forms.Tools.DataRelation childRelation3; childRelation1 = new Syncfusion.Windows.Forms.Tools.DataRelation(Table_2, "Table_2", "SubFolderName1", "ChildFolder", "SubFolderChild1", "SubFolderName1", "Checked"); -childRelation2 = new Syncfusion.Windows.Forms.Tools.DataRelation(Table_3, "SubFolderName2", "SubFolderChild1", "SubFolderChild2"); +childRelation2 = new Syncfusion.Windows.Forms.Tools.DataRelation(Table_3, "Table_3", "SubFolderName2", "SubFolderChild1", "SubFolderChild2"); childRelation3 = new Syncfusion.Windows.Forms.Tools.DataRelation(Table_4, "Table_4", "SubFolderName3", "SubFolderChild2", "SubFolderChild3", "SubFolderName3", "Checked"); @@ -133,7 +133,7 @@ treeViewAdv1.DataRelations.Add(childRelation1); treeViewAdv1.DataRelations.Add(childRelation2); treeViewAdv1.DataRelations.Add(childRelation3); -treeViewAdv1.DataSource = Table_1; +treeViewAdv1.DataSource = Table_1; {% endhighlight %} {% highlight vb %} @@ -142,13 +142,11 @@ Dim childRelation1 As Syncfusion.Windows.Forms.Tools.DataRelation Dim childRelation2 As Syncfusion.Windows.Forms.Tools.DataRelation Dim childRelation3 As Syncfusion.Windows.Forms.Tools.DataRelation -childRelation1 = New Syncfusion.Windows.Forms.Tools.DataRelation(Table_2, "SubFolder1", "SubFolderName1", "FolderChild", "SubFolderChild1", "SubFolderName1", "Checked") - -childRelation2 = New Syncfusion.Windows.Forms.Tools.DataRelation(Table_3, "SubFolderName2", "SubFolderChild1", "SubFolderChild2") +childRelation1 = New Syncfusion.Windows.Forms.Tools.DataRelation(Table_2, "Table_2", "SubFolderName1", "ChildFolder", "SubFolderChild1", "SubFolderName1", "Checked") -childRelation3 = New Syncfusion.Windows.Forms.Tools.DataRelation(Table_4, "SubFolder3", "SubFolderName3", "SubFolderChild2", "SubFolderChild3", "SubFolderName3", "Checked") +childRelation2 = New Syncfusion.Windows.Forms.Tools.DataRelation(Table_3, "Table_3", "SubFolderName2", "SubFolderChild1", "SubFolderChild2") -treeViewAdv1.DataRelations.Clear() +childRelation3 = New Syncfusion.Windows.Forms.Tools.DataRelation(Table_4, "Table_4", "SubFolderName3", "SubFolderChild2", "SubFolderChild3", "SubFolderName3", "Checked") treeViewAdv1.DisplayMember = "FolderName" treeViewAdv1.ParentMember = "ParentFolder" @@ -196,15 +194,17 @@ State -> Third level. +N> `ChildMember` and `DisplayMember` use a backslash-separated hierarchy path. In C# the backslash must be escaped (`\\`), while VB.NET uses a single backslash (`\`). + {% tabs %} {% highlight c# %} -treeViewAdv1.DisplayMember = "ContinentName\\CountryName\\StateName"; +treeViewAdv1.DisplayMember = "ContinentName\\CountryName\\StateName"; treeViewAdv1.ChildMember = "Continent\\Country\\State"; {% endhighlight %} {% highlight vb %} -treeViewAdv1.DisplayMember = "ContinentName\\CountryName\\StateName" -treeViewAdv1.ChildMember = "Continent\\Country\\State" +treeViewAdv1.DisplayMember = "ContinentName\CountryName\StateName" +treeViewAdv1.ChildMember = "Continent\Country\State" {% endhighlight %} {% endtabs %} @@ -221,7 +221,9 @@ The [`TreeViewAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windo ### Importing Microsoft Access Database -To load the data from Microsoft Access database, follow the below steps. +N> Prerequisite: The Microsoft Access Database Engine 2010 (or later) Redistributable must be installed on the development machine so that the **.NET Framework Data Provider for OLE DB** can list the **Microsoft Office Access Database Engine OLE DB Provider**. + +To load the data from a Microsoft Access database, follow the steps below. 1) On the **View** menu, select **Other Windows > Data Sources**. diff --git a/WindowsForms/treeview/Drag-And-Drop.md b/WindowsForms/treeview/Drag-And-Drop.md index b4525bd9b..69c086b77 100644 --- a/WindowsForms/treeview/Drag-And-Drop.md +++ b/WindowsForms/treeview/Drag-And-Drop.md @@ -94,7 +94,11 @@ private void treeViewAdv_ItemDrag(object sender, System.Windows.Forms.ItemDragEv e.Effect = DragDropEffects.None; Point pt = this.treeViewAdv1.PointToClient(new Point(e.X, e.Y)); this.treeViewAdv1.SelectedNode = this.treeViewAdv1.GetNodeAtPoint(pt); - Console.WriteLine(this.treeViewAdv1.SelectedNode.Text); + // Guard against null when the cursor is over the empty area of the tree. + if (this.treeViewAdv1.SelectedNode != null) + { + Console.WriteLine(this.treeViewAdv1.SelectedNode.Text); + } } private void treeViewAdv_DragDrop(object sender, System.Windows.Forms.DragEventArgs e) { @@ -120,32 +124,35 @@ private void treeViewAdv_ItemDrag(object sender, System.Windows.Forms.ItemDragEv e.Action = DragAction.Cancel; } } - private void treeViewAdv_DragEnter(object sender, System.Windows.Forms.DragEventArgs e) + private void treeViewAdv_DragEnter(object sender, System.Windows.Forms.DragEventArgs e) { -// Reset the label text. + // Reset the label text. DropLocationLabel.Text = "None"; } + + // Note: The following event and field declarations should be placed at the class level, + // not inside a method body. They are shown here inline for documentation purposes only. public event GiveFeedbackEventHandler GiveFeedback; private System.Windows.Forms.CheckBox UseCustomCursorsCheck; private Cursor MyNoDropCursor; private Cursor MyNormalCursor; - private void treeViewAdv_GiveFeedback(object sender, System.Windows.Forms.GiveFeedbackEventArgs e) + private void treeViewAdv_GiveFeedback(object sender, System.Windows.Forms.GiveFeedbackEventArgs e) { -// Use custom cursors if the check box is checked. - if (UseCustomCursorsCheck.Checked) + // Use custom cursors if the check box is checked. + if (UseCustomCursorsCheck.Checked) { MyNormalCursor = new Cursor("3dwarro.cur"); MyNoDropCursor = new Cursor("3dwno.cur"); if (MyNormalCursor != null) - MyNormalCursor.Dispose(); + MyNormalCursor.Dispose(); if (MyNoDropCursor != null) - MyNoDropCursor.Dispose(); -// Sets the custom cursor based upon the effect. - e.UseDefaultCursors = false; - if ((e.Effect & DragDropEffects.Move) == DragDropEffects.Move) - Cursor.Current = MyNormalCursor; - else - Cursor.Current = MyNoDropCursor; + MyNoDropCursor.Dispose(); + // Sets the custom cursor based upon the effect. + e.UseDefaultCursors = false; + if ((e.Effect & DragDropEffects.Move) == DragDropEffects.Move) + Cursor.Current = MyNormalCursor; + else + Cursor.Current = MyNoDropCursor; } } @@ -195,7 +202,10 @@ e.Effect = DragDropEffects.None End If Dim pt As Point = Me.treeViewAdv1.PointToClient(New Point(e.X, e.Y)) Me.treeViewAdv1.SelectedNode = Me.treeViewAdv1.GetNodeAtPoint(pt) -Console.WriteLine(Me.treeViewAdv1.SelectedNode.Text) +' Guard against null when the cursor is over the empty area of the tree. +If Me.treeViewAdv1.SelectedNode IsNot Nothing Then + Console.WriteLine(Me.treeViewAdv1.SelectedNode.Text) +End If End Sub Private Sub treeViewAdv_DragDrop(ByVal sender As Object, ByVal e As System.Windows.Forms.DragEventArgs) Dim treeView As TreeViewAdv = CType(IIf(TypeOf sender Is TreeViewAdv, sender, Nothing), TreeViewAdv) @@ -208,7 +218,7 @@ sourceNode.Move(destinationNode, NodePositions.Next) Me.currentSourceNode = Nothing treeView.SelectedNode = sourceNode End Sub -Private Sub treeViewAdv_DragEnter(ByVal sender As Object, ByVal e As DragEventArgs) Handles ListDragTarget.DragEnter +Private Sub treeViewAdv_DragEnter(ByVal sender As Object, ByVal e As DragEventArgs) Handles treeViewAdv1.DragEnter ' Reset the label text. DropLocationLabel.Text = "None" @@ -226,10 +236,10 @@ e.Action = DragAction.Cancel End If End Sub Public Event GiveFeedback As GiveFeedbackEventHandler -Friend WithEvents UseCustomCursorsCheck As System.Windows.Forms.CheckBox -Private MyNoDropCursor As Cursor -Private MyNormalCursor As Cursor -Private Sub treeViewAdv_GiveFeedback(ByVal sender As Object, ByVal e As GiveFeedbackEventArgs) Handles ListDragSource.GiveFeedback +Friend WithEvents UseCustomCursorsCheck As System.Windows.Forms.CheckBox +Private MyNoDropCursor As Cursor +Private MyNormalCursor As Cursor +Private Sub treeViewAdv_GiveFeedback(ByVal sender As Object, ByVal e As GiveFeedbackEventArgs) Handles treeViewAdv1.GiveFeedback ' Use custom cursors if the check box is checked. If (UseCustomCursorsCheck.Checked) Then diff --git a/WindowsForms/treeview/Editing.md b/WindowsForms/treeview/Editing.md index a921742ad..8b51a99c1 100644 --- a/WindowsForms/treeview/Editing.md +++ b/WindowsForms/treeview/Editing.md @@ -15,26 +15,32 @@ For example, while we set the same data source object for two different controls {% tabs %} {% highlight c# %} - // Initialize data sources +// Initialize data sources treeViewAdv1.DataSource = Table_1; gridGroupingControl1.DataSource = Table_1; - // Addition + // Counter used while generating new IDs for added rows. + int count = 0; + + // Addition DataTable dt = (this.treeViewAdv1.DataSource as DataTable); if (treeViewAdv1.SelectedItem != null) - dt.Rows.Add("New Item", "10" + count.ToString(), (treeViewAdv1.SelectedItem as DataRow)[treeViewAdv1.ChildMember].ToString(), "New", false); + { + dt.Rows.Add("New Item", "10" + count.ToString(), (treeViewAdv1.SelectedItem as DataRow)[treeViewAdv1.ChildMember].ToString(), "New", false); + count++; + } if (dt != null) dt.AcceptChanges(); // Deletion -(treeViewAdv1.DataSource as DataTable).AcceptChanges(); + (treeViewAdv1.DataSource as DataTable).AcceptChanges(); -if (this.treeViewAdv1.SelectedItem != null) -{ - (treeViewAdv1.SelectedItem as DataRow).Delete(); -} + if (this.treeViewAdv1.SelectedItem != null) + { + (treeViewAdv1.SelectedItem as DataRow).Delete(); + } {% endhighlight %} {% highlight vb %} @@ -42,11 +48,15 @@ if (this.treeViewAdv1.SelectedItem != null) treeViewAdv1.DataSource = Table_1 gridGroupingControl1.DataSource = Table_1 -' Addition +' Counter used while generating new IDs for added rows. + Dim count As Integer = 0 + +' Addition Dim dt As DataTable = (TryCast(Me.treeViewAdv1.DataSource, DataTable)) If treeViewAdv1.SelectedItem IsNot Nothing Then dt.Rows.Add("New Item", "10" & count.ToString(), (TryCast(treeViewAdv1.SelectedItem, DataRow))(treeViewAdv1.ChildMember).ToString(), "New", False) + count += 1 End If If dt IsNot Nothing Then @@ -57,7 +67,7 @@ End If TryCast(treeViewAdv1.DataSource, DataTable).AcceptChanges() If Me.treeViewAdv1.SelectedItem IsNot Nothing Then - TryCast(treeViewAdv1.SelectedItem, DataRow).Delete() + TryCast(treeViewAdv1.SelectedItem, DataRow).Delete() End If {% endhighlight %} {% endtabs %} @@ -71,21 +81,21 @@ Self-Referencing In this type, you can do insert, delete, edit, drag and drop operations. -2Data RelationsIn this type, you can do insert, delete, edit, drag and drop operations. Meanwhile when trying to insert new record in new level is not allowed. Here levels are created using DataRelation, so if you want to dynamically add new level then you need to create new instance of DataRelation and add it to TreeViewAdv.DataRelations property with proper relation first. +2Data RelationsYou can perform insert, delete, edit, and drag-and-drop operations. Inserting a new record into a new level is not allowed because levels are created using DataRelation. To dynamically add a new level, you must create a new instance of DataRelation and add it to the TreeViewAdv.DataRelations property with the proper relation. -3Object-RelationalIn this type, you can do insert, delete, edit, drag and drop operation. Meanwhile when trying to insert new record in new level is not allowed. Because levels are created based on number of classes specified in ChildMember. Editing operation can be performed within the number of classes defined and not beyond that. +3Object-RelationalYou can perform insert, delete, edit, and drag-and-drop operations. Inserting a new record into a new level is not allowed because levels are based on the number of classes specified in ChildMember. Editing is limited to the number of classes defined and cannot go beyond that. -N> -1. For all the types, in order to allow editing in TreeViewAdv control, TreeViewAdv.LabelEdit property and AllowDrop property must be enabled in TreeViewAdv. -2. For Self-referencing and Data relation type, you need to call AcceptChanges() after adding new rows and before deleting the existing rows to allow the dynamic updates in TreeViewAdv. +N> +1. For all binding types, the `TreeViewAdv.LabelEdit` property and the `AllowDrop` property must be enabled on the TreeViewAdv in order to allow editing. +2. For Self-referencing and Data Relation binding types, you need to call `AcceptChanges()` after adding new rows and before deleting the existing rows to allow dynamic updates in the TreeViewAdv. ## Editing Object-Relational View -In this type, you can insert, delete, edit and drag drop the new or existing data. Custom objects must be implemented either with **INotifyPropertyChanged** or **INotifyCollectionChanged** interface, so that TreeViewAdv will automatically refresh the UI when any item gets changed, added, removed or the list gets cleared. +In this type, you can insert, delete, edit, and drag-and-drop the new or existing data. Custom objects must be implemented with either the **INotifyPropertyChanged** or **INotifyCollectionChanged** interface so that the TreeViewAdv automatically refreshes the UI when any item is changed, added, removed, or the list is cleared. ![Object-RelationalView](Editing_images/Object-RelationalView.png) @@ -93,15 +103,17 @@ In this type, you can insert, delete, edit and drag drop the new or existing dat **Example** {% tabs %} {% highlight c# %} +using System.ComponentModel; + public class Form1 : Form { // Initialize data sources treeViewAdv1.DataSource = continentList; - gridGroupingControl1.DataSource = continentList; + gridGroupingControl1.DataSource = continentList; treeViewAdv1.DisplayMember = "ContinentName\\CountryName\\StateName"; - treeViewAdv1.ChildMember = "Continent\\Country\\State"; - + treeViewAdv1.ChildMember = "Continent\\Country\\State"; + } public class NotifyPropertyChanged : INotifyPropertyChanged @@ -117,56 +129,56 @@ public class NotifyPropertyChanged : INotifyPropertyChanged public class Continent : NotifyPropertyChanged { - + } public class Country : NotifyPropertyChanged { - + } public class State: NotifyPropertyChanged { - + } - + {% endhighlight %} {% highlight vb %} Public Class Form1 - Inherits Form - ' Initialize data sources + Inherits Form + ' Initialize data sources - treeViewAdv1.DisplayMember = "ContinentName\\CountryName\\StateName" - treeViewAdv1.ChildMember = "Continent\\Country\\State" + treeViewAdv1.DisplayMember = "ContinentName\CountryName\StateName" + treeViewAdv1.ChildMember = "Continent\Country\State" - treeViewAdv1.DataSource = continentList - gridGroupingControl1.DataSource = continentList + treeViewAdv1.DataSource = continentList + gridGroupingControl1.DataSource = continentList End Class - Public Class NotifyPropertyChanged` - Implements INotifyPropertyChanged + Public Class NotifyPropertyChanged + Implements INotifyPropertyChanged - Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged - Public Sub RaisePropertyChanged(ByVal name As String) - RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(name)) + Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged + Public Sub RaisePropertyChanged(ByVal name As String) + RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(name)) - End Sub + End Sub End Class - Public Class Continent - Inherits NotifyPropertyChanged + Public Class Continent + Inherits NotifyPropertyChanged - End Class + End Class - Public Class Country - Inherits NotifyPropertyChanged + Public Class Country + Inherits NotifyPropertyChanged - End Class + End Class - Public Class State - Inherits NotifyPropertyChanged + Public Class State + Inherits NotifyPropertyChanged - End Class + End Class {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/treeview/Find-And-Replace.md b/WindowsForms/treeview/Find-And-Replace.md index 01dd8c071..8da1e0c7d 100644 --- a/WindowsForms/treeview/Find-And-Replace.md +++ b/WindowsForms/treeview/Find-And-Replace.md @@ -103,7 +103,7 @@ This enables users to disable highlighting matched TreeNodeAdv. {% tabs %} {% highlight c# %} -Void treeViewAdv1_OnNodeBeforeFind(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvBeforeFindArgs e) +void treeViewAdv1_BeforeNodeFind(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvBeforeFindArgs e) { // This will return the matched TreeNodeAdv. @@ -120,7 +120,7 @@ Void treeViewAdv1_OnNodeBeforeFind(object sender, Syncfusion.Windows.Forms.Tools {% highlight vb %} -Private Sub treeViewAdv1_OnNodeBeforeFind(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvBeforeFindArgs) +Private Sub treeViewAdv1_BeforeNodeFind(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvBeforeFindArgs) ' This will return the matched TreeNodeAdv. Dim matchedNode As TreeNodeAdv = e.Node @@ -164,7 +164,7 @@ This will return the search string to be highlighted in TreeNodeAdv. {% tabs %} {% highlight c# %} -void treeViewAdv1_OnNodeAfterFound(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvAfterFindArgs e) +void treeViewAdv1_AfterNodeFind(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvAfterFindArgs e) { // This will return matched TreeNodeAdv. @@ -178,7 +178,7 @@ void treeViewAdv1_OnNodeAfterFound(object sender, Syncfusion.Windows.Forms.Tools {% highlight vb %} -Private Sub treeViewAdv1_OnNodeAfterFound(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvAfterFindArgs) +Private Sub treeViewAdv1_AfterNodeFind(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvAfterFindArgs) ' This will return the matched TreeNodeAdv. Dim matchedNode As TreeNodeAdv = e.Node @@ -234,7 +234,7 @@ This will enable users to disable replacing matched TreeNodeAdv text. {% tabs %} {% highlight c# %} -void treeViewAdv1_OnNodeReplacing(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacingArgs e) +void treeViewAdv1_BeforeReplaceNode(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacingArgs e) { // This will return the replaced TreeNodeAdv. @@ -260,7 +260,7 @@ void treeViewAdv1_OnNodeReplacing(object sender, Syncfusion.Windows.Forms.Tools. {% highlight vb %} -Private Sub treeViewAdv1_OnNodeReplacing(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvOnReplacingArgs) +Private Sub treeViewAdv1_BeforeReplaceNode(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacingArgs) ' This will return the replaced TreeNodeAdv. Dim replaceNode As TreeNodeAdv = e.Node @@ -316,7 +316,7 @@ This will return TreeNodeAdv text that has been replaced. {% tabs %} {% highlight c# %} -void treeViewAdv1_OnNodeReplaced(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacedArgs e) +void treeViewAdv1_AfterReplaceNode(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacedArgs e) { // This will return the replaced TreeNodeAdv. @@ -333,7 +333,7 @@ void treeViewAdv1_OnNodeReplaced(object sender, Syncfusion.Windows.Forms.Tools.T {% highlight vb %} -Private Sub treeViewAdv1_OnNodeReplaced(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvOnReplacedArgs) +Private Sub treeViewAdv1_AfterReplaceNode(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacedArgs) ' This will return Replaced TreeNodeAdv Dim replacedNode As TreeNodeAdv = e.Node @@ -426,21 +426,19 @@ Gets or sets a value indicating whether the key event should be passed on to the The nodes can be added to the TreeViewAdv when any key is pressed, whereby the text of the node reflects the key that has been used for adding the node, by using the following code in the TreeViewAdv KeyDown event handler. -#### Border Settings - {% tabs %} {% highlight c# %} // Setting the key data to the newly added node. // Add the nodes to the selected node. -private void treeViewAdv1_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e) -{ - // Setting the key data to the newly added node. - TreeNodeAdv node=new TreeNodeAdv("Node"+" "+e.KeyData.ToString()); +private void treeViewAdv1_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e) +{ + // Setting the key data to the newly added node. + TreeNodeAdv node = new TreeNodeAdv("Node" + " " + e.KeyData.ToString()); -// Add the nodes to the selected node. - this.treeViewAdv1.SelectedNode.Nodes.Add(node); - Console.WriteLine("The "+node.Text+" "+"is added"); + // Add the nodes to the selected node. + this.treeViewAdv1.SelectedNode.Nodes.Add(node); + Console.WriteLine("The " + node.Text + " " + "is added"); } {% endhighlight %} diff --git a/WindowsForms/treeview/Getting-Started.md b/WindowsForms/treeview/Getting-Started.md index 84c9b360c..9fdd11a85 100644 --- a/WindowsForms/treeview/Getting-Started.md +++ b/WindowsForms/treeview/Getting-Started.md @@ -33,9 +33,9 @@ Create new Windows Forms Project in Visual Studio to display [TreeViewAdv](https In order to add control manually, do the below steps, -1.Add the required [assembly references](https://help.syncfusion.com/windowsforms/control-dependencies#treeviewadv) to the project. +1. Add the required [assembly references](https://help.syncfusion.com/windowsforms/control-dependencies#treeviewadv) to the project. -2.Create the `TreeViewAdv` control instance and add it to the Form. +2. Create the `TreeViewAdv` control instance and add it to the Form. {% tabs %} {% highlight c# %} @@ -50,7 +50,7 @@ namespace WindowsFormsApplication1 public Form1() { InitializeComponent(); - //Intialize new instance of TreeViewAdv + //Initialize new instance of TreeViewAdv TreeViewAdv treeviewadv1 = new TreeViewAdv(); treeviewadv1.Location = new System.Drawing.Point(85, 108); treeviewadv1.Size = new System.Drawing.Size(240, 150); @@ -63,7 +63,7 @@ namespace WindowsFormsApplication1 'Adding Namespace for TreeViewAdv control -Imports using Syncfusion.Windows.Forms.Tools +Imports Syncfusion.Windows.Forms.Tools Namespace WindowsFormsApp4 Public Partial Class Form1 @@ -71,7 +71,7 @@ Namespace WindowsFormsApp4 Public Sub New() InitializeComponent() - 'Intialize new instance of TreeViewAdv + 'Initialize new instance of TreeViewAdv Dim treeviewadv1 As TreeViewAdv = New TreeViewAdv() treeviewadv1.Location = New System.Drawing.Point(85, 108) treeviewadv1.Size = New System.Drawing.Size(240, 150) @@ -141,7 +141,7 @@ namespace WindowsFormsApp4 { InitializeComponent(); - //Intialize new instance of TreeViewAdv + //Initialize new instance of TreeViewAdv treeView1 = new Syncfusion.Windows.Forms.Tools.TreeViewAdv(); treeView1.Location = new System.Drawing.Point(202, 75); treeView1.Name = "treeView1"; @@ -202,7 +202,7 @@ namespace WindowsFormsApp4 'Adding Namespace for TreeViewAdv control -Imports using Syncfusion.Windows.Forms.Tools +Imports Syncfusion.Windows.Forms.Tools Namespace WindowsFormsApp4 Public Partial Class Form1 @@ -213,7 +213,7 @@ Namespace WindowsFormsApp4 Public Sub New() InitializeComponent() - 'Intialize new instance of TreeViewAdv. + 'Initialize new instance of TreeViewAdv. treeView1 = New Syncfusion.Windows.Forms.Tools.TreeViewAdv() treeView1.Location = New System.Drawing.Point(202, 75) treeView1.Name = "treeView1" diff --git a/WindowsForms/treeview/Overview.md b/WindowsForms/treeview/Overview.md index bdb829fcb..f8b9c454b 100644 --- a/WindowsForms/treeview/Overview.md +++ b/WindowsForms/treeview/Overview.md @@ -9,30 +9,34 @@ documentation: ug # Windows Forms TreeView Overview -[WinForms TreeView control](https://www.syncfusion.com/winforms-ui-controls/treeview) displays a collection of data in hierarchical tree structure and the data in tree view can be expanded and collapsed. [TreeViewAdv](https://help.syncfusion.com/windowsforms/treeview/overview) offers many advanced features like drag-and-drop, load on demand, context menus and data binding that can make the control unique and extraordinary. While the [TreeViewAdv](https://help.syncfusion.com/windowsforms/treeview/overview) exposes some global styles that are to be applied for all the nodes, the [TreeNodeAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html) lets the users to specify styles for a specific node. The control comes with complete design time support. +[WinForms TreeView control](https://www.syncfusion.com/winforms-ui-controls/treeview) displays a collection of data in a hierarchical tree structure, and the data in the TreeViewAdv can be expanded and collapsed. The TreeViewAdv offers many advanced features like drag-and-drop, load on demand, context menus, and data binding that can make the control unique and extraordinary. While the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) exposes some global styles that are to be applied for all the nodes, the [TreeNodeAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html) lets the users specify styles for a specific node. The control comes with complete design-time support. ![Overview of Syncfusion TreeViewAdv](Overview_images/Overview_img1.jpg) ## Key Features -* Enabling enhanced performance by Virtualization support +* [Enabling enhanced performance by Virtualization support](performance) -* Data binding support. +* [Data binding support](data-binding). -* Select multiple items using the CTRL+ SHIFT keys. +* [Select multiple items using the CTRL + SHIFT keys](runtime-features#scrolling). -* Provides support for advanced drag and drop of the nodes. +* Provides support for [advanced drag and drop of the nodes](drag-and-drop). -* [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) can associate the context menus with the option to show and hide wherever necessary +* [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) can associate the [context menus](runtime-features#context-menu) with the option to show and hide wherever necessary. -* Provides automatic scrolling support for the TreeViewAdv +* Provides [automatic scrolling support](scrollbar-customization) for the TreeViewAdv. -* Customize the complete look and feel of the control. +* [Customize the complete look and feel of the control](treeview-appearance). -* Sort [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) items at run time. +* [Sort TreeViewAdv items at run time](sorting). -* Add images to expanded and collapsed states of TreeViewAdv. +* [Add images to expanded and collapsed states of TreeViewAdv](treenode-features#expand-and-collapse-image). -* Add images as left, right and state image sources to the [TreeNodeAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html). +* [Add images as left, right, and state image sources to the TreeNodeAdv](treenode-features#node-images). N> You can also explore our [WinForms TreeView example](https://github.com/syncfusion/winforms-demos/tree/master/treeview) that shows you how to render and configure the TreeView. + +## Compatibility + +The WinForms TreeViewAdv control is compatible with applications targeting .NET Framework 4.5 and above as well as .NET (Core) 3.1 / 6.0 / 7.0 / 8.0+ and is shipped as part of the Syncfusion Essential Studio WinForms suite. diff --git a/WindowsForms/treeview/Performance.md b/WindowsForms/treeview/Performance.md index 1c3671a3a..2eb2a54e8 100644 --- a/WindowsForms/treeview/Performance.md +++ b/WindowsForms/treeview/Performance.md @@ -12,15 +12,15 @@ WinForms TreeViewAdv performance can be improved by the following properties and ## EnableVirtualization -In TreeViewAdv, while loading 20,000 nodes it took nearly 60 seconds to load. Make this delay as considerable time this property is enabled. When `EnableVirtualization` is set as true, the parent nodes are added by scrolling the vertical scrollbar and the child nodes are added when expanding the respected parent node +In TreeViewAdv, loading 20,000 nodes can take nearly 60 seconds. Since this is a considerable delay, the `EnableVirtualization` property can be used to mitigate it. When `EnableVirtualization` is set to `true`, the parent nodes are added by scrolling the vertical scrollbar, and the child nodes are added when the corresponding parent node is expanded. ## SuspendExpandRecalculate -Improves performance of the TreeViewAdv with large number of nodes. Generally, the time taken to populate 5000 child nodes to a root node takes 10 milliseconds. But after setting the `SuspendExpandRecalculate `property to true, the time taken for populating is decreased to half of its original time i.e., 5 milliseconds. The unnecessary calling of Recalculate dimensions for the child nodes when the Root nodes are collapsed is also reduced. +Improves the performance of the TreeViewAdv when it contains a large number of nodes. Generally, populating 5,000 child nodes under a root node takes about 10 milliseconds. After setting the `SuspendExpandRecalculate` property to `true`, the time required is roughly halved to 5 milliseconds. The unnecessary calling of Recalculate dimensions for child nodes when the root nodes are collapsed is also reduced. ## RecalculateExpansion -By default, it is true. This property when set to false, greatly improves the performance of the tree nodes on load. +By default, this property is `true`. When set to `false`, it greatly improves the performance of the tree nodes on load. Property Table @@ -54,11 +54,11 @@ Description BeginUpdate -Calling this method will stop the redraws of the control and makes the node addition more faster than normal. +Calling this method stops the redraws of the control and makes node addition faster than normal. EndUpdate -Resumes the painting of the control suspended by BeginUpdate method. +Resumes the painting of the control suspended by the BeginUpdate method. > Note diff --git a/WindowsForms/treeview/RunTime-Features.md b/WindowsForms/treeview/RunTime-Features.md index 1145ee1f6..70f4d8bd5 100644 --- a/WindowsForms/treeview/RunTime-Features.md +++ b/WindowsForms/treeview/RunTime-Features.md @@ -84,36 +84,35 @@ Me.editItem.Text = "&Edit" {% tabs %} {% highlight c# %} -// Declared to NULL if the right click is outside the node area . +// Declared to null if the right click is outside the node area. private TreeNodeAdv rightMouseDownNodeCached = null; // Context menu pop up private void contextMenu1_Popup(object sender, System.EventArgs e) { - this.rightMouseDownNodeCached = this.treeViewAdv1.RMouseDownNode; + this.rightMouseDownNodeCached = this.treeViewAdv1.RMouseDownNode; -// This will be null if the user clicked in the empty portion of the tree. - if(this.treeViewAdv1.RMouseDownNode == null) + // This will be null if the user clicked in the empty portion of the tree. + if (this.treeViewAdv1.RMouseDownNode == null) { - this.copyItem.Visible = false; - this.cutItem.Visible = false; - this.editItem.Visible = false; - } - else - { - this.copyItem.Visible = true; - this.cutItem.Visible = true; - this.editItem.Visible = true; - } - + this.copyItem.Visible = false; + this.cutItem.Visible = false; + this.editItem.Visible = false; + } + else + { + this.copyItem.Visible = true; + this.cutItem.Visible = true; + this.editItem.Visible = true; + } } {% endhighlight %} {% highlight vb %} -' Declared to NULL if the right click is outside the node area . -Private rightMouseDownNodeCached As TreeNodeAdv = Nothing +' Declared to Nothing if the right click is outside the node area. +Private rightMouseDownNodeCached As TreeNodeAdv = Nothing ' Context menu Popup Private Sub contextMenu1_Popup(ByVal sender As Object, ByVal e As System.EventArgs) Handles contextMenu1.Popup @@ -286,7 +285,14 @@ Specifies whether scrolling is allowed using middle mouse button. AccelerateScrolling -Specifies the acceleration behavior for scrollbars.FastImmediateNoneDefault +Specifies the acceleration behavior for scrollbars. Options include: +
    +
  • Fast
    • +
  • Immediate
    • +
  • None
    • +
  • Default
    • +
+ AllowIncreaseSmallChange @@ -307,7 +313,13 @@ Description SizeGripStyle -Specifies if the sizing grip should be drawn at the bottom right corner when both scrollbars are visible. The options are,{{ '_Show_' | markdowify }} - shows the sizing grip.{{ '_Auto_' | markdowify }} - shows the sizing grip whenever needed.{{ '_Hide_' | markdowify}} - Hides the sizing grip. +Specifies whether the sizing grip should be drawn at the bottom right corner when both scrollbars are visible. Options are: +
    +
  • Show - always shows the sizing grip.
    • +
  • Auto - shows the sizing grip whenever needed.
    • +
  • Hide - hides the sizing grip.
    • +
+ @@ -317,7 +329,7 @@ Specifies if the sizing grip should be drawn at the bottom right corner when bot ### Office2007 Look and Feel for ScrollBars -TreeViewAdv provides support for Office2007Scrollbars with all three color schemes. +TreeViewAdv provides support for Office2007Scrollbars with all available color schemes (Blue, Silver, Black, and Managed). ![Office2007 in WinForms TreeView](Concepts-and--Features_images/Concepts-and--Features_img29.jpeg) @@ -360,12 +372,12 @@ Scrolling Events ### Hot Tracking -Hot Tracking is a feature available for nodes of the TreeViewAdv control. This gives a hot tracked appearance to the nodes when the mouse cursor is hovering over a corresponding node. +Hot Tracking is a feature available for nodes of the TreeViewAdv control. This gives a hot-tracked appearance to the nodes when the mouse cursor is hovering over a corresponding node. -Enabling the HotTracking property to true and when the mouse hovers over any node, +When the `HotTracking` property is set to `true` and the mouse hovers over any node: -* The fore color will change to blue and the text will be underlined with blue color, giving the node label a hyperlink appearance. -* In the below image the node "France" is given a link approach by setting the HotTracking property to true and by moving the mouse over the node. +* The foreground color changes to blue and the text is underlined with blue, giving the node label a hyperlink appearance. +* In the image below, the node "France" displays a hyperlink appearance because `HotTracking` is enabled and the mouse is hovering over the node. ![Hot Tracking in WinForms TreeView](Concepts-and--Features_images/Concepts-and--Features_img30.jpeg) @@ -397,9 +409,9 @@ treeNodeAdv9.HelpText = "ToolTip for TreeView"; {% highlight vb %} -TreeNodeAdv9.HelpText = "ToolTip for TreeView" +Me.treeNodeAdv9.HelpText = "ToolTip for TreeView" {% endhighlight %} {% endtabs %} -We can display scroll tips for the [scrollbars](/windowsforms/treeview/runtime-features#scrolling). \ No newline at end of file +We can display scroll tips for the [scrollbars](#scrolling). \ No newline at end of file diff --git a/WindowsForms/treeview/Save-And-Load-XML.md b/WindowsForms/treeview/Save-And-Load-XML.md index 35c05673b..57b021271 100644 --- a/WindowsForms/treeview/Save-And-Load-XML.md +++ b/WindowsForms/treeview/Save-And-Load-XML.md @@ -9,7 +9,7 @@ documentation: ug # Save and Load XML in Windows Forms TreeView -`TreeViewAdv` does not have direct option to load/save from XML file. This below section will help to load/save TreeViewAdv from XML. +`TreeViewAdv` does not have a direct option to load or save from an XML file. The section below demonstrates how to load and save a TreeViewAdv from XML. {% tabs %} @@ -26,13 +26,24 @@ private void LoadTreeViewAdvXML() XmlDocument xDoc = new XmlDocument(); xDoc.Load("TreeView.xml"); treeViewAdv1.Nodes.Clear(); - treeViewAdv1.Nodes.Add(new - TreeNodeAdv(xDoc.DocumentElement.Name)); + treeViewAdv1.Nodes.Add(new TreeNodeAdv(xDoc.DocumentElement.Name)); TreeNodeAdv tNode = new TreeNodeAdv(); tNode = (TreeNodeAdv)treeViewAdv1.Nodes[0]; LoadFromXML(xDoc.DocumentElement, tNode); treeViewAdv1.ExpandAll(); } + +/// +/// Helper that returns the value of the "name" attribute on the supplied XML node, or null if the attribute is missing. +/// +private string GetAttributeText(XmlNode xmlNode, string attributeName) +{ + if (xmlNode.Attributes != null && xmlNode.Attributes[attributeName] != null) + { + return xmlNode.Attributes[attributeName].Value; + } + return null; +} private void LoadFromXML(XmlNode xmlNode, TreeNodeAdv treeNode) { XmlNode xNode; @@ -62,17 +73,12 @@ private void LoadFromXML(XmlNode xmlNode, TreeNodeAdv treeNode) } /// + /// To write details in XML Elements + /// + private XmlTextWriter XmlTextWriter; -/// To write details in XML Elements - -/// -private XmlTextWriter XmlTextWriter; - -/// - -/// To save TreeViewAdv node information to XML File - -/// + /// + /// To save TreeViewAdv node information to XML File public void ExportToXML(TreeViewAdv tree, string filename) { XmlTextWriter = new XmlTextWriter(filename, System.Text.Encoding.UTF8); @@ -118,15 +124,25 @@ private void SaveToXML(TreeNodeAdvCollection menu) ''' Private Sub LoadTreeViewAdvXML() -Dim xDoc As New XmlDocument() -xDoc.Load("TreeView.xml") -treeViewAdv1.Nodes.Clear() -treeViewAdv1.Nodes.Add(New TreeNodeAdv(xDoc.DocumentElement.Name)) -Dim tNode As New TreeNodeAdv() -tNode = CType(treeViewAdv1.Nodes(0), TreeNodeAdv) -LoadFromXML(xDoc.DocumentElement, tNode) -treeViewAdv1.ExpandAll() + Dim xDoc As New XmlDocument() + xDoc.Load("TreeView.xml") + treeViewAdv1.Nodes.Clear() + treeViewAdv1.Nodes.Add(New TreeNodeAdv(xDoc.DocumentElement.Name)) + Dim tNode As New TreeNodeAdv() + tNode = CType(treeViewAdv1.Nodes(0), TreeNodeAdv) + LoadFromXML(xDoc.DocumentElement, tNode) + treeViewAdv1.ExpandAll() End Sub + +''' +''' Helper that returns the value of the named attribute on the supplied XML node, or Nothing if the attribute is missing. +''' +Private Function GetAttributeText(ByVal xmlNode As XmlNode, ByVal attributeName As String) As String + If xmlNode.Attributes IsNot Nothing AndAlso xmlNode.Attributes(attributeName) IsNot Nothing Then + Return xmlNode.Attributes(attributeName).Value + End If + Return Nothing +End Function Private Sub LoadFromXML(ByVal xmlNode As XmlNode, ByVal treeNode As TreeNodeAdv) Dim xNode As XmlNode Dim tNode As TreeNodeAdv diff --git a/WindowsForms/treeview/Sorting.md b/WindowsForms/treeview/Sorting.md index 8d159b512..bca2ccc53 100644 --- a/WindowsForms/treeview/Sorting.md +++ b/WindowsForms/treeview/Sorting.md @@ -11,7 +11,7 @@ documentation: ug Sorting can be performed on the tree nodes using the Sort function and specifying the function to be performed on either the checkbox or tag or text values in ascending or descending order. -The Sort operation sorts only the level 1 nodes. To perform the function on the other levels of nodes, the [SortWithChildNode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_SortWithChildNodes) property should be set to true. The sort function can be done based on the value type which can be specified using [SortType](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_SortType) to either the option of [Checkbox](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_CheckBox) or [Tag](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_Tag) or [Text](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_Text). The order in which the sort function must be performed can be specified using the [SortOrder](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_SortOrder) that holds the values of Ascending or Descending. +The Sort operation sorts only the level 1 nodes. To perform the function on the other levels of nodes, the [SortWithChildNodes](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_SortWithChildNodes) property should be set to true. The sort function can be done based on the value type which can be specified using [SortType](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_SortType) to either the option of [Checkbox](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_CheckBox) or [Tag](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_Tag) or [Text](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_Text). The order in which the sort function must be performed can be specified using the [SortOrder](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdv_SortOrder) that holds the values of Ascending or Descending. Property Table @@ -23,11 +23,11 @@ Description SortOrder -The SortOrder property indicates the order of the sorting: Ascending,Descending, None. +The SortOrder property indicates the order of the sorting: Ascending, Descending, or None. The default value is None. SortType -The SortType property indicates the field. Nodes will be sorted based on the type of sorting. +The SortType property indicates the field. Nodes will be sorted based on the type of sorting. The default value is Text. {% tabs %} @@ -40,8 +40,8 @@ treeNode.SortType = Syncfusion.Windows.Forms.Tools.TreeNodeAdvSortType.CheckBox; {% highlight vb %} -treeNode.SortOrder = System.Windows.Forms.SortOrder.Ascending -treeNode.SortType = Syncfusion.Windows.Forms.Tools.TreeNodeAdvSortType.CheckBox +Me.treeNode.SortOrder = System.Windows.Forms.SortOrder.Ascending +Me.treeNode.SortType = Syncfusion.Windows.Forms.Tools.TreeNodeAdvSortType.CheckBox {% endhighlight %} @@ -95,8 +95,8 @@ treeNodeAdv9.Comparer = null; {% highlight vb %} -TreeNodeAdv9.CompareOptions = System.Globalization.CompareOptions.IgnoreCase; -TreeNodeAdv9.Comparer = Null +Me.treeNodeAdv9.CompareOptions = System.Globalization.CompareOptions.IgnoreCase +Me.treeNodeAdv9.Comparer = Nothing {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/treeview/TreeNodeAdvCustomization.md b/WindowsForms/treeview/TreeNodeAdvCustomization.md index da8357979..eb102fd98 100644 --- a/WindowsForms/treeview/TreeNodeAdvCustomization.md +++ b/WindowsForms/treeview/TreeNodeAdvCustomization.md @@ -61,9 +61,9 @@ treeNode.Optioned = True ### Draw custom option button -The [TreeViewAv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) allows to draw the custom option button inside a tree node using the [DrawNodeCheckBox](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_DrawNodeCheckBox) event. Set the `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) to `true` while drawing the custom option button. +The [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) allows you to draw a custom option button inside a tree node using the [DrawNodeCheckBox](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_DrawNodeCheckBox) event. Set the `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) to `true` while drawing the custom option button. -> Note: If `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) is `false`, then the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) will automatically draw the usual radio button of the node. +> Note: If the `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) is `false`, then the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) will automatically draw the default radio button of the node. This example illustrates how to draw the custom option button. @@ -189,15 +189,15 @@ Property Description -{{'[OptionButtonHoverBackColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdvStyleInfo_OptionButtonHoverBackColor)'|markdownify }} +OptionButtonHoverBackColor Used to customize the hover background of the option button. -{{'[OptionButtonHoverBorderColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdvStyleInfo_OptionButtonHoverBorderColor)'|markdownify }} +OptionButtonHoverBorderColor Used to customize the hover border of the option button. -{{'[OptionButtonHoverColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdvStyleInfo_OptionButtonHoverColor)'|markdownify }} +OptionButtonHoverColor Used to customize the checked hover of the option button. @@ -284,9 +284,9 @@ public partial class Form2 : Form ## CheckBox -We can display CheckBox for all nodes in `TreeViewAdv` by setting `ShowCheckBoxes` property to True. The CheckBox for individual nodes can also be shown or hidden using `ShowCheckBox` property in `TreeNodeAdv`. +We can display a CheckBox for all nodes in `TreeViewAdv` by setting the `ShowCheckBoxes` property to `True`. The CheckBox for individual nodes can also be shown or hidden using the `ShowCheckBox` property in `TreeNodeAdv`. -The `InteractiveCheckBoxes` indicates whether the state of the parent node’s checkbox is based on the check state of its child nodes checkboxes. To set this for individual nodes set the `InteractiveCheckBox` property of the TreeNodeAdv. +The `InteractiveCheckBoxes` property indicates whether the state of the parent node's checkbox is based on the check state of its child nodes' checkboxes. To set this for individual nodes, set the `InteractiveCheckBox` property of the TreeNodeAdv. Property Table @@ -383,9 +383,9 @@ treeNode3.CheckState = System.Windows.Forms.CheckState.Unchecked ### Draw custom checkbox -The [TreeViewAv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) allows to draw the custom checkbox inside a tree node using the [DrawNodeCheckBox](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_DrawNodeCheckBox) event. Set the `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) to `true` while drawing the custom checkbox. +The [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) allows you to draw a custom checkbox inside a tree node using the [DrawNodeCheckBox](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html#Syncfusion_Windows_Forms_Tools_TreeViewAdv_DrawNodeCheckBox) event. Set the `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) to `true` while drawing the custom checkbox. -> Note: If `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) is `false`, then the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) will automatically draw the usual checkbox of the node. +> Note: If the `Handled` property of the [DrawTreeViewAdvNodeEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DrawTreeViewAdvNodeEventArgs.html) is `false`, then the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) will automatically draw the default checkbox of the node. This example illustrates how to draw the custom checkbox. diff --git a/WindowsForms/treeview/TreeView-Appearance.md b/WindowsForms/treeview/TreeView-Appearance.md index 1b817a7c8..db17a31d4 100644 --- a/WindowsForms/treeview/TreeView-Appearance.md +++ b/WindowsForms/treeview/TreeView-Appearance.md @@ -19,7 +19,7 @@ This section provides options to the customize the tree structure and the nodes. The below properties sets the background color for the treeview and also the node text. -Property Table +TreeViewAdv Property Table @@ -29,7 +29,7 @@ Description +Indicates the background color of the control. It provides options to set style, back color, fore color, gradient color, and gradient styles. ## Drawing Node Background -To draw the node's background, users need to turn on OwnerDrawnNodesBackground property, in theTreeViewAdv and then listen to the tree's NodeBackgroundPaint event which will be called for each node. This can be implemented by using the following code snippet. +To draw the node's background, users need to turn on the `OwnerDrawnNodesBackground` property in the TreeViewAdv and then listen to the tree's `NodeBackgroundPaint` event, which is called for each node. This can be implemented by using the following code snippet. Property Table @@ -235,11 +235,13 @@ Me.treeViewAdv1.InactiveSelectedNodeForeColor = System.Drawing.Color.SteelBlue Foreground Settings for the tree node text -Using the Text and TextColor property, individual node's text can be edited and colored respectively. +Using the `Text` and `TextColor` properties, an individual node's text can be edited and colored respectively. + +Using the `Font` and the `ForeColor` properties of the control, the text and text color of the nodes can be set for all the nodes in the TreeView control. -Using the Font and the ForeColor properties of the control, the text and text color of the nodes can be set for all the nodes in the TreeView control. +N> The font style for individual nodes can be set using the Font property available for individual nodes through the NodeCollection Editor. -N> The font style for individual nodes, can be set using the Font property available for individual nodes using NodeCollection Editor. +TreeViewAdv Property Table
BackgroundColor -Indicates the background color of the control. It provides options to set style, back color, fore color, gradient color and gradient styles.
BackColor @@ -125,7 +125,7 @@ Indicates if the node control will be themed.
@@ -256,13 +258,12 @@ ForeColor
Specifies the text color of the nodes.
- -Property Table +TreeNodeAdv Property Table {% tabs %} {% highlight c# %} -Void treeViewAdv1_OnNodeBeforeFind(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvBeforeFindArgs e) +void treeViewAdv1_BeforeNodeFind(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvBeforeFindArgs e) { // This will return the matched TreeNodeAdv. @@ -122,7 +120,7 @@ Void treeViewAdv1_OnNodeBeforeFind(object sender, Syncfusion.Windows.Forms.Tools {% highlight vb %} -Private Sub treeViewAdv1_OnNodeBeforeFind(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvBeforeFindArgs) +Private Sub treeViewAdv1_BeforeNodeFind(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvBeforeFindArgs) ' This will return the matched TreeNodeAdv. Dim matchedNode As TreeNodeAdv = e.Node @@ -166,7 +164,7 @@ This will return the search string to be highlighted in TreeNodeAdv. {% tabs %} {% highlight c# %} -void treeViewAdv1_OnNodeAfterFound(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvAfterFindArgs e) +void treeViewAdv1_AfterNodeFind(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvAfterFindArgs e) { // This will return matched TreeNodeAdv. @@ -180,7 +178,7 @@ void treeViewAdv1_OnNodeAfterFound(object sender, Syncfusion.Windows.Forms.Tools {% highlight vb %} -Private Sub treeViewAdv1_OnNodeAfterFound(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvAfterFindArgs) +Private Sub treeViewAdv1_AfterNodeFind(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvAfterFindArgs) ' This will return the matched TreeNodeAdv. Dim matchedNode As TreeNodeAdv = e.Node @@ -236,7 +234,7 @@ This will enable users to disable replacing matched TreeNodeAdv text. {% tabs %} {% highlight c# %} -void treeViewAdv1_OnNodeReplacing(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacingArgs e) +void treeViewAdv1_BeforeReplaceNode(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacingArgs e) { // This will return the replaced TreeNodeAdv. @@ -262,7 +260,7 @@ void treeViewAdv1_OnNodeReplacing(object sender, Syncfusion.Windows.Forms.Tools. {% highlight vb %} -Private Sub treeViewAdv1_OnNodeReplacing(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvOnReplacingArgs) +Private Sub treeViewAdv1_BeforeReplaceNode(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacingArgs) ' This will return the replaced TreeNodeAdv. Dim replaceNode As TreeNodeAdv = e.Node @@ -318,7 +316,7 @@ This will return TreeNodeAdv text that has been replaced. {% tabs %} {% highlight c# %} -void treeViewAdv1_OnNodeReplaced(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacedArgs e) +void treeViewAdv1_AfterReplaceNode(object sender, Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacedArgs e) { // This will return the replaced TreeNodeAdv. @@ -335,7 +333,7 @@ void treeViewAdv1_OnNodeReplaced(object sender, Syncfusion.Windows.Forms.Tools.T {% highlight vb %} -Private Sub treeViewAdv1_OnNodeReplaced(sender As Object, e As Syncfusion.Windows.Forms.Tools. TreeNodeAdvOnReplacedArgs) +Private Sub treeViewAdv1_AfterReplaceNode(sender As Object, e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvOnReplacedArgs) ' This will return Replaced TreeNodeAdv Dim replacedNode As TreeNodeAdv = e.Node From 4669f5d24d26a1cf61fe3787c8dafa3e628b5b9c Mon Sep 17 00:00:00 2001 From: Usha4947 Date: Wed, 8 Jul 2026 13:03:29 +0530 Subject: [PATCH 03/36] WF_1039222: Updated the documentation for MultiColumn-TreeView --- .../MultiColumn-TreeView/Appearance.md | 32 +++++-------- .../MultiColumn-TreeView/Filtering.md | 2 +- .../MultiColumn-TreeView/Find-and-Replace.md | 18 ++++---- .../MultiColumn-TreeView/Getting-Started.md | 18 ++++---- .../MultiColumn-TreeView/LoadOnDemand.md | 6 +-- .../MultiColumnTreeView-Events.md | 8 ++-- .../MultiColumnTreeView-Features.md | 36 +++++++-------- WindowsForms/MultiColumn-TreeView/Overview.md | 28 +++++------ .../MultiColumn-TreeView/Performance.md | 6 +-- WindowsForms/MultiColumn-TreeView/Sorting.md | 14 +++--- .../Style-Architecture.md | 46 +++++++++---------- .../TreeNodeAdv-Features.md | 16 +++---- 12 files changed, 111 insertions(+), 119 deletions(-) diff --git a/WindowsForms/MultiColumn-TreeView/Appearance.md b/WindowsForms/MultiColumn-TreeView/Appearance.md index fdf4c3a05..fb6a17076 100644 --- a/WindowsForms/MultiColumn-TreeView/Appearance.md +++ b/WindowsForms/MultiColumn-TreeView/Appearance.md @@ -15,14 +15,11 @@ documentation: ug BorderStyle Property has the following styles -* None -If the BorderStyle set as none, border of MultiColumnTreeView will be collapsed +* `None` - If the BorderStyle is set to None, the border of the MultiColumnTreeView is collapsed. -* FixedSingle (For 2D) - If the BorderStyle set as FixedSingle, then the border of the MultiColumnTreeView will be visible and we can customize the border. +* `FixedSingle (For 2D)` - If the BorderStyle is set to FixedSingle, the border of the MultiColumnTreeView is visible and you can customize it. -* Fixed3D (Default) - If the BorderStyle set as Fixed3D, then the border of the MultiColumnTreeView will be visible in 3D and we can customize the border settings +* `Fixed3D (Default)` - If the BorderStyle is set to Fixed3D, the border of the MultiColumnTreeView is visible in 3D and you can customize the border settings. ### BorderSingle @@ -50,22 +47,17 @@ BorderSides Property specify the sides of the control to which 3D border should It has the following Options -* All -Three-dimensional border will be set for all sides +* `All` - Three-dimensional border is set for all sides. -* Right -Three-dimensional border on the right side of MultiColumnTreeView +* `Right` - Three-dimensional border is set on the right side of the MultiColumnTreeView. -* Left -Three-dimensional border on the left side of MultiColumnTreeView +* `Left` - Three-dimensional border is set on the left side of the MultiColumnTreeView. -* Top -Three-dimensional border on the top of MultiColumnTreeView +* `Top` - Three-dimensional border is set on the top of the MultiColumnTreeView. -* Bottom -Three-dimensional border on the bottom of MultiColumnTreeView +* `Bottom` - Three-dimensional border is set on the bottom of the MultiColumnTreeView. -* Middle +* `Middle` ### Border3DStyle @@ -471,7 +463,7 @@ Me.MultiColumnTreeView1.Nodes(0).Nodes(0).Nodes(2).SubItems(1).BorderStyle = Bor ### Image Customization -Sub items can be customized with the Right and left image using the property `RightImage` and `LeftImage` +Sub items can be customized with right and left images using the `RightImage` and `LeftImage` properties. {% tabs %} @@ -579,7 +571,7 @@ Me.multiColumnTreeView1.Style = MultiColumnVisualStyle.Office2016DarkGray ## PlusMinus -Plus Minus are used to display plus/minus images for the parent nodes using the property `ShowPlusMinus` these images can be disabled. +Plus Minus are used to display plus/minus images for the parent nodes. Set the `ShowPlusMinus` property to `false` to disable these images. {% tabs %} @@ -888,6 +880,6 @@ treeNodeAdv1.CloseImgIndex = 2 {% endcapture %} {{ codesnippet6 | OrderList_Indent_Level_1 }} -4. Repeat step 3 until set OpenImgIndex and ClosedImgIndex for all the nodes in MultiColumnTreeView. +4. Repeat step 3 until the `OpenImageIndex` and `ClosedImageIndex` are set for all the nodes in the MultiColumnTreeView. ![Appearance_img20](Appearance_Images/Appearance_img20.jpg) diff --git a/WindowsForms/MultiColumn-TreeView/Filtering.md b/WindowsForms/MultiColumn-TreeView/Filtering.md index 6b13bf24d..b45777de6 100644 --- a/WindowsForms/MultiColumn-TreeView/Filtering.md +++ b/WindowsForms/MultiColumn-TreeView/Filtering.md @@ -87,7 +87,7 @@ End Sub {% endtabs %} -Here, the `FilterNodes` delegate filters the node based on Salary. The `FilterNodes` delegate is assigned to  [Filter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.MultiColumnTreeView.MultiColumnTreeView.html#Syncfusion_Windows_Forms_Tools_MultiColumnTreeView_MultiColumnTreeView_Filter) predicate to filter the nodes. After that, [RefreshFilter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.MultiColumnTreeView.MultiColumnTreeView.html#Syncfusion_Windows_Forms_Tools_MultiColumnTreeView_MultiColumnTreeView_RefreshFilter) method is called to refresh the nodes. +Here, the `FilterNodes` delegate filters nodes based on the Salary value. The `FilterNodes` delegate is assigned to the [Filter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.MultiColumnTreeView.MultiColumnTreeView.html#Syncfusion_Windows_Forms_Tools_MultiColumnTreeView_MultiColumnTreeView_Filter) delegate property to filter the nodes. After that, the [RefreshFilter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.MultiColumnTreeView.MultiColumnTreeView.html#Syncfusion_Windows_Forms_Tools_MultiColumnTreeView_MultiColumnTreeView_RefreshFilter) method is called to refresh the nodes. ![WindowsForms MultiColumnTreeView Filtering](Filtering_images/WindowsForms-MultiColumnTreeView-Filtering.png) diff --git a/WindowsForms/MultiColumn-TreeView/Find-and-Replace.md b/WindowsForms/MultiColumn-TreeView/Find-and-Replace.md index b0c789a8b..9d9dd907e 100644 --- a/WindowsForms/MultiColumn-TreeView/Find-and-Replace.md +++ b/WindowsForms/MultiColumn-TreeView/Find-and-Replace.md @@ -11,7 +11,7 @@ documentation: ug ## TreeViewFindReplaceDialog -The find and replace feature enables users to search and replace a specific tree node present in the MultiColumnTreeView control. You can implement the fastest Find and Replace functionality in the MultiColumnTreeView control by using the TreeViewFindReplaceDialog class. This class provides the methods that are necessary to perform a find and replace operation. +The find and replace feature enables users to search and replace a specific tree node present in the MultiColumnTreeView control. You can implement the fastest Find and Replace functionality in the MultiColumnTreeView control by using the `TreeViewFindReplaceDialog` class. This class provides the methods that are necessary to perform a find and replace operation. The value entered in the Search Text field is highlighted in the MultiColumnTreeView control after the search action is performed. You can switch to each highlighted tree node by clicking the Find Next button. This functionality is available only when there is more than one search result. @@ -39,11 +39,11 @@ The available search options are as follows: ## MultiColumnTreeView Search Range -1. **TreeView** : Specifies whether the search can be performed in entire TreeViewAdv control. +1. **TreeView** : Specifies whether the search is performed across the entire MultiColumnTreeView control. -2. **Root Node** : Specifies whether the search can be performed only on the parent node level. +2. **Root Node** : Specifies whether the search is performed only at the parent node level. -3. **Child Node** : Specifies whether the search can be performed only on the child node level. +3. **Child Node** : Specifies whether the search is performed only at the child node level. Find and Replace can be enabled by using the below code @@ -89,7 +89,7 @@ dialog.ReplaceAll("Britain", "United Kingdom", TreeViewSearchOption.MatchWholeTe ## OnNodeBeforeFind Event -This event will be triggered before the matching tree nodes are highlighted in the MultiColumnTreeView control.  +This event will be triggered before the matching tree nodes are highlighted in the MultiColumnTreeView control. Event Data @@ -140,7 +140,7 @@ End Sub ## OnNodeAfterFound Event -This event will be triggered after the matching TreeNodeAdv is highlighted in the MultiColumnTreeView control.  +This event will be triggered after the matching TreeNodeAdv is highlighted in the MultiColumnTreeView control. Event Data @@ -192,7 +192,7 @@ End Sub ## OnNodeReplacing Event -This event will be triggered before replacing the matched tree node text in the MultiColumnTreeView control.  +This event will be triggered before replacing the matched tree node text in the MultiColumnTreeView control. Event Data @@ -263,7 +263,7 @@ End Sub ## OnNodeReplaced Event -This event will be triggered after the matched TreeNodeAdv text is replaced in the MultiColumnTreeView control.  +This event will be triggered after the matched TreeNodeAdv text is replaced in the MultiColumnTreeView control. Event Data @@ -318,7 +318,7 @@ End Sub ## Keyboard Search -Setting `AllowKeyboardSearch` property of the MultiColumnTreeView to true, will allow the user to search for a node by typing the name of the node using the keyboard. +Setting the `AllowKeyboardSearch` property of the MultiColumnTreeView to `true` allows the user to search for a node by typing the name of the node using the keyboard. This feature is enabled by default. {% tabs %} diff --git a/WindowsForms/MultiColumn-TreeView/Getting-Started.md b/WindowsForms/MultiColumn-TreeView/Getting-Started.md index 5010a5c1d..f4db02205 100644 --- a/WindowsForms/MultiColumn-TreeView/Getting-Started.md +++ b/WindowsForms/MultiColumn-TreeView/Getting-Started.md @@ -9,13 +9,13 @@ documentation: ug # Getting Started with Windows Forms MultiColumn TreeView -This section explains how to create a new Windows Forms project in Visual Studio and add **"MultiColumnTreeView"** with it's basic functionalities. +This section explains how to create a new Windows Forms project in Visual Studio and add **"MultiColumnTreeView"** with its basic functionalities. ## Assembly deployment -Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#multicolumntreeview) section to get the list of assemblies or NuGet package details which needs to be added as reference to use the control in any application. +Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#multicolumntreeview) section to get the list of assemblies or NuGet package details that need to be added as a reference to use the control in any application. -[Check here](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to find more details about on how to install nuget packages in Windows Forms application. +[Check here](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to find more details on how to install NuGet packages in a Windows Forms application. ## Adding a MultiColumnTreeView control through designer @@ -38,9 +38,9 @@ The **"MultiColumnTreeView"** control can be added through designer by following ## Adding a MultiColumnTreeView control through code -**Step 1**: Create C# or VB application through Visual Studio. +**Step 1**: Create a C# or VB application through Visual Studio. -**Step 2**: Add the following reference to the project. +**Step 2**: Add the following references to the project: * Syncfusion.Grid.Base * Syncfusion.Grid.Windows @@ -380,8 +380,8 @@ The TreeNodeAdv can be customized with the following options. ### Root lines -We can display the root lines between the root nodes by setting the property `ShowRootLines` to `true`. Whereas the property `ShowLines` displays connecting the line for rest of nodes in the control, except between the root nodes. By default, `ShowRootLines` and `ShowLines` is set as `true`. -When `ShowLines` is set to `false`, the connecting lines will not be displayed for the entire control. +You can display root lines between the root nodes by setting the `ShowRootLines` property to `true`. The `ShowLines` property displays the connecting lines for the rest of the nodes in the control, except between the root nodes. By default, `ShowRootLines` and `ShowLines` are set to `true`. +When `ShowLines` is set to `false`, the connecting lines are not displayed for the entire control.
-TreeViewAdv Properties +TreeNodeAdv Properties Description
@@ -398,11 +399,9 @@ Image Overlaying ## Border Settings -3D Border for TreeView +3D Border for TreeView -The following properties sets 3D border for the treeview. - -Property Table +The following properties set the 3D border for the TreeView. @@ -412,20 +411,33 @@ Description +Sets the border style for the TreeView control. Options are: FixedSingle (a normal border) or Fixed3D (3D appearance). +Indicates the style of the 3D border when BorderStyle is set to Fixed3D. Options include: +
    +
  • RaisedOuter
    • +
  • SunkenOuter
    • +
  • RaisedInner
    • +
  • SunkenInner
    • +
  • Raised
    • +
  • Etched
    • +
  • Bump
    • +
  • Sunken (Default)
    • +
  • Adjust
    • +
  • Flat
    • +
+
BorderStyle -Sets the border style for the Treeview control.{{ '_FixedSingle_' | markdownify }} - a normal border,{{ '_Fixed3D_' | markdownify }} - 3D appearance.
Border3DStyle -Indicates the style of the 3D border when BorderStyle is set to Fixed3D.RaisedOuter
SunkenOuterRaisedInnerSunkenInnerRaisedEtchedBumpSunken (Default)Adjust Flat
![Border in WinForms TreeView](Concepts-and--Features_images/Concepts-and--Features_img43.jpeg) ## 2D Border for TreeView -The following properties let you set customized 2D border. +The following properties let you set a customized 2D border. -N> The settings will effect only when TreeViewAdv.BorderStyle property is set to FixedSingle. +N> These settings will take effect only when the TreeViewAdv.BorderStyle property is set to FixedSingle. @@ -443,7 +455,16 @@ Specifies the sides of the control to which border should be set. +Indicates the 2D border style. Options include: +
    +
  • Solid (Default)
    • +
  • Dotted
    • +
  • Dashed
    • +
  • Inset
    • +
  • Outset
    • +
  • None
    • +
+
BorderSingle -Indicates the 2D border style. The options are,Solid (Default),Dotted,Dashed,Inset,Outset,None.
{% tabs %} diff --git a/WindowsForms/treeview/TreeViewAdv-Events.md b/WindowsForms/treeview/TreeViewAdv-Events.md index 9dc09a096..4248d4969 100644 --- a/WindowsForms/treeview/TreeViewAdv-Events.md +++ b/WindowsForms/treeview/TreeViewAdv-Events.md @@ -372,11 +372,13 @@ private void treeViewAdv1_BeforeCheck(object sender, Syncfusion.Windows.Forms.To { if (Control.MouseButtons == MouseButtons.Left) { -// Allow check or uncheck. + // Allow check or uncheck when the user clicks the checkbox with the left mouse button. } else -// Ignore all other ways to check/uncheck the node. - e.Cancel = true; + { + // Ignore all other ways to check/uncheck the node. + e.Cancel = true; + } } {% endhighlight %} @@ -385,12 +387,10 @@ private void treeViewAdv1_BeforeCheck(object sender, Syncfusion.Windows.Forms.To Private Sub treeViewAdv1_BeforeCheck(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvBeforeCheckEventArgs) If Control.MouseButtons = MouseButtons.Left Then - -' Allow check or uncheck. + ' Allow check or uncheck when the user clicks the checkbox with the left mouse button. Else - -' Ignore all other ways to check/uncheck the node. -e.Cancel = True + ' Ignore all other ways to check/uncheck the node. + e.Cancel = True End If End Sub @@ -795,8 +795,8 @@ private void treeViewAdv1_NodeEditorValidated(object sender, Syncfusion.Windows. Private Sub treeViewAdv1_NodeEditorValidated(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Tools.TreeNodeAdvEditEventArgs) -'This prints the treenodeadv action associated with the event in the output window at run time. -Console.Write("Label :" + e.Action.ToString()) +'This prints the label for the node in the output window at run time. +Console.Write("Label :" + e.Label.ToString()) 'This prints the treenodeadv associated with the event in the output window at run time. Console.Write("TreeNodeAdv :" + e.Node.ToString()) @@ -878,8 +878,8 @@ e.Cancel = true 'otherwise editing mode will be preserved. Default is true. e.ContinueEditing = False -'This prints the treenodeadv action associated with the event in the output window at run time. -Console.Write("Label :" + e.Action.ToString()) +'This prints the label for the node in the output window at run time. +Console.Write("Label :" + e.Label.ToString()) 'This prints the treenodeadv associated with the event in the output window at run time. Console.Write("TreeNodeAdv :" + e.Node.ToString()) diff --git a/WindowsForms/treeview/search-functionality.md b/WindowsForms/treeview/search-functionality.md index d804cff98..ce6f97844 100644 --- a/WindowsForms/treeview/search-functionality.md +++ b/WindowsForms/treeview/search-functionality.md @@ -9,9 +9,7 @@ documentation: ug # Search Functionality in WinForms TreeView(SfTreeView) -Description - -The find and replace feature enables users to search and replace a specific tree node present in the TreeViewAdv control. You can implement the fastest Find and Replace functionality in the TreeViewAdv control by using the TreeViewAdvFindReplaceDialog class. This class provides the methods that are necessary to perform a find and replace operation. +This document describes how to use the built-in search and replace feature of the TreeViewAdv control. The find and replace feature enables users to search and replace a specific tree node present in the TreeViewAdv control. You can implement the fastest Find and Replace functionality in the TreeViewAdv control by using the TreeViewAdvFindReplaceDialog class. This class provides the methods that are necessary to perform a find and replace operation. The value entered in the Search Text field is highlighted in the TreeViewAdv control after the search action is performed. You can switch to each highlighted tree node by clicking the Find Next button. This functionality is available only when there is more than one search result. @@ -105,7 +103,7 @@ This enables users to disable highlighting matched TreeNodeAdv.
@@ -417,7 +417,7 @@ Me.multiColumnTreeView1.ShowRootLines = True ### Plus Minus -Plus minus symbols will be shown according to the state of the node, plus (+) will be shown if the node is in expanded state and minus (-) will be shown if the node is minimized. +Plus Minus symbols are shown according to the state of the node. Plus (+) is shown when the node is collapsed, and minus (-) is shown when the node is expanded.
@@ -464,7 +464,7 @@ ToolTip is a special control which automatically appears as a popup when a node ### Check Box -The `ShowCheckBoxes` property when set will display check box for all the nodes. To apply checkbox to individual nodes, set the `TreeNodeAdv.ShowCheckBox` property, only for the required nodes in the NodeCollection Editor. +The `ShowCheckBoxes` property, when set, displays a check box for all the nodes. To apply the check box to individual nodes, set the `TreeNodeAdv.ShowCheckBox` property only for the required nodes in the NodeCollection Editor. The `InteractiveCheckBoxes` indicates whether the state of the parent node’s checkbox is based on the check state of its child nodes checkboxes. To set this for individual nodes set the `InteractiveCheckBox` property of the TreeNodeAdv. diff --git a/WindowsForms/MultiColumn-TreeView/LoadOnDemand.md b/WindowsForms/MultiColumn-TreeView/LoadOnDemand.md index dccb9a7b2..4a4e5e0bd 100644 --- a/WindowsForms/MultiColumn-TreeView/LoadOnDemand.md +++ b/WindowsForms/MultiColumn-TreeView/LoadOnDemand.md @@ -11,7 +11,7 @@ documentation: ug LoadOnDemand feature is to give a delay in loading a node in a Tree, before the user initiates a node to expand. -By setting LoadOnDemand property to true, the plus (+) and minus (-) of all the nodes will be visible in the beginning. By handling the BeforeExpand event of the nodes, sub nodes can be added to the respective nodes. Now the tree will display or hide the plus or minus based on whether the children are added. +By setting the `LoadOnDemand` property to `true`, the plus (+) and minus (-) signs of all the nodes are visible at the start. By handling the `BeforeExpand` event of the nodes, sub nodes can be added to the respective nodes. The tree then displays or hides the plus or minus sign based on whether the children are added. **Property Table** @@ -45,9 +45,9 @@ Method which is used to derive the path string for a specific node. ## Retrieving Node Path -In the BeforeExpand event the user can retrieve the path string for a specific node using the TreeNodeAdv.GetPath method where the user can also specify the separator. +In the `BeforeExpand` event, the user can retrieve the path string for a specific node using the `TreeNodeAdv.GetPath` method, where the user can also specify the separator. -The vital thing in this sample is that the MultiColumnTreeView.AddSeparatorAtEnd property must be set to True to add a “\” character at the end of the path of the node, when calling the Node.GetPath method. +The vital thing in this sample is that the `MultiColumnTreeView.AddSeparatorAtEnd` property must be set to `True` to add a "\" character at the end of the path of the node when calling the `Node.GetPath` method. {% tabs %} diff --git a/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Events.md b/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Events.md index a64bed22b..e17ab5269 100644 --- a/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Events.md +++ b/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Events.md @@ -11,7 +11,7 @@ documentation: ug ## Node Painting Events -Node painting events will be triggered before painting or after painting a node. +These events are triggered before and after a node is painted.
@@ -68,7 +68,7 @@ End Sub ## CheckBox Event -These events will be triggered before checking a node or when interactive check happens. +These events are triggered before a node is checked or when an interactive check happens.
@@ -272,7 +272,7 @@ Notifies that a new label has been provided for a node by the user. +Lets you validate the new node label entered by the user. ![Style-Architecture_img10](Style-Architecture_Images/Style-Architecture_img10.jpg) -Image Showing three Standard styles for Nodes, SubItem and Column. +Image showing three Standard styles for Nodes, SubItem, and Column. -The below image displays a gradient style for all the columns of the MultiColumnTreeView control by changing the properties of Standard Style +The following image displays a gradient style for all the columns of the MultiColumnTreeView control by changing the properties of the Standard Style. ![Style-Architecture_img9](Style-Architecture_Images/Style-Architecture_img9.jpg) ## Node Custom Style - -Make a Node’s Style Inherit from Another Base Style -Apart from the Standard Style , we can also create custom Base styles using the BaseStyles Collection Editor. Select the Base Style option, then click Add Style. -This new base style can be applied to any of the nodes, using TreeNodeAdv.BaseStyle property of the respective nodes. +A node's style can be made to inherit from another base style. +Apart from the Standard Style, you can also create custom base styles using the BaseStyles Collection Editor. Select the Base Style option, then click Add Style. + +This new base style can be applied to any of the nodes using the `TreeNodeAdv.BaseStyle` property of the respective nodes. This overrides the Standard Style settings for the specified nodes and displays the image as follows. @@ -409,10 +409,10 @@ Specifies the sort type of the node. ![Style-Architecture_img2](Style-Architecture_Images/Style-Architecture_img2.jpg) ## Node Level Style - -Setting a Common Style for all the Nodes in a Level -MultiColumnTreeView lets you add node level styles using the BaseStyles Collection Editor. By default, this style will be applied to all the nodes in the Level1 for NodeLevel1 style, Level2 for NodeLevel2 style and so on. -You can apply this style to any of the node by using TreeNodeAdv.BaseStyle property for a node. Refer to Style Settings table in Node Specific Style. + +Setting a common style for all the nodes at a level. +MultiColumnTreeView lets you add node level styles using the BaseStyles Collection Editor. By default, this style is applied to all nodes in Level 1 for `NodeLevel1` style, Level 2 for `NodeLevel2` style, and so on. +You can apply this style to any node by using the `TreeNodeAdv.BaseStyle` property for a node. Refer to the Style Settings table in Node Specific Style. ![Style-Architecture_img3](Style-Architecture_Images/Style-Architecture_img3.jpg) @@ -420,11 +420,11 @@ You can apply this style to any of the node by using TreeNodeAdv.BaseStyle prope ## Column Style -Standard - Column style is default style that will applied for all the columns of the MultiColumnTreeView control. The style settings can be edited by the user. +Standard - Column style is the default style that will be applied to all the columns of the MultiColumnTreeView control. The style settings can be edited by the user. -###Column Style Properties +### Column Style Properties -The below properties control the appearance of the columns. +The following properties control the appearance of the columns. @@ -502,11 +502,11 @@ The user-defined column style can be applied to any of the columns, using Column ## SubItem Styles -Standard - SubItem style in the BaseStyles Collection Editor will be applied by default to all the sub items that are added to the tree nodes. User can also edit the default style settings. +Standard - SubItem style in the BaseStyles Collection Editor is applied by default to all the sub items that are added to the tree nodes. Users can also edit the default style settings. ### Properties -The below properties let you customize the sub items using the Styles editor. +The following properties let you customize the sub items using the Styles editor. diff --git a/WindowsForms/MultiColumn-TreeView/TreeNodeAdv-Features.md b/WindowsForms/MultiColumn-TreeView/TreeNodeAdv-Features.md index 7278338af..fd92e4575 100644 --- a/WindowsForms/MultiColumn-TreeView/TreeNodeAdv-Features.md +++ b/WindowsForms/MultiColumn-TreeView/TreeNodeAdv-Features.md @@ -12,7 +12,7 @@ This section discusses the following topics. ## OptionButton -Option button allows the user to select only one node out of all nodes. +Option button allows the user to select only one node from all nodes. **Property Table** @@ -44,7 +44,7 @@ Indicates if the option button will be shown for the node. +Gets or sets the optioned state of a node.
NodeEditorValidating -Let’s you validate the new node label entered by the user.
NodeEditorValidateString @@ -549,7 +549,7 @@ End Sub ## ScrollingEvent -Events related to the scroll functionality of the control. +These events are related to the scroll functionality of the control. diff --git a/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Features.md b/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Features.md index 3e0b1b37e..09ab2b102 100644 --- a/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Features.md +++ b/WindowsForms/MultiColumn-TreeView/MultiColumnTreeView-Features.md @@ -15,13 +15,13 @@ MultiColumnTreeView contains following features, ### SelectionMode -`SelectionMode` defines the ability to select number of nodes at a time, there are three modes. +`SelectionMode` defines the ability to select a number of nodes at a time. The following three modes are available: -• Single – Allows the user to select only a single node. +* **Single** – Allows the user to select only a single node. -• MultiSelectSameLevel – Allows to multi select only when the multiple nodes are same level. +* **MultiSelectSameLevel** – Allows multi-selection only when the multiple nodes are at the same level. -• MultiSelectAll – Allows to multi select the nodes irrespective of node level. +* **MultiSelectAll** – Allows multi-selection of nodes irrespective of node level. {% tabs %} @@ -83,10 +83,10 @@ Me.MultiColumnTreeView1.ActiveNode = Me.MultiColumnTreeView1.Nodes(4).Nodes(1) {% endtabs %} -## Keyboard and Mouse based selection +## Keyboard-Based and Mouse-Based Selection -Mouse based selection allows the user to select the nodes using mouse drag, simply click on any area in MultiColumnTreeView and drag. All the nodes available in the drag region will be selected . -Use the property ` AllowMouseBasedSelection`, to select the nodes using mouse. +Mouse-based selection allows the user to select the nodes using a mouse drag. Simply click on any area in MultiColumnTreeView and drag. All the nodes available in the drag region will be selected. +Use the property `AllowMouseBasedSelection` to select nodes using the mouse. {% tabs %} @@ -106,7 +106,7 @@ Me.MultiColumnTreeView1.AllowMouseBasedSelection = True ![MultiColumnTreeView-Features_img2](MultiColumntreeView-Features_Images/MultiColumnTreeView-Features_img2.jpg) -MultiColumnTreeView supports to search the nodes with the keyboard buttons. Simply tap any alphabet in keyboard and MultiColumnTreeView will show the node starting with that alphabet and keep tapping the button to show all the nodes starting with that alphabet. +MultiColumnTreeView supports searching for nodes using the keyboard. Tap any letter on the keyboard and MultiColumnTreeView will show the node starting with that letter. Keep tapping the same letter to cycle through all the nodes starting with it. {% tabs %} @@ -124,14 +124,14 @@ Me.MultiColumnTreeView1.AllowKeyboardSearch = True {% endtabs %} -## Auto Size for columns +## Auto Size for Columns -MultiColumnTreeView has the support for calculating the width of the Nodes and SubItems by calculating the width of Text and images in it and assigns the largest node width to its column. +MultiColumnTreeView supports calculating the width of nodes and sub-items based on the width of the text and images they contain, and assigns the largest node width to its column. -It can be done by using the property `AutoSizeMode`, it has two options None and AllCellsExceptHeader. +This is controlled by the `AutoSizeMode` property, which has the following options: -* None – No Auto size to the columns -* AllCellsExceptHeader – Calculates the nodes width and assigns the width to the column, this option will not calculate width of the header text. +* **None** – No auto-size is applied to the columns. +* **AllCellsExceptHeader** – Calculates the node width and assigns it to the column. The width of the header text is not included in the calculation. {% tabs %} @@ -154,10 +154,10 @@ Me.multiColumnTreeView1.AutoSizeMode = Syncfusion.Windows.Forms.Tools.MultiColum ## Undo & Redo -Undo action is used to erase the last change done to the node and takes back to the older state. +The Undo action erases the last change made to a node and reverts it to the previous state. -Redo is the opposite of Undo, the redo command reverses the Undo and takes the node to the current state. Redo can be performed only after an Undo action. -The actions can be recorded into the history manager such that the undo and redo operations can be performed. +Redo is the opposite of Undo. The redo command reverses the Undo and returns the node to the current state. Redo can be performed only after an Undo action. +Actions can be recorded in the history manager so that Undo and Redo operations can be performed. **Property Table** @@ -209,7 +209,7 @@ this.multiColumnTreeView1.HistoryManager.Redo(); {% endtabs %} -## ToolTip & HelpText +## Tooltip and Help Text ### Help Text @@ -265,7 +265,7 @@ The MultiColumnTreeView performance can be improved with the following propertie ### SuspendExpandRecalculate -When the SuspendExpandRecalculate property to true, the populating time nearly reduces to half of its original time by recalculating the nodes maximum height while expanding and collapsing. +When the `SuspendExpandRecalculate` property is set to `true`, the populating time is nearly halved by recalculating the maximum height of the nodes only while expanding and collapsing. {% tabs %} diff --git a/WindowsForms/MultiColumn-TreeView/Overview.md b/WindowsForms/MultiColumn-TreeView/Overview.md index 0f9ace9ff..ff46a492f 100644 --- a/WindowsForms/MultiColumn-TreeView/Overview.md +++ b/WindowsForms/MultiColumn-TreeView/Overview.md @@ -9,38 +9,38 @@ documentation: ug # Windows Forms MultiColumn TreeView Overview -[WinForms MultiColumn TreeView](https://www.syncfusion.com/winforms-ui-controls/multicolumn-treeview) is an advanced treeview control with multiple columns. This control displays the contents in the form of tree with additional columns displaying related data for the tree nodes and with its robust features, it gives a visually appealing tree structure. The Styles Architecture for the control lets the users to define styles for nodes at different levels of the tree and columns style for individual columns. +[WinForms MultiColumn TreeView](https://www.syncfusion.com/winforms-ui-controls/multicolumn-treeview) is an advanced treeview control with multiple columns. This control displays content as a tree with additional columns that show related data for each node, and its robust features deliver a visually appealing tree structure. The Style Architecture for the control lets users define styles for nodes at different levels of the tree and column styles for individual columns. ![Overview of MultiColumnTreeView](Overview_Images/overview.png) ## Components of MultiColumnTreeView -* TreeColumnAdv -* TreeNodeAdv -* TreeNodeAdvSubItem -* Custom Control +* **TreeColumnAdv** - Represents a column in the MultiColumnTreeView control. +* **TreeNodeAdv** - Represents a node that can be added to the control and supports sub-items. +* **TreeNodeAdvSubItem** - Represents a sub-item displayed in additional columns of a node. +* **Custom Control** - Represents a control that can be embedded in a node of the first column. ## Key Features **Style Architecture** - Supports a flexible style architecture to let users define the styles for nodes at different levels of the Tree. It helps the users to specify the styles for a specific node. -**Columns** - Supports to add multiple columns and sub items. +**Columns** - Supports adding multiple columns and sub-items. -**CheckBox and OptionButton support** - Interactive check boxes that could be checked or unchecked, which will indicate the check state of the child node’s check boxes. Node can also hold option buttons. +**CheckBox and OptionButton support** - Interactive check boxes that can be checked or unchecked, indicating the check state of the child node's check boxes. Nodes can also hold option buttons. -**Load on demand** - Provides the user to delay the loading of nodes in Trees, until the user initiates the nodes to expand. +**Load on demand** - Delays loading of nodes in the tree until the user expands a parent node. -**Image settings** - Tree nodes can hold left images, right images and images for different state of the nodes like expand and collapse. +**Image settings** - Tree nodes can hold left images, right images, and images for different node states such as expand and collapse. **Appearance** - Provides the background and foreground properties for customizing the appearance of the control. -**Customization** - We can customize the Text, Font, Nodes and etc.. +**Customization** - Customizes the text, font, and nodes. -**ToolTip** - Allows us to show and hide tooltips for the nodes in the first column wherever necessary. +**ToolTip** - Allows showing or hiding tooltips for the nodes in the first column wherever necessary. -**Custom Control** - Support for custom control feature allows to add custom controls to the tree node of the first column alone. +**Custom Control** - Supports adding custom controls to a tree node in the first column only. -**Multiline Support** - TreeNodeAdv has now provided option to enable multiline text for each node by using the Multiline property which is available for individual nodes. This can be set through NodeCollection Editor and it has to be set for individual nodes. +**Multiline Support** - TreeNodeAdv provides an option to enable multiline text for each node by using the `Multiline` property on `TreeNodeAdvStyleInfo`. This must be set for each individual node and is available through the NodeCollection Editor. -**Enhanced performance** - MultiColumnTreeView control can be populated with large number of nodes on node expand / collapse. The performance while populating the MultiColumnTreeView with large number of nodes can be improved by the SuspendExpandRecalculate property. +**Enhanced performance** - MultiColumnTreeView can be populated with a large number of nodes. Performance when expanding or collapsing nodes can be improved by setting the `SuspendExpandRecalculate` property. See [Performance](performance) for details. diff --git a/WindowsForms/MultiColumn-TreeView/Performance.md b/WindowsForms/MultiColumn-TreeView/Performance.md index 30bc0c3f7..e483e58e0 100644 --- a/WindowsForms/MultiColumn-TreeView/Performance.md +++ b/WindowsForms/MultiColumn-TreeView/Performance.md @@ -13,8 +13,8 @@ The performance of the MultiColumnTreeView can be improved by using the followin ## SuspendExpandRecalculate -When the `SuspendExpandRecalculate` property is set to true, the populating time nearly reduces to half of its original time by recalculating the nodes maximum height while expanding and collapsing. -The unnecessary calling of Recalculate dimensions for the child nodes when the Root nodes are collapsed is also reduced. +When the `SuspendExpandRecalculate` property is set to `true`, the populating time is nearly halved by recalculating the maximum height of the nodes only while expanding and collapsing. +This also reduces the unnecessary recalculation of dimensions for child nodes when the root nodes are collapsed. {% tabs %} @@ -32,7 +32,7 @@ Me.multiColumnTreeView1.SuspendExpandRecalculate = True {% endtabs %} -The below methods can be used to temporarily stop painting of nodes and new nodes can be added to the control in between these methods +The following methods can be used to temporarily stop painting of nodes so that new nodes can be added to the control in between these calls.
diff --git a/WindowsForms/MultiColumn-TreeView/Sorting.md b/WindowsForms/MultiColumn-TreeView/Sorting.md index 8fcb724c2..9c74b90c4 100644 --- a/WindowsForms/MultiColumn-TreeView/Sorting.md +++ b/WindowsForms/MultiColumn-TreeView/Sorting.md @@ -9,9 +9,9 @@ documentation: ug # Sorting in Windows Forms MultiColumn TreeView -Sorting can be performed on the tree nodes using the Sort function and specifying the function to be performed on either the checkbox or tag or text values in ascending or descending order. +Nodes can be sorted by the check box, tag, or text values, in ascending or descending order. -The Sort operation sorts only the level 1 nodes. To perform the function on the other levels of nodes, the `SortWithChildNode` property should be set to true. The sort function can be performed using the Sort method in Tree node where sort order can be defined as an argument in the method. +The sort operation sorts only the level 1 nodes. To sort the other levels of nodes, the `SortWithChildNode` property should be set to `true`. The sort function can be performed using the `Sort` method on a TreeNodeAdv collection, where the sort order is defined as an argument of the method. **Method Table** @@ -43,7 +43,7 @@ Me.MultiColumnTreeView1.Nodes.Sort(SortOrder.Descending) {% endtabs %} -The sort function can be done based on the value type which can be specified using SortType to either the option of Checkbox or Tag or Text. The order in which the sort function has to be performed can be specified using the SortOrder that holds the values of Ascending or Descending. +The sort can be performed on a specific value type, specified using `SortType` (Checkbox, Tag, or Text). The order of the sort is specified using `SortOrder`, which holds the values of `Ascending` or `Descending`.
@@ -81,18 +81,18 @@ Me.MultiColumnTreeView1.Nodes(0).SortOrder = SortOrder.Descending {% endtabs %} -* Sort in Ascending +* **Sort in Ascending** ![Sorting_img1](Sorting_Images/Sorting_img1.jpg) -* Sort in Descending +* **Sort in Descending** ![Sorting_img2](Sorting_Images/Sorting_img2.jpg) ## Comparing Options for Sorting -The CompareOptions property gives additional options of comparing the texts of the nodes. -The Comparer property is an object that implements the IComparer interface. If you need to compare the nodes by some other field, create an object of this type, set it to the node and that node will use the object in comparing the sub nodes. +The `CompareOptions` property specifies additional options for comparing node text during sorting. +The `Comparer` property is an object that implements the `IComparer` interface. If you need to compare the nodes by some other field, create an object of this type, set it to the node and that node will use the object to compare its child nodes. **Property Table** diff --git a/WindowsForms/MultiColumn-TreeView/Style-Architecture.md b/WindowsForms/MultiColumn-TreeView/Style-Architecture.md index a05e3e9c5..a1363034c 100644 --- a/WindowsForms/MultiColumn-TreeView/Style-Architecture.md +++ b/WindowsForms/MultiColumn-TreeView/Style-Architecture.md @@ -9,9 +9,9 @@ documentation: ug # Style Architecture in Windows Forms MultiColumn TreeView -The tree control employs an extensive Styles Architecture, that let users specify node styles globally, specifically for a class of nodes. This is possible by using a style information instance for each class of nodes, represented by a MultiColumnTreeView.TreeNodeAdvStyleInfo. Users will notice that for some of these classes of nodes, the style needs to be declared with a name at the tree level and stored in the tree’s BaseStyles hatch table. +The tree control employs an extensive Styles Architecture, that let users specify node styles globally, specifically for a class of nodes. This is possible by using a style information instance for each class of nodes, represented by a `MultiColumnTreeView.TreeNodeAdvStyleInfo`. Users will notice that for some of these classes of nodes, the style needs to be declared with a name at the tree level and stored in the tree's BaseStyles hash table. -As illustrated below, implicit style inheritance is enforced by the Framework while explicit style inheritance can be setup by the programmer. For all styles, explicit inheritance precedes implicit inheritance. +As illustrated below, implicit style inheritance is enforced by the Framework, while explicit style inheritance can be set up by the programmer. For all styles, explicit inheritance precedes implicit inheritance. ### Implicit Style Inheritance @@ -19,7 +19,7 @@ When a style is not set in a style info object, it inherits the style from the p * Node Specific Style: At the bottom of the hierarchy is the node specific style which lets users specify a style directly on a TreeNodeAdv. Refer Node specific Style. -* Node’s Child Style: Each node also exposes a ChildStyle property where you can specify the style for the immediate children of that node. Refer Child Style for setting style of children nodes. +* Node's Child Style: Each node also exposes a ChildStyle property where you can specify the style for the immediate children of that node. Refer Child Style for setting style of children nodes. * Node Level Styles: The Framework also lets you specify a style for all nodes at a level in the tree hierarchy, the top-most level being 1. Refer Node Level Style for setting node level style settings. @@ -31,7 +31,7 @@ When a style is not set in a style info object, it inherits the style from the p ### Explicit Style Inheritance -Any StyleInfo instance can also inherit explicitly from a specific named StyleInfo object. This can be done using the BaseStyle property of the TreeNodeAdvStyleInfo type. As noted previously, such named styles should be available in the tree control’s BaseStyles Collection Editor. You can also add custom styles using this editor. +Any StyleInfo instance can also inherit explicitly from a specific named StyleInfo object. This can be done using the BaseStyle property of the TreeNodeAdvStyleInfo type. As noted previously, such named styles should be available in the tree control's BaseStyles Collection Editor. You can also add custom styles using this editor.
@@ -67,12 +67,12 @@ StandardSubItemStyle
Indicates the style that all the sub items will inherit from.
-## StandardStyle +## StandardStyle -Setting a Common Style for all the Nodes in the MultiColumnTreeView +Setting a common style for all the nodes in the MultiColumnTreeView. -We can modify the background for all the children of a parent node by editing the StandardStyle property. -The below image displays a gradient style for all the columns of the MultiColumnTreeView control. +You can modify the background for all the children of a parent node by editing the `StandardStyle` property. +The following image displays a gradient style for all the columns of the MultiColumnTreeView control. ### StandardStyle Settings @@ -232,19 +232,19 @@ Specifies the sort type of the node.
Optioned -Gets or sets optioned state to a node
OptionButtonColor @@ -81,9 +81,9 @@ Me.multiColumnTreeView1.Nodes(0).Optioned = True ## CheckBox -The ShowCheckBoxes property when set will display check box for all the nodes. To apply checkbox to individual nodes, set the TreeNodeAdv.ShowCheckBox property, only for the required nodes in the NodeCollection Editor. +The `ShowCheckBoxes` property, when set, displays a check box for all the nodes. To apply the check box to individual nodes, set the `TreeNodeAdv.ShowCheckBox` property only for the required nodes in the NodeCollection Editor. -The InteractiveCheckBoxes indicates whether the state of the parent node’s checkbox is based on the check state of its child nodes checkboxes. To set this for individual nodes set the InteractiveCheckBox property of the TreeNodeAdv. +The `InteractiveCheckBoxes` property indicates whether the state of the parent node's check box is based on the check state of its child nodes' check boxes. To set this for individual nodes, set the `InteractiveCheckBox` property of the `TreeNodeAdv`. **Property Table** @@ -156,8 +156,8 @@ Me.multiColumnTreeView1.Nodes(0).Checked = True **Tristate CheckBox Settings** -In the MultiColumnTreeView, the partial checking of the child nodes is supported. They are Checked State, Unchecked State and Intermediate State. -The CheckColor and CheckState property is used to set the color and the state of the check mark of the selected node. The options for the CheckState property are Checked, Unchecked and Indeterminate. +In the MultiColumnTreeView, the partial checking of the child nodes is supported. They are Checked State, Unchecked State, and Intermediate State. +The `CheckColor` and `CheckState` properties are used to set the color and the state of the check mark of the selected node. The options for the `CheckState` property are `Checked`, `Unchecked`, and `Indeterminate`. *Property Table* @@ -200,8 +200,8 @@ TreeNodeAdv can hold controls using custom control feature. This increases the f ### LabelEdit -Indicates whether the label text of the tree nodes can be edited. By default, it is false . To edit the node,LabelEdit property must be set as true. BeforeEdit event occurs before a node gets into edit node. -For further details refer [editing event](https://help.syncfusion.com/windowsforms/multicolumn-treeview/multicolumntreeview-events#node-editing). +Indicates whether the label text of the tree nodes can be edited. By default, it is `false`. To edit a node, the `LabelEdit` property must be set to `true`. The `BeforeEdit` event occurs before a node enters edit mode. +For further details, refer to the [Editing Event](https://help.syncfusion.com/windowsforms/multicolumn-treeview/multicolumntreeview-events#node-editing). From ac89730a029af7582ec2cc50f38b25a723ff68c6 Mon Sep 17 00:00:00 2001 From: harinath-2699 Date: Wed, 8 Jul 2026 14:54:43 +0530 Subject: [PATCH 04/36] Documentation(1039182): Update the UG Documentation for Winforms control --- WindowsForms/Docking-Manager/Appearance.md | 14 +- .../Docking-Manager/Auto-Hide-Window.md | 12 +- .../Dealing-with-docking-child.md | 6 +- WindowsForms/Docking-Manager/Dock-Window.md | 12 +- .../Docking-Manager/Docking-Client-Panel.md | 2 +- .../Docking-Manager/Docking-Events.md | 149 ++++++++++-------- .../Docking-Manager/Floating-Window.md | 6 +- .../Docking-Manager/Getting-Started.md | 2 +- WindowsForms/Docking-Manager/MDI-Window.md | 8 +- WindowsForms/Docking-Manager/Overview.md | 2 +- WindowsForms/Docking-Manager/Serialization.md | 8 +- WindowsForms/Docking-Manager/TDI-Window.md | 6 +- WindowsForms/Docking-Manager/Tabbed-Window.md | 6 +- WindowsForms/Ribbon/Appearance.md | 6 +- WindowsForms/Ribbon/Application-Menu.md | 4 +- WindowsForms/Ribbon/Backstage.md | 6 +- WindowsForms/Ribbon/Contextual-Tab-Group.md | 2 +- WindowsForms/Ribbon/Customization-Support.md | 4 +- WindowsForms/Ribbon/Getting-Started.md | 8 +- WindowsForms/Ribbon/Keyboard-Support.md | 2 +- WindowsForms/Ribbon/Localization-Support.md | 6 +- WindowsForms/Ribbon/Mini-ToolBar.md | 29 ++-- WindowsForms/Ribbon/Quick-Access-Toolbar.md | 2 +- WindowsForms/Ribbon/Ribbon-Form.md | 10 +- WindowsForms/Ribbon/Ribbon-Merge-Support.md | 2 +- WindowsForms/Ribbon/Serialization-Support.md | 26 +-- WindowsForms/Ribbon/SimplifiedLayout.md | 2 +- WindowsForms/Ribbon/ToolTip-Support.md | 2 +- WindowsForms/Ribbon/Touch-Support.md | 2 +- WindowsForms/Ribbon/Working-with-Ribbon.md | 7 +- WindowsForms/Ribbon/Working-with-Tabs.md | 2 +- 31 files changed, 185 insertions(+), 170 deletions(-) diff --git a/WindowsForms/Docking-Manager/Appearance.md b/WindowsForms/Docking-Manager/Appearance.md index 4c41a6e25..9d4ca0a3f 100644 --- a/WindowsForms/Docking-Manager/Appearance.md +++ b/WindowsForms/Docking-Manager/Appearance.md @@ -215,7 +215,7 @@ Me.dockingManager1.VisualStyle = Syncfusion.Windows.Forms.VisualStyle.VS2005 **VS2010** -This option helps to set the VS2010 style. +This option helps to set the Visual Studio 2010 style. {% tabs %} @@ -557,7 +557,7 @@ Me.DockingManager1.InActiveCaptionFont = New System.Drawing.Font("Arial", 11.25! The border color of the docked controls can be customized by using the [BorderColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_BorderColor) property of the docking manager. -N> The [PaintBorders](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_PaintBorders) property must be enabled to effect this setting. +N> The [PaintBorders](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_PaintBorders) property must be enabled to affect this setting. {% tabs %} @@ -983,7 +983,7 @@ In docking manager, you can customize the AutoHidden window tabs foreground, fon The font style of the auto hidden tabs can be customized by using the [AutoHideTabFont](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_AutoHideTabFont) property of the docking manager. The height of AutoHidden tab control can be customized by using the [AutoHideTabHeight](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_AutoHideTabHeight) property. -N> This setting will effect only when the [DockingManager.VisualStyle](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_VisualStyle) property is set as default. +N> This setting will affect only when the [DockingManager.VisualStyle](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_VisualStyle) property is set as default. {% tabs %} @@ -1276,15 +1276,15 @@ this.RightToLeft = RightToLeft.Yes; {% endhighlight %} -{% highlight VB %}l +{% highlight VB %} -'Enable the Right to Left +'Enable the Right to Left -Me.dockingManager1.HostControl = this +Me.dockingManager1.HostControl = Me Me.RightToLeft = RightToLeft.Yes -{% endhighlight %} +{% endhighlight %} {% endtabs %} diff --git a/WindowsForms/Docking-Manager/Auto-Hide-Window.md b/WindowsForms/Docking-Manager/Auto-Hide-Window.md index 3096f0bf3..97675d2f0 100644 --- a/WindowsForms/Docking-Manager/Auto-Hide-Window.md +++ b/WindowsForms/Docking-Manager/Auto-Hide-Window.md @@ -279,15 +279,15 @@ The [AnimationStep](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windo {% highlight C# %} -DockingManager.AnimationStep = arg.Bounds.Width; +this.dockingManager1.AnimationStep = arg.Bounds.Width; {% endhighlight %} {% highlight VB %} -'Prevent the tabbed controls from moving +'Set the animation step for auto-hidden controls -DockingManager.AnimationStep = arg.Bounds.Width +Me.dockingManager1.AnimationStep = arg.Bounds.Width {% endhighlight %} @@ -301,15 +301,15 @@ By using the [AutoHideInterval](https://help.syncfusion.com/cr/windowsforms/Sync {% highlight C# %} -this.dockingManager1.AutoHideInterval=3000; +this.dockingManager1.AutoHideInterval = 3000; {% endhighlight %} {% highlight VB %} -'Prevent the tabbed controls from moving +'Set the auto-hide interval in milliseconds -Me.dockingManager1.AutoHideInterval=3000 +Me.dockingManager1.AutoHideInterval = 3000 {% endhighlight %} diff --git a/WindowsForms/Docking-Manager/Dealing-with-docking-child.md b/WindowsForms/Docking-Manager/Dealing-with-docking-child.md index 5abb4f5fa..a041ccc46 100644 --- a/WindowsForms/Docking-Manager/Dealing-with-docking-child.md +++ b/WindowsForms/Docking-Manager/Dealing-with-docking-child.md @@ -159,7 +159,7 @@ this.dockingManager1.GetDockAbility(this.panel1); //Setting the Dock Ability -this.dockingManager1.SetDockAbility(this.panel1, "Top"); +this.dockingManager1.SetDockAbility(this.panel1, Syncfusion.Windows.Forms.Tools.DockAbility.Top); {% endhighlight %} @@ -171,7 +171,7 @@ Me.dockingManager1.GetDockAbility(Me.panel1) //Setting the Dock Ability -Me.dockingManager1.SetDockAbility(Me.panel1, "Top") +Me.dockingManager1.SetDockAbility(Me.panel1, Syncfusion.Windows.Forms.Tools.DockAbility.Top) {% endhighlight %} @@ -340,7 +340,7 @@ You can show or hide the tooltip in docked, tabbed, and auto hide windows using ![Tooltip for dock windows in DockingManager](Dealing-with-Windows_images/Dealing-with-Windows_img5.png) -N> The [EnableSuperTooltip](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_EnableSuperToolTip) property should be set to `false` to effect the above default tooltip. +N> The [EnableSuperTooltip](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_EnableSuperToolTip) property should be set to `false` to affect the above default tooltip. ## Remove particular caption button diff --git a/WindowsForms/Docking-Manager/Dock-Window.md b/WindowsForms/Docking-Manager/Dock-Window.md index 78aec5e81..5ebff8c50 100644 --- a/WindowsForms/Docking-Manager/Dock-Window.md +++ b/WindowsForms/Docking-Manager/Dock-Window.md @@ -99,7 +99,7 @@ Me.dockingManager1.DockControl(Me.panel4, Me, Syncfusion.Windows.Forms.Tools.Doc ## Dock window to another window -Provides support to dock a window inside another window with the help of drag providers. This can be done programmatically by using the [DockControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_DockControl_System_Windows_Forms_Control_System_Windows_Forms_Control_Syncfusion_Windows_Forms_Tools_DockingStyle_System_Int32_) function. +Provides support to dock a window inside another window using drag provider styles. This can be done programmatically by using the [DockControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_DockControl_System_Windows_Forms_Control_System_Windows_Forms_Control_Syncfusion_Windows_Forms_Tools_DockingStyle_System_Int32_) function. ![Dock one window over another dock window in DockingManager](Dock_Window_images/Dock_Window_img18.png) @@ -124,7 +124,7 @@ Me.dockingManager1.DockControl(Me.panel4, Me.panel1, Syncfusion.Windows.Forms.To ## Detect dock style -Docking style that is assigned to the control can be detect at run time using the [GetDockStyle](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_GetDockStyle_System_Windows_Forms_Control_) function. +Docking style that is assigned to the control can be detected at run time using the [GetDockStyle](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_GetDockStyle_System_Windows_Forms_Control_) function. {% tabs %} @@ -179,11 +179,9 @@ Dock panel size can be resized at run time using the splitters between the dock //Get the size of docked or Floating control using the GetControlSize function. -this.dockingManager1.GetControlSize(this.panel2); - Console.Write("Size" + this.dockingManager1.GetControlSize(this.panel2)); -//Set the size of docked or Floating control using the GetControlSize function. +//Set the size of docked or Floating control using the SetControlSize function. this.dockingManager1.SetControlSize(this.panel1, new Size(200, 200)); @@ -230,7 +228,7 @@ This overloaded function returns the index of image associated with the docking {% highlight C# %} -System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(GetIconFile(@"..\\..\\\$this.Icon.ico"))); +System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(@"..\\..\\\$this.Icon.ico")); private string GetIconFile(string bitmapName) { @@ -254,7 +252,7 @@ this.dockingManager1.SetDockIcon(this.panel1, icon); {% highlight VB %} -Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile(GetIconFile("..\\..\\\$this.Icon.ico"))) +Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile("..\\..\\\$this.Icon.ico")) Private Function GetIconFile(ByVal bitmapName As String) As String diff --git a/WindowsForms/Docking-Manager/Docking-Client-Panel.md b/WindowsForms/Docking-Manager/Docking-Client-Panel.md index 5cd4c5916..d76879097 100644 --- a/WindowsForms/Docking-Manager/Docking-Client-Panel.md +++ b/WindowsForms/Docking-Manager/Docking-Client-Panel.md @@ -23,7 +23,7 @@ N> The docking client panel control is intended only for use with forms that do The following are the steps involved in setting up a docking layout on a non-MDIContainer form using the docking client panel. The docking client panel is used here because in addition to docking windows, the host form contains several non-dockable controls that require a container with static relative bounds to implement positioning and layout management. -1. Add the docking manager to the form and apply the `EnableDocking` for those controls that need to be set as docking windows. +1. Add the docking manager to the form and call `SetEnableDocking` for those controls that need to be set as docking windows. 2. Select the docking client panel control from the designer tool box and drop it to the form hosting the docking manager. Size the control, so that its bounds can accommodate any non-dockable child controls that may already be present on the form. 3. If any non-dockable controls are present in the form, then drag-and-drop the controls to the docking client panel instance. 4. Set the DockingClientPanel.SizeToFit property to `true`. Turning on the SizeToFit property forces the DockingClientPanel to start interacting with the Essential® Tools docking architecture. The control will automatically be resized/repositioned to occupy the form's client bounds or left unoccupied by the docking windows. diff --git a/WindowsForms/Docking-Manager/Docking-Events.md b/WindowsForms/Docking-Manager/Docking-Events.md index 61535f022..86452bbcc 100644 --- a/WindowsForms/Docking-Manager/Docking-Events.md +++ b/WindowsForms/Docking-Manager/Docking-Events.md @@ -1,4 +1,4 @@ ---- +--- layout: post title: Docking Events in Windows Forms Docking Manager control | Syncfusion® description: Learn about Docking Events support in Syncfusion® Windows Forms Docking Manager control and more details. @@ -214,7 +214,7 @@ The [DockControlDeactivated](https://help.syncfusion.com/cr/windowsforms/Syncfus #### Event data -The event handler receives a [DockedActivationChangedEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockActivationChangedEventArgs.html) argument containing data related to this event. The following DockActivationChangedEventArgs members provide information specific to this event. +The event handler receives a [DockActivationChangedEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockActivationChangedEventArgs.html) argument containing data related to this event. The following DockActivationChangedEventArgs members provide information specific to this event. @@ -274,11 +274,34 @@ End Sub The [DockAllow](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html) event occurs when a docking window is dragged over a potential dock target. This event helps to cancel the operation that is performed during the docking of windows. +#### Event data + +The event handler receives a [DockAllowEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockAllowEventArgs.html) argument containing data related to this event. The following DockAllowEventArgs members provide information specific to this event. + +
+ + + + + + + + +
+Member +Description
+{{ '[Cancel](https://help.syncfusion.com/cr/windowsforms/Syncfusion.ComponentModel.SyncfusionCancelEventArgs.html)' | markdownify }} +Gets or sets a value indicating whether the docking operation should be cancelled.
+Source +Gets the control that is being dragged.
+Target +Gets the control over which the dragged window is currently positioned.
+ {% tabs %} {% highlight C# %} -Private void DockingManager1_DockAllow(object sender, DockAllowEventArgs arg) +private void DockingManager1_DockAllow(object sender, DockAllowEventArgs arg) { arg.Cancel = true; } @@ -468,7 +491,7 @@ End Sub ## Caption double-click -The [OnCaptionDoubleClick](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html) event occurs when you double-click a dockable control or a docked control caption. This event is triggered when the [EnableDoubleClickOnCaption](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_EnableDoubleClickOnCaption) property is set to `false`. It displays the currently active control name. +The [OnCaptionDoubleClick](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html) event occurs when you double-click a dockable control or a docked control caption. This event is triggered when the [EnableDoubleClickOnCaption](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_EnableDoubleClickOnCaption) property is set to `true`. It displays the currently active control name. ### Event data @@ -509,17 +532,17 @@ private void dockingManager1_OnCaptionDoubleClick(object sender, Syncfusion.Wind 'The DockControlActivated event occurs when a dockable control gets activated. -Private Sub dockingManager1_OnCaptionDoubleClick(ByVal sender As Object, ByVal arg AsSyncfusion.Windows.Forms.Tools.DockActivationChangedEventArgs) +Private Sub dockingManager1_OnCaptionDoubleClick(ByVal sender As Object, ByVal arg As Syncfusion.Windows.Forms.Tools.DockControlMouseSelection) 'OnCaptionDoubleClick event is triggered - Console.WriteLine("Dock Control Activated Event is Fired"); + Console.WriteLine("On Caption Double Click Event is Fired") 'Displays the name of the control that is currently active. - Console.WriteLine("Activated Control Name : "+arg.Control.Name); + Console.WriteLine("Activated Control Name : " + arg.Control.Name) -End Sub +End Sub {% endhighlight %} @@ -666,7 +689,7 @@ Me.bar1.Text = "Exit" Me.fileItem.Items.AddRange(New Syncfusion.Windows.Forms.Tools.XPMenus.BarItem() { Me.bar1}) -//handling the event +'handling the event Private Sub dockingManager1_DockContextMenu(ByVal sender As Object, ByVal arg As Syncfusion.Windows.Forms.Tools.DockContextMenuEventArgs) @@ -830,9 +853,9 @@ private void dockingManager1_ControlMaximized(object sender, Syncfusion.Windows. Console.WriteLine("Control Name : "+arg.Control.Name); - //Cancel is the Boolean property which can prevent docking event when it is true. + //Displays the docked control name - arg.Cancel=true; + Console.WriteLine("Control Name : "+arg.Control.Name); } @@ -851,10 +874,6 @@ Private Sub dockingManager1_ControlMaximized(ByVal sender As Object, ByVal arg A Console.WriteLine("Control Name : "+arg.Control.Name) - 'Cancel is the Boolean property which can prevent docking event when it is true. - - arg.Cancel=True - End Sub {% endhighlight %} @@ -1010,6 +1029,7 @@ private void dockingManager1_DockStateChanged(object sender, Syncfusion.Windows. { + Console.WriteLine("DockStateChanged Event has occurred"); Console.WriteLine("Total Number of controls in a group : " + arg.Controls.Length.ToString()); @@ -1131,8 +1151,7 @@ private void dockingManager1_DockStateChanging(object sender, Syncfusion.Windows } //handle the dock state changing for Panel1 - - if (this.panel1 == ctrl) + if (arg.Controls.Contains(this.panel1)) { arg.Handled = true; } @@ -1140,11 +1159,11 @@ private void dockingManager1_DockStateChanging(object sender, Syncfusion.Windows { arg.Handled = false; } - + // arg.OldState indicates the old state of dock child. Console.WriteLine("Old DockState:"+ arg.OldState.ToString()); - // arg.NewValue indicates the new state of dock child. + // arg.NewState indicates the new state of dock child. Console.WriteLine("New DockState:" +arg.NewState.ToString()); @@ -1180,20 +1199,16 @@ Private Sub dockingManager1_DockStateChanging(ByVal sender As Object, ByVal arg Next 'handle the dock state changing for Panel1 - - If Me.panel1 Is ctrl Then - arg.Handled = Truetrue; - } + If arg.Controls.Contains(Me.panel1) Then + arg.Handled = True Else - arg.Handled = False - End If - Next ctrl + arg.Handled = False + End If - 'arg.OldState indicates the old state of dock child Console.WriteLine("Old DockState:" & arg.OldState.ToString()) - 'arg.NewValue indicates the new state of dock child. + 'arg.NewState indicates the new state of dock child. Console.WriteLine("New DockState:" & arg.NewState.ToString()) End Sub @@ -1700,23 +1715,19 @@ private void dockingManager1_DragFeedbackStart(object sender, System.EventArgs e //The following code is used to display all control names which are in the DockingManager. - Syncfusion.Windows.Forms.Tools.DockingManager ctrl=sender as - - Syncfusion.Windows.Forms.Tools.DockingManager; - - IEnumerator enumerator = ctrl.Controls; + Syncfusion.Windows.Forms.Tools.DockingManager ctrl = sender as Syncfusion.Windows.Forms.Tools.DockingManager; - ArrayList dockedControls = new ArrayList(); + if (ctrl != null) - while(enumerator.MoveNext()) + { - dockedControls.Add(enumerator.Current); + foreach (Control c in ctrl.Controls) - foreach(Control c in dockedControls) + { - { + Console.WriteLine("Control Name :" + c.Name); - Console.WriteLine("Control Name :" + c.Name); + } } @@ -1733,23 +1744,17 @@ Private Sub dockingManager1_DragFeedbackStart(ByVal sender As Object, ByVal e As Console.WriteLine("DragFeedbackStart Event has been ") - Dim ctrl As Syncfusion.Windows.Forms.Tools.DockingManager = CType(ConversionHelpers.AsWorkaround(sender, GetType(Syncfusion.Windows.Forms.Tools.DockingManager)), Syncfusion.Windows.Forms.Tools.DockingManager) - - Dim enumerator As IEnumerator = ctrl.Controls + Dim ctrl As Syncfusion.Windows.Forms.Tools.DockingManager = TryCast(sender, Syncfusion.Windows.Forms.Tools.DockingManager) - Dim dockedControls As ArrayList = New ArrayList + If ctrl IsNot Nothing Then - While enumerator.MoveNext + For Each c As Control In ctrl.Controls - dockedControls.Add(enumerator.Current) + Console.WriteLine("Control Name :" + c.Name) - End While + Next - For Each c As Control In dockedControls - - Console.WriteLine("Control Name :" + c.Name) - - Next + End If End Sub @@ -1830,11 +1835,15 @@ protected void DockingManager_TransferredToManager(object sender, TransferManage Console.WriteLine("Transferred to Manager Event has been Raised"); - DockableControlBase dockableControl = args.Control as DockableControlBase; + DockingManager manager = sender as DockingManager; + + if (manager != null) - dockableControl.CurrentDockingManager = sender as DockingManager; + { - Console.WriteLine("HostControl Name (Target Page Name) : "+dockableControl.CurrentDockingManager.HostControl.Name); + Console.WriteLine("HostControl Name (Target Page Name) : " + manager.HostControl.Name); + + } } @@ -1847,11 +1856,13 @@ Protected Sub DockingManager_TransferredToManager(ByVal sender As Object, ByVal Console.WriteLine("Transferred to Manager Event has been Raised") - Dim dockableControl As DockableControlBase = CType(ConversionHelpers.AsWorkaround(args.Control, GetType(DockableControlBase)), DockableControlBase) + Dim manager As DockingManager = TryCast(sender, DockingManager) + + If manager IsNot Nothing Then - dockableControl.CurrentDockingManager = CType(ConversionHelpers.AsWorkaround(sender, GetType(DockingManager)), DockingManager) + Console.WriteLine("HostControl Name (Target Page Name) : " + manager.HostControl.Name) - Console.WriteLine("HostControl Name (Target Page Name) : " + dockableControl.CurrentDockingManager.HostControl.Name) + End If End Sub @@ -1890,11 +1901,15 @@ protected void DockingManager_TransferringFromManager(object sender, TransferMan Console.WriteLine("Transferring From Manager Event has been raised"); - DockableControlBase dockableControl = args.Control as DockableControlBase; + DockingManager manager = sender as DockingManager; - dockableControl.CurrentDockingManager = sender as DockingManager; + if (manager != null) - Console.WriteLine("HostControl name : "+dockableControl.CurrentDockingManager.HostControl.Name); + { + + Console.WriteLine("HostControl name : " + manager.HostControl.Name); + + } } @@ -1909,11 +1924,13 @@ Protected Sub DockingManager_TransferringFromManager(ByVal sender As Object, ByV Console.WriteLine("Transferring From Manager Event has been raised") - Dim dockableControl As DockableControlBase = CType(ConversionHelpers.AsWorkaround(args.Control, GetType(DockableControlBase)), DockableControlBase) + Dim manager As DockingManager = TryCast(sender, DockingManager) + + If manager IsNot Nothing Then - dockableControl.CurrentDockingManager = CType(ConversionHelpers.AsWorkaround(sender, GetType(DockingManager)), DockingManager) + Console.WriteLine("HostControl name : " + manager.HostControl.Name) - Console.WriteLine("HostControl name : " + dockableControl.CurrentDockingManager.HostControl.Name) + End If End Sub @@ -2005,7 +2022,7 @@ Protected Sub DockingManager_InitializeControlOnLoad(ByVal sender As Object, ByV Console.WriteLine("InitializeControlOnLoad Event is Raised for the Control : " + args.ControlName) - Dim dockingManager As DockingManager = CType(ConversionHelpers.AsWorkaround(sender, GetType(DockingManager)), DockingManager) + Dim dockingManager As DockingManager = TryCast(sender, DockingManager) Select Case args.ControlName @@ -2267,11 +2284,11 @@ protected void DockingManager_ProvidePersistenceID(object sender,Syncfusion.Wind 'instances of the Form type. -Protected Sub DockingManager_ProvidePersistenceID(ByVal sender As Object, ByVal e AsSyncfusion.Windows.Forms.ProvidePersistenceIDEventArgs) +Protected Sub DockingManager_ProvidePersistenceID(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.ProvidePersistenceIDEventArgs) Console.WriteLine("Provide Persistence ID Event has been raised") - Dim dockingManager As Syncfusion.Windows.Forms.Tools.DockingManager = CType(ConversionHelpers.AsWorkaround(sender, GetType(DockingManager)), DockingManager) + Dim dockingManager As Syncfusion.Windows.Forms.Tools.DockingManager = TryCast(sender, Syncfusion.Windows.Forms.Tools.DockingManager) Console.WriteLine("Host control name = " + dockingManager.HostControl.Name.ToString) diff --git a/WindowsForms/Docking-Manager/Floating-Window.md b/WindowsForms/Docking-Manager/Floating-Window.md index c82dd89c8..b595b67fb 100644 --- a/WindowsForms/Docking-Manager/Floating-Window.md +++ b/WindowsForms/Docking-Manager/Floating-Window.md @@ -376,15 +376,15 @@ The [GetFloatOnly](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Window this.dockingManager1.SetFloatOnly(this.panel1, true); -Console.Write("IsAlways in FloatState:" + this.dockingManager1.SetFloatOnly(this.panel1, true)); +Console.Write("IsAlways in FloatState:" + this.dockingManager1.GetFloatOnly(this.panel1)); {% endhighlight %} {% highlight VB %} -Me.dockingManager1.SetFloatOnly(this.panel1, True) +Me.dockingManager1.SetFloatOnly(Me.panel1, True) -Console.Write("IsAlways in FloatState:" + Me.dockingManager1.SetFloatOnly(Me.panel1, True)) +Console.Write("IsAlways in FloatState:" & Me.dockingManager1.GetFloatOnly(Me.panel1)) {% endhighlight %} diff --git a/WindowsForms/Docking-Manager/Getting-Started.md b/WindowsForms/Docking-Manager/Getting-Started.md index 37e1e8ede..d68a94c92 100644 --- a/WindowsForms/Docking-Manager/Getting-Started.md +++ b/WindowsForms/Docking-Manager/Getting-Started.md @@ -497,4 +497,4 @@ Me.dockingManager.LoadDockState(serializer, this.listBox1) {% endtabs %} -N> You can explore our [WinForms Docking Manager example](https://github.com/syncfusion/winforms-demos/tree/master/edit) that shows how to render the Docking Manager in Windows Forms. \ No newline at end of file +N> You can explore our [WinForms Docking Manager example](https://github.com/syncfusion/winforms-demos) that shows how to render the Docking Manager in Windows Forms. \ No newline at end of file diff --git a/WindowsForms/Docking-Manager/MDI-Window.md b/WindowsForms/Docking-Manager/MDI-Window.md index 054949bb8..df3db82cf 100644 --- a/WindowsForms/Docking-Manager/MDI-Window.md +++ b/WindowsForms/Docking-Manager/MDI-Window.md @@ -90,7 +90,7 @@ Dim tabbedMDI As New TabbedMDIManager() tabbedMDI.AttachToMdiContainer(Me) -Me.tabbedMDIManager.TabStyle = GetType(Syncfusion.Windows.Forms.Tools.TabRendererOffice2016Colorful) +tabbedMDI.TabStyle = GetType(Syncfusion.Windows.Forms.Tools.TabRendererOffice2016Colorful) 'To set as MDI Child window @@ -115,7 +115,7 @@ C:\Users\<User>\AppData\Local\Syncfusion\EssentialStudio\Version Number\Wi {% highlight C# %} -System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(GetIconFile(@"..\\..\\\$this.Icon.ico"))); +System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(@"..\\..\\\$this.Icon.ico")); //To set icon in MDI Child window this.dockingManager1.SetMDIChildIcon(panel2, icon); @@ -141,7 +141,7 @@ private string GetIconFile(string bitmapName) {% highlight VB %} -Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile(GetIconFile("..\\..\\\$this.Icon.ico"))) +Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile("..\\..\\\$this.Icon.ico")) 'To set icon in MDI Child window Me.dockingManager1.SetMDIChildIcon(panel2, icon) @@ -200,7 +200,7 @@ Me.dockingManager1.SetAsMDIChild(panel2,True, New Rectangle(200, 400, 250, 250)) ![Change MDI window size in DockingManager](MDI_Window_images/MDI_Window_img5.png) -## Change MDI window to dock window +## Convert MDI child to dock window The MDI window can be moved to dock state by using its ContextMenu option. This can also be done programmatically by using the [SetAsMDIChild](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_SetAsMDIChild_System_Windows_Forms_Control_System_Boolean_) function. diff --git a/WindowsForms/Docking-Manager/Overview.md b/WindowsForms/Docking-Manager/Overview.md index 62a69bf21..263dc9808 100644 --- a/WindowsForms/Docking-Manager/Overview.md +++ b/WindowsForms/Docking-Manager/Overview.md @@ -9,7 +9,7 @@ documentation: ug # Windows Forms Docking Manager Overview -The `DockingManager` control implements an architecture that allows panels to be docked at any part of form. The dock panels containing child elements can be interactively dragged to any area within screen and can be resized at run time. Panels can be docked to form edges or each other panels. Dock panels can also be floated, tabbed, and auto hidden. +The `DockingManager` control implements an architecture that allows panels to be docked at any part of form. The dock panels containing child elements can be interactively dragged to any area within screen and can be resized at run time. Panels can be docked to the form's edges or to other panels. Dock panels can also be floated, tabbed, and auto hidden. ![Visual Style Dock windows in DockingManager](GettingStarted_images/VisualStudioDemo.png) diff --git a/WindowsForms/Docking-Manager/Serialization.md b/WindowsForms/Docking-Manager/Serialization.md index 594bcd17b..192e72dc5 100644 --- a/WindowsForms/Docking-Manager/Serialization.md +++ b/WindowsForms/Docking-Manager/Serialization.md @@ -124,11 +124,11 @@ this.dockingManager1.LoadDockState(serializer, this.listBox1); {% highlight VB %} -Me.dockingManager1.LoadDockState(serializer) +Me.dockingManager1.LoadDockState() -Me.dockingManager1.LoadDockState(); +Me.dockingManager1.LoadDockState(serializer) -Me.dockingManager1.LoadDockState(serializer, this.listBox1) +Me.dockingManager1.LoadDockState(serializer, Me.listBox1) {% endhighlight %} @@ -349,7 +349,7 @@ Me.dockingManager1.LoadDockState(serializer) {% endtabs %} -Calling the [GetSerializedControls](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_GetSerializedControls_Syncfusion_Runtime_Serialization_AppStateSerializer_) function returns the serialized control collection enumerator in the specified serializer. This can be done using the following code. +Calling the [GetSerializedControls](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.DockingManager.html#Syncfusion_Windows_Forms_Tools_DockingManager_GetSerializedControls_Syncfusion_Runtime_Serialization_AppStateSerializer_) function returns an enumerator of the controls serialized in the specified serializer. This can be done using the following code. diff --git a/WindowsForms/Docking-Manager/TDI-Window.md b/WindowsForms/Docking-Manager/TDI-Window.md index d76f39adb..6ba67b429 100644 --- a/WindowsForms/Docking-Manager/TDI-Window.md +++ b/WindowsForms/Docking-Manager/TDI-Window.md @@ -36,8 +36,8 @@ Provides support for adding tabbed document windows in the docking manager. To e {% highlight VB %} 'Invoking the NewDockStateEndLoad event. -Me.dockingManager1.NewDockStateEndLoad += DockingManager1_NewDockStateEndLoad - +AddHandler Me.dockingManager1.NewDockStateEndLoad, AddressOf DockingManager1_NewDockStateEndLoad + Private Sub DockingManager1_NewDockStateEndLoad(ByVal sender As Object, ByVal e As EventArgs) 'To add TDI child @@ -182,7 +182,7 @@ MessageBox.Show(this.dockingManager1.IsFrozenToDocumentState(this.panel1).ToStri ## Creating Document Tab Group -The DockingManger allows to create document tab groups like Visual Studio. The document tab groups can be grouped using the drag-and-drop operations and also using the options in context menu items. +The DockingManager allows to create document tab groups like Visual Studio. The document tab groups can be grouped using the drag-and-drop operations and also using the options in context menu items. ### Create tab group using context menu option diff --git a/WindowsForms/Docking-Manager/Tabbed-Window.md b/WindowsForms/Docking-Manager/Tabbed-Window.md index e135777b7..26c15d6c7 100644 --- a/WindowsForms/Docking-Manager/Tabbed-Window.md +++ b/WindowsForms/Docking-Manager/Tabbed-Window.md @@ -119,14 +119,14 @@ You can restrict the specific [DockAbility](https://help.syncfusion.com/cr/windo {% highlight C# %} -this.dockingManager1.SetDockAbility(panel1, "Top"); +this.dockingManager1.SetDockAbility(panel1, Syncfusion.Windows.Forms.Tools.DockAbility.Top); {% endhighlight %} {% highlight VB %} -this.dockingManager1.SetDockAbility(panel1, "Top"); +Me.dockingManager1.SetDockAbility(panel1, Syncfusion.Windows.Forms.Tools.DockAbility.Top) {% endhighlight %} @@ -220,7 +220,7 @@ By using [GetTabPosition](https://help.syncfusion.com/cr/windowsforms/Syncfusion {% highlight C# %} -/Getting the tab position +///Getting the tab position this.dockingManager1.GetTabPosition(panel1); diff --git a/WindowsForms/Ribbon/Appearance.md b/WindowsForms/Ribbon/Appearance.md index a936f07eb..16166a59e 100644 --- a/WindowsForms/Ribbon/Appearance.md +++ b/WindowsForms/Ribbon/Appearance.md @@ -517,7 +517,7 @@ this.ribbonControlAdv1.Office2016ColorTable.Add(color); ![WindowsForms Ribbon customized with Office2016ColorTable](Appearance_Images/WindowsForms-Ribbon-customized-with-Office2016ColorTable.jpg) -**Offcie2013 Style Color Table** +**Office2013 Style Color Table** RibbonControlAdv can now be fully customized in Office 2013 style. This can be achieved by using Office2013ColorTable property. @@ -1028,11 +1028,11 @@ this.ribbonControlAdv1.ApplyTouchStyleColorTable(_touchColorTable); _touchColorTable.ToolstripTabItemForeColor = Color.White - // To set the hover fore color for BackStage items. + ' To set the hover fore color for BackStage items. _touchColorTable.BackStageItemHoverForeColor = Color.White - // To set the selection fore color for BackStage items. + ' To set the selection fore color for BackStage items. _touchColorTable.BackStageItemSelectionForeColor = Color.White diff --git a/WindowsForms/Ribbon/Application-Menu.md b/WindowsForms/Ribbon/Application-Menu.md index 8ca6a1cb4..f081141ff 100644 --- a/WindowsForms/Ribbon/Application-Menu.md +++ b/WindowsForms/Ribbon/Application-Menu.md @@ -9,7 +9,7 @@ documentation: ug # Application Menu in Windows Forms Ribbon (RibbonControlAdv) -The RibbonControlAdv has the office menu button at the top left corner of the form. Controls can be added to the panels of the office menu button dropdown through designer without a single piece of code. +The RibbonControlAdv has the Office menu button at the top left corner of the form. Controls can be added to the panels of the Office menu dropdown through the designer, without writing any code. ## Open ApplicationMenu @@ -68,7 +68,7 @@ You can hide or minimize the menu bar panel by setting the [MinimizePanel](https {% tabs %} -{% highlight C# %} +{% highlight c# %} this.ribbonControlAdv1.MinimizePanel = true; diff --git a/WindowsForms/Ribbon/Backstage.md b/WindowsForms/Ribbon/Backstage.md index 35c20c3ab..f55e01bdb 100644 --- a/WindowsForms/Ribbon/Backstage.md +++ b/WindowsForms/Ribbon/Backstage.md @@ -9,7 +9,7 @@ documentation: ug # Backstage in Windows Forms Ribbon (RibbonControlAdv) -The Ribbon Backstage will appear when the user clicks on Menu button, it allows to make actions for the whole document such as Save, Save As and print. It can be used to show the recent changes in the document and even closing the application. +The Ribbon Backstage will appear when the user clicks on the Menu button. It lets users perform actions for the whole document such as Save, Save As and Print. It can also be used to show the recent changes in the document or to close the application. Backstage structure will have two areas, left side which contain all the items in backstage panel and the right side which shows content of the BackstageTab. @@ -23,7 +23,7 @@ There are three items that can be used in BackStage. They are ## Open BackStage -In designer backstage can be opened by using smart tag of the backstage control below the designer and select `ShowBackstage`. +In the designer, BackStage can be opened by using the smart tag of the BackStage control below the designer and selecting `ShowBackstage`. ![WindowsForms Ribbon open BackStage using ShowBackStage](BackStage_Images/WindowsForms-Ribbon-open-BackStage-using-ShowBackStage.jpg) @@ -315,7 +315,7 @@ this.ribbonControlAdv1.MenuButtonVisible = false; {% highlight vb %} -Me.ribbonControlAdv1.MenuButtonVisible = false +Me.ribbonControlAdv1.MenuButtonVisible = False {% endhighlight %} diff --git a/WindowsForms/Ribbon/Contextual-Tab-Group.md b/WindowsForms/Ribbon/Contextual-Tab-Group.md index 2b5e00d25..d900f1aa6 100644 --- a/WindowsForms/Ribbon/Contextual-Tab-Group.md +++ b/WindowsForms/Ribbon/Contextual-Tab-Group.md @@ -35,7 +35,7 @@ When the simplified layout is enabled, the ContextTabGroup will display its item ## Tab Arrangement -If tabs are placed consecutively and both tabs are assigned with same tag group, the tab group portion will be combined. +If tabs are placed consecutively and both tabs are assigned to the same tab group, the tab group portion will be combined. ![Arrangement of context tabs](Contextual_Tab_Group_Images/Contextual-Tab-Group_img4.jpg) diff --git a/WindowsForms/Ribbon/Customization-Support.md b/WindowsForms/Ribbon/Customization-Support.md index 3a24b8c77..645a594fc 100644 --- a/WindowsForms/Ribbon/Customization-Support.md +++ b/WindowsForms/Ribbon/Customization-Support.md @@ -9,11 +9,11 @@ documentation: ug # Customization Support in Windows Forms Ribbon (RibbonControlAdv) -RibbonControlAdv allows to customize the Ribbon and quick access toolbar with the support to add and remove different items to QAT and to add new tabs and change the location of existing tabs and items in ribbon. +RibbonControlAdv lets you customize the Ribbon and Quick Access Toolbar with the support to add and remove different items to the QAT, add new tabs, and change the location of existing tabs and items in the ribbon. ## QAT customization -For customization of QAT, please refer `Quick Access Toolbar`. +For customization of QAT, please refer to [Quick Access Toolbar](Quick-Access-Toolbar.md). ## Ribbon Customization diff --git a/WindowsForms/Ribbon/Getting-Started.md b/WindowsForms/Ribbon/Getting-Started.md index 254c9e138..9bd20e2f3 100644 --- a/WindowsForms/Ribbon/Getting-Started.md +++ b/WindowsForms/Ribbon/Getting-Started.md @@ -46,10 +46,10 @@ this.Controls.Add(ribbonControlAdv1); {% highlight vb %} -Private ribbonControlAdv1 As Syncfusion.Windows.Forms.Tools.RibbonControlAdv - -Default Private Property Item(ByVal Optional As ribbonControlAdv1 = New RibbonControlAdv()) As +'Declare and initialize the new ribbon control +Me.ribbonControlAdv1 = New RibbonControlAdv() +'Adding ribbon control to form Me.Controls.Add(ribbonControlAdv1) {% endhighlight %} @@ -120,7 +120,7 @@ Me.ribbonControlAdv1.RibbonStyle = RibbonStyle.Office2016 ## Add Tabs to Ribbon -RibbonControlAdv lets you to create ToolStripTabItems easily using the smart tag. It also adds a RibbonPanel to which ToolStripItems can be added. +RibbonControlAdv lets you create ToolStripTabItems easily using the smart tag. It also adds a RibbonPanel to which ToolStripItems can be added. ![Adding Tabs through designer](Getting_Started_Images/Getting-Started_img3.jpg) diff --git a/WindowsForms/Ribbon/Keyboard-Support.md b/WindowsForms/Ribbon/Keyboard-Support.md index 64dda543a..7e9114896 100644 --- a/WindowsForms/Ribbon/Keyboard-Support.md +++ b/WindowsForms/Ribbon/Keyboard-Support.md @@ -36,7 +36,7 @@ Follow the steps below to add Super accelerator ![Keyboard-Support_img4](Keyboard_Support_Images/Keyboard-Support_img4.jpg) -6. Press the string in the keyboard and the corresponding item’s click event will be triggered. (Eg. If the accelerator string of Cut is X key, Press ALT key. Once all the accelerator strings are displayed, press X key the Cut item event will be triggered.) +6. Press the key on the keyboard and the corresponding item's click event will be triggered. (Eg. If the accelerator string of Cut is X, press the ALT key. Once all the accelerator strings are displayed, press X and the Cut item event will be triggered.) **Through Coding** {% tabs %} diff --git a/WindowsForms/Ribbon/Localization-Support.md b/WindowsForms/Ribbon/Localization-Support.md index 6a496d93d..0f01aa3ba 100644 --- a/WindowsForms/Ribbon/Localization-Support.md +++ b/WindowsForms/Ribbon/Localization-Support.md @@ -17,7 +17,7 @@ RibbonControlAdv now supports adaptation of its controls and its details to meet 2. Create a class that implements the `ILocalizationProvider` interface defined in the Syncfusion.Windows.Forms namespace in the Syncfusion.Shared.Base.dll. -3. Return the localized versions of the strings corresponding to the string identifiers. +3. Return the localized versions of the strings that correspond to the string identifiers. 4. String identifiers are defined in the `ToolsResourceIdentifier` classes in Syncfusion.Tools.Windows @@ -171,7 +171,7 @@ class localization : ILocalizationProvider {% highlight vb %} Class localization - Inherits ILocalizationProvider + Implements ILocalizationProvider Public Function GetLocalizedString(ByVal culture As System.Globalization.CultureInfo, ByVal stringname As String, ByVal obj As Object) As String Select Case stringname @@ -432,7 +432,7 @@ this.ribbonControlAdv1.RightToLeft = RightToLeft.Yes; {% highlight vb %} -this.ribbonControlAdv1.RightToLeft = RightToLeft.Yes; +Me.ribbonControlAdv1.RightToLeft = RightToLeft.Yes {% endhighlight %} diff --git a/WindowsForms/Ribbon/Mini-ToolBar.md b/WindowsForms/Ribbon/Mini-ToolBar.md index d1e1ea9cf..052352f38 100644 --- a/WindowsForms/Ribbon/Mini-ToolBar.md +++ b/WindowsForms/Ribbon/Mini-ToolBar.md @@ -9,7 +9,7 @@ documentation: ug # MiniToolBar in Windows Forms Ribbon (RibbonControlAdv) -Essential Tools comes with MiniToolBar control with similar look and feel of Microsoft Office 2007. It appears when the user selects and right clicks on the text. It gives options to customize the selected text. It will look blurred in the beginning, but once the mouse is focused on it, it will be prominent to the users. +Essential Tools comes with a MiniToolBar control with a look and feel similar to Microsoft Office 2007. It appears when the user selects and right-clicks on the text. It gives options to customize the selected text. It appears blurred initially, but becomes prominent when the mouse hovers over it. ![Mini-ToolBar_img1](Mini_Toolbar_Images/Mini-ToolBar_img1.jpg) @@ -314,9 +314,9 @@ Console.WriteLine("ToolStrip Item Name : " + e.Item.ToString()); {% highlight vb %} -Default Private Property Item(ByVal As miniToolBar1.ItemAdded, ByVal As MiniToolBar1_ItemAdded) As +AddHandler Me.miniToolBar1.ItemAdded, AddressOf MiniToolBar1_ItemAdded - Private Sub MiniToolBar1_ItemAdded(ByVal sender As Object, ByVal e As ToolStripItemEventArgs) + Private Sub MiniToolBar1_ItemAdded(ByVal sender As Object, ByVal e As ToolStripItemEventArgs) Console.WriteLine("ItemAdded event is raised") Console.WriteLine("ToolStrip Item Name : " & e.Item.ToString()) @@ -334,7 +334,7 @@ This event is handled when a ToolStripItem has been added to the ToolStrip's Ite **Event** **Data** -The ToolStripItemClickedEventHandler receives an argument of type ToolStripItemEventArgs containing data related to this event. The following type ToolStripItemEventArgs member provide information specific to this event. +The ToolStripItemClickedEventHandler receives an argument of type ToolStripItemClickedEventArgs containing data related to this event. The following ToolStripItemClickedEventArgs members provide information specific to this event.
@@ -368,9 +368,9 @@ Console.WriteLine("ToolStrip Item Name : " + e.ClickedItem.ToString()); {% highlight vb %} -Default Private Property Item(ByVal As miniToolBar1.ItemClicked, ByVal As MiniToolBar1_ItemClicked) As +AddHandler Me.miniToolBar1.ItemClicked, AddressOf MiniToolBar1_ItemClicked - Private Sub MiniToolBar1_ItemClicked(ByVal sender As Object, ByVal e As ToolStripItemClickedEventArgs) + Private Sub MiniToolBar1_ItemClicked(ByVal sender As Object, ByVal e As ToolStripItemClickedEventArgs) Console.WriteLine("ItemClicked event is raised") Console.WriteLine("ToolStrip Item Name : " & e.ClickedItem.ToString()) @@ -419,9 +419,9 @@ Console.WriteLine("ToolStrip Item Name : " + e.Item.ToString()); {% highlight vb %} -Default Private Property Item(ByVal As miniToolBar1.ItemRemoved, ByVal As MiniToolBar1_ItemRemoved) As +AddHandler Me.miniToolBar1.ItemRemoved, AddressOf MiniToolBar1_ItemRemoved - Private Sub MiniToolBar1_ItemRemoved(ByVal sender As Object, ByVal e As ToolStripItemEventArgs) + Private Sub MiniToolBar1_ItemRemoved(ByVal sender As Object, ByVal e As ToolStripItemEventArgs) Console.WriteLine("ToolStrip Item Name : " & e.Item.ToString()) @@ -453,9 +453,9 @@ Console.Write("BeginDrag Event is raised"); {% highlight vb %} -Default Private Property Item(ByVal As miniToolBar1.BeginDrag, ByVal As MiniToolBar1_BeginDrag) As +AddHandler Me.miniToolBar1.BeginDrag, AddressOf MiniToolBar1_BeginDrag -Private Sub MiniToolBar1_BeginDrag(ByVal sender As Object, ByVal e As EventArgs) + Private Sub MiniToolBar1_BeginDrag(ByVal sender As Object, ByVal e As EventArgs) Console.Write("BeginDrag Event is raised") @@ -491,7 +491,6 @@ Gets or Sets a value indicating whether the event should be canceled.

< this.miniToolBar1.Opening += MiniToolBar1_Opening; private void MiniToolBar1_Opening(object sender, CancelEventArgs e) - { //EventArgs can give the options to Allow or Cancel the event by this method. @@ -503,9 +502,9 @@ e.Cancel = true; {% highlight vb %} -Default Private Property Item(ByVal As miniToolBar1.Opening, ByVal As MiniToolBar1_Opening) As +AddHandler Me.miniToolBar1.Opening, AddressOf MiniToolBar1_Opening - Private Sub MiniToolBar1_Opening(ByVal sender As Object, ByVal e As CancelEventArgs) + Private Sub MiniToolBar1_Opening(ByVal sender As Object, ByVal e As CancelEventArgs) e.Cancel = True @@ -538,9 +537,9 @@ Console.Write(" Opened Event is raised"); {% highlight vb %} -Default Private Property Item(ByVal As miniToolBar1.Opened, ByVal As MiniToolBar1_Opened) As +AddHandler Me.miniToolBar1.Opened, AddressOf MiniToolBar1_Opened - Private Sub MiniToolBar1_Opened(ByVal sender As Object, ByVal e As EventArgs) + Private Sub MiniToolBar1_Opened(ByVal sender As Object, ByVal e As EventArgs) Console.Write(" Opened Event is raised") diff --git a/WindowsForms/Ribbon/Quick-Access-Toolbar.md b/WindowsForms/Ribbon/Quick-Access-Toolbar.md index 0f152c745..4683bb9f5 100644 --- a/WindowsForms/Ribbon/Quick-Access-Toolbar.md +++ b/WindowsForms/Ribbon/Quick-Access-Toolbar.md @@ -47,7 +47,7 @@ Item will be added to the Quick Access Toolbar. ### Add Items through Customize Window -Items / controls can be added to the QuickAccessToolbar by clicking on the Edit quick items in the smart tag of the RibbonControlAdv. This opens Customize Quick Access Toolbar Dialog which displays the existing tool strip items. You can add the required items to the Quick Access Toolbar. +Items can be added to the QuickAccessToolbar by clicking `Edit quick items` in the smart tag of the RibbonControlAdv. This opens Customize Quick Access Toolbar Dialog which displays the existing tool strip items. You can add the required items to the Quick Access Toolbar. ![Shows the customize window for QAT](Quick_Access_Toolbar_Images/Quick-Access-Toolbar_img3.jpg) diff --git a/WindowsForms/Ribbon/Ribbon-Form.md b/WindowsForms/Ribbon/Ribbon-Form.md index 14627a5ce..ab4efbd85 100644 --- a/WindowsForms/Ribbon/Ribbon-Form.md +++ b/WindowsForms/Ribbon/Ribbon-Form.md @@ -9,7 +9,7 @@ documentation: ug # Ribbon Form in Windows Forms Ribbon (RibbonControlAdv) -`RibbonForm` is an extension that replaces the default form to enable different Visual styles to the ribbon. This RibbonForm now gives similar look and feel of Microsoft office, to its controls. +`RibbonForm` is an extension that replaces the default form to enable different Visual styles to the ribbon. It gives its controls a look and feel similar to Microsoft Office. ## Appearance Settings @@ -87,7 +87,7 @@ this.IconSize = new Size(32,32); {% endhighlight %} -{% highlight vbnet %} +{% highlight vb %} Me.IconSize = New Size(32, 32) @@ -119,7 +119,7 @@ this.Borders = new System.Windows.Forms.Padding(10); {% endhighlight %} -{% highlight vbnet %} +{% highlight vb %} Me.Borders = New System.Windows.Forms.Padding(10) @@ -129,7 +129,7 @@ Me.Borders = New System.Windows.Forms.Padding(10) ### Customizing the Top Left Edge -This TopLeftRadius property gets/sets the curved radius of the top left edge of the form. Default is 8. +This TopLeftRadius property gets/sets the curved radius of the top left edge of the form. The default value is 8. {% highlight c# %} @@ -137,7 +137,7 @@ this.TopLeftRadius = 20; {% endhighlight %} -{% highlight vbnet %} +{% highlight vb %} Me.TopLeftRadius = 20 diff --git a/WindowsForms/Ribbon/Ribbon-Merge-Support.md b/WindowsForms/Ribbon/Ribbon-Merge-Support.md index f0bc1833a..2e5a0a072 100644 --- a/WindowsForms/Ribbon/Ribbon-Merge-Support.md +++ b/WindowsForms/Ribbon/Ribbon-Merge-Support.md @@ -10,7 +10,7 @@ documentation: ug # Ribbon Merge Support in Windows Forms Ribbon (RibbonControlAdv) RibbonControlAdv allows merging of RibbonPanel in a child form to the RibbonPanel of the parent form. -`RibbonPanelMergeContainer` is the container of TabItems and ToolStripEx items for the child form, when merged, the items present in this container will be merged with parent form. +`RibbonPanelMergeContainer` is the container of TabItems and ToolStripEx items for the child form. When merged, the items present in this container will be merged with the parent form. To merge the RibbonPanel in the ChildForm with the RibbonPanel in the parent form, follow the below given steps. diff --git a/WindowsForms/Ribbon/Serialization-Support.md b/WindowsForms/Ribbon/Serialization-Support.md index acce53cc3..71dc3676f 100644 --- a/WindowsForms/Ribbon/Serialization-Support.md +++ b/WindowsForms/Ribbon/Serialization-Support.md @@ -9,7 +9,7 @@ documentation: ug # Serialization Support in Windows Forms Ribbon (RibbonControlAdv) -The RibbonControlAdv has built-in serialization support to serialize the entire Ribbon control state and details of the layout mode. It also provides supports to save and load the Ribbon at any time while running the application, either with simplified or normal layout. +The RibbonControlAdv has built-in serialization support to serialize the entire Ribbon control state and the details of the layout mode. It also provides support to save and load the Ribbon at any time while the application is running, either with the simplified or normal layout. ## States which get serialized @@ -53,7 +53,7 @@ The Ribbon state can be saved in an xml file and stored in a specific location u {% highlight c# %} AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/RibbonState"); -this.wordribbon.SaveState(serializer); +this.ribbonControlAdv1.SaveState(serializer); serializer.PersistNow(); {% endhighlight %} @@ -61,7 +61,7 @@ serializer.PersistNow(); {% highlight vb %} Dim serializer As AppStateSerializer = New AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/RibbonState") -Me.wordribbon.SaveState(serializer) +Me.ribbonControlAdv1.SaveState(serializer) serializer.PersistNow() {% endhighlight %} @@ -79,7 +79,7 @@ Ribbon control provides an option to save the state of QAT alone instead of savi AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/QATState"); RibbonControlAdv.SerializationOptions options = new RibbonControlAdv.SerializationOptions(); options.SerializeTabItems = false; -this.wordribbon.SaveState(serializer); +this.ribbonControlAdv1.SaveState(serializer); serializer.PersistNow(); {% endhighlight %} @@ -89,7 +89,7 @@ serializer.PersistNow(); Dim serializer As AppStateSerializer = New AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/QATState") Dim options As RibbonControlAdv.SerializationOptions = New RibbonControlAdv.SerializationOptions() options.SerializeTabItems = False -Me.wordribbon.SaveState(serializer) +Me.ribbonControlAdv1.SaveState(serializer) serializer.PersistNow() {% endhighlight %} @@ -107,7 +107,7 @@ Ribbon control provides an option to save the state of Ribbon Tabs alone instead AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/TabState"); RibbonControlAdv.SerializationOptions options = new RibbonControlAdv.SerializationOptions(); options.SerializeQATItems = false; -this.wordribbon.SaveState(serializer); +this.ribbonControlAdv1.SaveState(serializer); serializer.PersistNow(); {% endhighlight %} @@ -117,7 +117,7 @@ serializer.PersistNow(); Dim serializer As AppStateSerializer = New AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/TabState") Dim options As RibbonControlAdv.SerializationOptions = New RibbonControlAdv.SerializationOptions() options.SerializeQATItems = False -Me.wordribbon.SaveState(serializer) +Me.ribbonControlAdv1.SaveState(serializer) serializer.PersistNow() {% endhighlight %} @@ -158,7 +158,7 @@ The saved Ribbon state can be loaded from an xml file using the [`AppStateSerial {% highlight c# %} AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/RibbonState"); -this.wordribbon.LoadState(serializer); +this.ribbonControlAdv1.LoadState(serializer); {% endhighlight %} @@ -166,7 +166,7 @@ this.wordribbon.LoadState(serializer); {% highlight vb %} Dim serializer As AppStateSerializer = New AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/RibbonState") -Me.wordribbon.LoadState(serializer) +Me.ribbonControlAdv1.LoadState(serializer) {% endhighlight %} @@ -183,7 +183,7 @@ Ribbon control provides an option to load the state of QAT alone instead of load AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/QATState"); RibbonControlAdv.DeserializationOptions options = new RibbonControlAdv.DeserializationOptions(); options.DeserializeTabItems = false; -this.wordribbon.LoadState(serializer); +this.ribbonControlAdv1.LoadState(serializer); {% endhighlight %} @@ -192,7 +192,7 @@ this.wordribbon.LoadState(serializer); Dim serializer As AppStateSerializer = New AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/QATState") Dim options As RibbonControlAdv.DeserializationOptions = New RibbonControlAdv.DeserializationOptions() options.DeserializeTabItems = False -Me.wordribbon.LoadState(serializer) +Me.ribbonControlAdv1.LoadState(serializer) {% endhighlight %} @@ -209,7 +209,7 @@ Ribbon control provides an option to load only the state of Ribbon Tabs instead AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/TabState"); RibbonControlAdv.DeserializationOptions options = new RibbonControlAdv.DeserializationOptions(); options.DeserializeQATItems = false; -this.wordribbon.LoadState(serializer); +this.ribbonControlAdv1.LoadState(serializer); {% endhighlight %} @@ -218,7 +218,7 @@ this.wordribbon.LoadState(serializer); Dim serializer As AppStateSerializer = New AppStateSerializer(SerializeMode.XMLFile, "D:/Ribbon Serialization/TabState") Dim options As RibbonControlAdv.DeserializationOptions = New RibbonControlAdv.DeserializationOptions() options.DeserializeQATItems = False -Me.wordribbon.LoadState(serializer) +Me.ribbonControlAdv1.LoadState(serializer) {% endhighlight %} diff --git a/WindowsForms/Ribbon/SimplifiedLayout.md b/WindowsForms/Ribbon/SimplifiedLayout.md index 31e1621be..5f6eebcfe 100644 --- a/WindowsForms/Ribbon/SimplifiedLayout.md +++ b/WindowsForms/Ribbon/SimplifiedLayout.md @@ -8,7 +8,7 @@ documentation: ug --- # Simplified Layout in Windows Forms Ribbon (RibbonControlAdv) - The RibbonControlAdv is available in simplified layout which is designed to display the most commonly used Ribbon commands in a single line interface, allowing more screen space for compact viewing of the content. For the best user experience, the other Ribbon commands are located under the overflow menu. It also provides option to switch back and forth between the simplified and the normal layout using the minimize button. + The RibbonControlAdv is available in a simplified layout which is designed to display the most commonly used Ribbon commands in a single line interface, allowing more screen space for compact viewing of the content. For the best user experience, the other Ribbon commands are located under the overflow menu. It also provides an option to switch back and forth between the simplified and the normal layout using the minimize button. The [`LayoutMode`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.RibbonControlAdv.html#Syncfusion_Windows_Forms_Tools_RibbonControlAdv_LayoutMode) enumeration property provides an option to load the Ribbon control in simplified layout. It contains the following options like: diff --git a/WindowsForms/Ribbon/ToolTip-Support.md b/WindowsForms/Ribbon/ToolTip-Support.md index 62ea1745d..7cd85b1f4 100644 --- a/WindowsForms/Ribbon/ToolTip-Support.md +++ b/WindowsForms/Ribbon/ToolTip-Support.md @@ -35,7 +35,7 @@ Me.pasteButton.ToolTipText = "Add content on your clipboard to your document" ## SuperToolTip -Essential® Tools has come up with a new control known as the SuperToolTip which, enables the user to give tooltip information. +Essential® Tools has come up with a new control known as the SuperToolTip which enables the user to provide tooltip information. * Header - The Header is used to display text which is used as a header for the tooltip. * Body - This is the description part. diff --git a/WindowsForms/Ribbon/Touch-Support.md b/WindowsForms/Ribbon/Touch-Support.md index 61c82245b..bcbb6a3cb 100644 --- a/WindowsForms/Ribbon/Touch-Support.md +++ b/WindowsForms/Ribbon/Touch-Support.md @@ -9,7 +9,7 @@ documentation: ug # Touch Support in Windows Forms Ribbon (RibbonControlAdv) -Ribbon control have touch support and it provides Touch UI which is easy to access the elements in Ribbon. +RibbonControlAdv has touch support and provides a Touch UI that makes it easy to access the elements in the Ribbon. ## Enable Touch Style diff --git a/WindowsForms/Ribbon/Working-with-Ribbon.md b/WindowsForms/Ribbon/Working-with-Ribbon.md index 3c1281dc7..541ea0dde 100644 --- a/WindowsForms/Ribbon/Working-with-Ribbon.md +++ b/WindowsForms/Ribbon/Working-with-Ribbon.md @@ -233,7 +233,7 @@ N> [View sample in GitHub](https://github.com/SyncfusionExamples/how-to-add-the- ## Ribbon Resize behavior -By default, the ribbon control dynamically resizes as width of the window decreases, when the windows border touches the last placed ToolStripEx, the total ToolStripEx will be converted into a dropdown button and the items can be accessed by clicking on that dropdown arrow. +By default, the ribbon control dynamically resizes as the width of the window decreases. When the window's border touches the last placed ToolStripEx, the entire ToolStripEx will be converted into a dropdown button and the items can be accessed by clicking on that dropdown arrow. Same behavior will be continued to every ToolStripEx while minimized continuously. Again, the ToolStripEx will be visible if the spacing between window border and ToolStripEx has enough space to allocate all the items in that ToolStripEx. @@ -353,13 +353,14 @@ Launcher button for ToolStripEx can be hidden by changing the value of the prope {% highlight c# %} //This will hide the launcher -this.ribbonControlAdv1.ShowLauncher = false; +this.toolStripEx1.ShowLauncher = false; {% endhighlight %} {% highlight vb %} -Me.ribbonControlAdv1.ShowLauncher = False +'This will hide the launcher +Me.toolStripEx1.ShowLauncher = False {% endhighlight %} diff --git a/WindowsForms/Ribbon/Working-with-Tabs.md b/WindowsForms/Ribbon/Working-with-Tabs.md index 4f571fe10..d92bcf4ad 100644 --- a/WindowsForms/Ribbon/Working-with-Tabs.md +++ b/WindowsForms/Ribbon/Working-with-Tabs.md @@ -9,7 +9,7 @@ documentation: ug # Working with Tabs in Windows Forms Ribbon (RibbonControlAdv) -Ribbon panels are represented as Tabs(ToolStripTabItem) with tab name above the panel, these panels are split into groups which are ‘ToolStripEx’, this ToolStripEx accepts to display various items like buttons, gallery items, labels and panels. +Ribbon panels are represented as Tabs (ToolStripTabItem) with the tab name above the panel. These panels are split into groups represented as `ToolStripEx`, which displays various items like buttons, gallery items, labels and panels. The following image shows four tabs (**Home**, **Send/Receive**, **Folder** and **View**). The Home tab which is selected consists of six ‘ToolStripEx’ (**New**, **Delete**, **Respond**, **Move**, **Tags** and **Quick Steps** ). From 88376f09be3f0e4414b6ab65d8d322d404a03636 Mon Sep 17 00:00:00 2001 From: harinath-2699 Date: Wed, 8 Jul 2026 15:03:16 +0530 Subject: [PATCH 05/36] Update Getting-Started.md --- WindowsForms/Ribbon/Getting-Started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WindowsForms/Ribbon/Getting-Started.md b/WindowsForms/Ribbon/Getting-Started.md index 9bd20e2f3..15b66e410 100644 --- a/WindowsForms/Ribbon/Getting-Started.md +++ b/WindowsForms/Ribbon/Getting-Started.md @@ -2,7 +2,7 @@ layout: post title: Getting Started with Windows Forms Ribbon control | Syncfusion® description: Learn here about getting started with Syncfusion® Windows Forms Ribbon (RibbonControlAdv) control, its elements and more details. -platform: windowsForms +platform: windowsforms control: RibbonControlAdv documentation: ug --- From f30bf21757a2e4e62fbc4027e411fbbf75e861ac Mon Sep 17 00:00:00 2001 From: Usha4947 Date: Wed, 8 Jul 2026 15:42:54 +0530 Subject: [PATCH 06/36] WF-1039222: Updated the UG Documentation for the Form, Menu, Metro-Form and AutoComplete WinForms Controls --- WindowsForms/Form/Getting-Started.md | 2 +- WindowsForms/Form/Localization.md | 26 +++++++-------- WindowsForms/Form/MDICustomization.md | 20 ++++++------ WindowsForms/Form/Overview.md | 14 ++++---- WindowsForms/Form/Themes.md | 18 +++++------ WindowsForms/Form/TitleBar.md | 14 ++++---- .../Menu/Adding-menu-items-via-code.md | 30 ++++++++--------- .../Menu/Adding-menu-items-via-designer.md | 16 +++++----- WindowsForms/Menu/Appearance-Customization.md | 32 +++++++++---------- WindowsForms/Menu/Detachable-CommandBar.md | 6 ++-- WindowsForms/Menu/Detachable-ControlBar.md | 12 +++---- WindowsForms/Menu/Getting-Started.md | 4 +-- WindowsForms/Menu/Interactive-Features.md | 12 +++---- WindowsForms/Menu/KeyBoard-Support.md | 8 ++--- WindowsForms/Menu/MDI-Child-Forms.md | 18 +++++------ WindowsForms/Menu/Overview.md | 20 ++++++------ WindowsForms/Menu/State-Persistance.md | 4 +-- WindowsForms/Menu/Theming.md | 16 +++++----- WindowsForms/Menu/Touch-Support.md | 6 ++-- WindowsForms/Metro-Form/Appearance.md | 2 +- WindowsForms/Metro-Form/Customization.md | 26 +++++++-------- WindowsForms/Metro-Form/Getting-Started.md | 8 ++--- WindowsForms/Metro-Form/Overview.md | 4 +-- .../autocomplete/AutoComplete-Events.md | 12 +++---- WindowsForms/autocomplete/Customization.md | 6 ++-- WindowsForms/autocomplete/DataSource.md | 14 ++++---- WindowsForms/autocomplete/Getting-started.md | 20 ++++++------ WindowsForms/autocomplete/Overview.md | 4 +-- .../autocomplete/Working-with-AutoComplete.md | 28 ++++++++-------- 29 files changed, 201 insertions(+), 201 deletions(-) diff --git a/WindowsForms/Form/Getting-Started.md b/WindowsForms/Form/Getting-Started.md index db36a57bb..1e3ceff13 100644 --- a/WindowsForms/Form/Getting-Started.md +++ b/WindowsForms/Form/Getting-Started.md @@ -68,7 +68,7 @@ End Class ## Title Bar Customization -By default, the SfForm loads with the default appearance, that can be customized by using the [TitleBarStyleInfo](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html) property. It contains all the settings for the appearance of the form. +By default, the SfForm loads with the default appearance, which can be customized by using the [TitleBarStyleInfo](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html) property. It contains all the settings for the appearance of the title bar. {% tabs %} diff --git a/WindowsForms/Form/Localization.md b/WindowsForms/Form/Localization.md index c9fd5e408..4cdaf6ecb 100644 --- a/WindowsForms/Form/Localization.md +++ b/WindowsForms/Form/Localization.md @@ -8,33 +8,33 @@ documentation: ug --- # Localization in Windows Forms Form (SfForm) -Localization is the process of translating the application resources into different language for the specific cultures. The SfForm can be localized by adding [resource](https://learn.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2010/aa992030(v=vs.100)) file. Application culture can be changed by setting [CurrentUICulture ](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo.currentuiculture?view=net-5.0)before `InitializeComponent` method. +Localization is the process of translating the application resources into different languages for specific cultures. The SfForm can be localized by adding a [resource](https://learn.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2010/aa992030(v=vs.100)) file. The application culture can be changed by setting the [CurrentUICulture](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo.currentuiculture?view=net-5.0) before the `InitializeComponent` method. ## Localize at Sample Level -To localize the SfForm based on `CurrentUICulture` using resource files, follow the below steps. +To localize the SfForm based on `CurrentUICulture` using resource files, follow the steps below. -1. Create new folder and named as Resources in your application. +1. Create a new folder and name it **Resources** in your application. -2. Add the default resource file of SfForm into Resources folder. You can download the `Syncfusion.Shared.Base.resx` [here](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). +2. Add the default resource file of SfForm into the **Resources** folder. You can download the `Syncfusion.Shared.Base.resx` from the [Syncfusion localization repository](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). ![Added default resource file of winforms sfform shown in solution explorer](Localization_images/Localization_img1.png) -3. Right-click on the Resources folder, select **Add** and then **NewItem**. +3. Right-click on the **Resources** folder, select **Add**, and then **New Item**. -4. In Add New Item wizard, select the **Resource File** option and name the filename as Syncfusion.Shared.Base.<culture name>.resx. For example, have to give name as Syncfusion.Shared.Base.de-DE.resx for German culture. +4. In the **Add New Item** wizard, select the **Resource File** option and name the file as `Syncfusion.Shared.Base..resx`. For example, use the name `Syncfusion.Shared.Base.de-DE.resx` for the German culture. ![Adding new resource file through Add New Item wizard](Localization_images/Localization_img2.png) -5. The culture name that indicates the name of language and country. -6. Now, select `Add` option to add the resource file in **Resources** folder. +5. The culture name indicates the language and country. +6. Now, select **Add** to add the resource file to the **Resources** folder. ![Added resource file shown in solution explorer](Localization_images/Localization_img3.png) -7. Add the Name/Value pair in Resource Designer of Syncfusion.Shared.Base.de-DE.resx file and change its corresponding value to corresponding culture. +7. Add the Name/Value pair in the **Resource Designer** of the `Syncfusion.Shared.Base.de-DE.resx` file and change its corresponding value to the localized string. ![Modifying the resources based on culture for localizing winforms sfform](Localization_images/Localization_img4.png) -8. Now, set the `CurrentCulture` of the Application before the `InitializeComponent` method and Run the sample. +8. Now, set the `CurrentCulture` of the application before the `InitializeComponent` method and run the sample. {% capture codesnippet1 %} {% tabs %} @@ -60,18 +60,18 @@ End Sub ![Winforms sfform localized with modified resources](Localization_images/Localization_img5.png) ## Editing Default Resource File -The default resource file can be edited by adding it to Resources folder of the application where SfForm reads the static texts from here. The default resource file can be download from [here](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). +The default resource file can be edited by adding it to the **Resources** folder of the application, which is where SfForm reads the static texts from. The default resource file can be downloaded from the [Syncfusion localization repository](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). ![Added default resource file of winforms sfform shown in solution explorer](Localization_images/Localization_img6.png) -Now, change the Name/Value pair in Resource Designer of `Syncfusion.Shared.Base.resx` file. +Now, change the Name/Value pair in the **Resource Designer** of the `Syncfusion.Shared.Base.resx` file. ![Modifying default resource file of winforms sfform](Localization_images/Localization_img7.png) ![Modifying default resource file of winforms sfform](Localization_images/Localization_img8.png) ## Localize Resource File with Different Assembly or Namespace -If resource (.resx) files are added into different assembly other than start up application, call the `SetResources` method of `LocalizationResource` follows. +If resource (.resx) files are added to a different assembly other than the start-up application, call the `SetResources` method of `LocalizationResourceBase` as follows. {% tabs %} {% highlight c# %} diff --git a/WindowsForms/Form/MDICustomization.md b/WindowsForms/Form/MDICustomization.md index be1d60031..a27db7d18 100644 --- a/WindowsForms/Form/MDICustomization.md +++ b/WindowsForms/Form/MDICustomization.md @@ -9,7 +9,7 @@ documentation: ug # MDI Customization in Windows Forms Form (SfForm) -Multiple Document Interface applications allows displaying multiple documents (or forms) in an application at the same time. MDI parent is a form that contains MDI child windows which are the sub-windows. A form can be changed as MDI parent by enabling the [IsMDIContainer](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.ismdicontainer?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0) property. +Multiple Document Interface (MDI) applications allow displaying multiple documents (or forms) in an application at the same time. An MDI parent is a form that contains MDI child windows, which are the sub-windows. A form can be changed to an MDI parent by enabling the [IsMDIContainer](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.ismdicontainer?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0) property. ## Adding MDI child form @@ -20,7 +20,7 @@ MDI child forms can be added to the MDI parent by making it as parent for the ch this.IsMdiContainer = true; SfForm child1 = new SfForm(); -child1.Text = "Child1; +child1.Text = "Child1"; child1.MdiParent = this; child1.Show(); @@ -56,12 +56,12 @@ this.IsMdiContainer = true; //Creating MDI child SfForm child2 = new SfForm(); -Child2.Text = "Child2; -Child2.MdiParent = this; -Child2.Show(); +child2.Text = "Child2"; +child2.MdiParent = this; +child2.Show(); //Customize title bar appearance. -Child2.Style.TitleBar.BackColor = Color.MidnightBlue; +child2.Style.TitleBar.BackColor = Color.MidnightBlue; child2.Style.TitleBar.ForeColor = Color.White; //Customize title bar button appearance. @@ -112,7 +112,7 @@ Dim activeChild As SfForm = TryCast(Me.ActiveMdiChild, SfForm) ## Notifying the key events for MDI child -By default, the MDI child form will not receive its key events when any control inside the form has focus. This can be changed by enabling the [KeyPreview](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.keypreview?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0) property of the child form. +By default, the MDI child form will not receive its key events when any control inside the form has focus. This can be changed by enabling the [KeyPreview](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.keypreview?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0) property on the child form. When this property is set to `true`, the form will receive `KeyPress`, `KeyDown` and `KeyUp` events. Once the form event handlers have completed the keystroke processing, the keystroke is then assigned to the control with focus. @@ -122,13 +122,13 @@ this.IsMdiContainer = true; //Creating MDI child SfForm child1 = new SfForm(); -Child1.Text = "Child1; -Child1.MdiParent = this; +child1.Text = "Child1"; +child1.MdiParent = this; //Enabling KeyPreview for the child. child1.KeyPreview = true; -Child1.Show(); +child1.Show(); {% endhighlight %} {% highlight vb %} Me.IsMdiContainer = True diff --git a/WindowsForms/Form/Overview.md b/WindowsForms/Form/Overview.md index f71e4261d..42f79a6f5 100644 --- a/WindowsForms/Form/Overview.md +++ b/WindowsForms/Form/Overview.md @@ -9,13 +9,13 @@ documentation: ug # Windows Forms Form (SfForm) Overview -The `SfForm` is a window control for completing customization of the appearance and loading of custom user interface in the Title bar. +The `SfForm` is a window control for completely customizing the appearance of a form and loading a custom user interface in the title bar. ## Key Features -Following are the key features of the SfForm: +The key features of the SfForm are as follows: -* `Title bar customization` : Customizes the appearance of the title bar and load the user control as a title bar. +* `Title bar customization`: Customizes the appearance of the title bar and loads a user control into the title bar. * `MDI(Multiple Document Interface) customization` : Adds MDI child forms and customizes the appearance of MDI child forms. @@ -30,19 +30,19 @@ Syncfusion® WinForms suite comes up with the following different for ### SfForm -The [SfForm](https://help.syncfusion.com/windowsforms/form/overview) window control allows you to completely customize its appearance. Support to load an user interface in the title bar: add an MDI child form and allows the appearance of child forms to be customized. +The [SfForm](https://help.syncfusion.com/windowsforms/form/overview) window control allows you to completely customize its appearance. It supports loading a custom user interface in the title bar, adding MDI child forms, and customizing the appearance of child forms. ### MetroForm -[MetroForm](https://help.syncfusion.com/windowsforms/metro-form/overview) is used to create customizable window for the end user's application. It supports various built-in skins and let the user to control its behavior and appearance. +[MetroForm](https://help.syncfusion.com/windowsforms/metro-form/overview) is used to create a customizable window for the end user's application. It supports various built-in skins and lets the user control its behavior and appearance. ### Office2007Form -[Office2007Form](https://help.syncfusion.com/windowsforms/office2007form/overview) is an advanced standard form that offers Microsoft Office2007 like, UI and appearance. It supports various built-in color schemes and customization options to control its behavior and appearance. +[Office2007Form](https://help.syncfusion.com/windowsforms/office2007form/overview) is an advanced standard form that offers a Microsoft Office2007 like UI and appearance. It supports various built-in color schemes and customization options to control its behavior and appearance. ### SfForm vs MetroForm -Both SfForm and MetroForm controls are used for the same purpose. But, the SfForm control offers rich set of features over MetroForm. For caption images and label, use MetroForm. For custom user control in TitleBar and customizing the appearance of form and MDI forms, use SfForm. +Both SfForm and MetroForm controls are used for the same purpose. However, the SfForm control offers a rich set of features over MetroForm. For caption images and labels, use MetroForm. For custom user controls in the title bar and customizing the appearance of the form and MDI forms, use SfForm. The list of some specific API differences between SfForm and MetroForm are as follows. diff --git a/WindowsForms/Form/Themes.md b/WindowsForms/Form/Themes.md index d5b026718..07897e1cd 100644 --- a/WindowsForms/Form/Themes.md +++ b/WindowsForms/Form/Themes.md @@ -25,7 +25,7 @@ Themes can be applied to `SfForm` by following these steps: ## Load theme assembly -To set theme to `SfForm`, the following assemblies should be added as reference in any application. +To set a theme for `SfForm`, the following assemblies should be added as references in any application.
@@ -65,7 +65,7 @@ HighContrastBlack
-Before applying theme to `SfForm`, required theme assembly should be loaded. +Before applying a theme to `SfForm`, the required theme assembly should be loaded. {% tabs %} {% highlight c# %} @@ -114,11 +114,11 @@ End Class ## Apply theme -The appearance of `SfForm` can be changed using [ThemeName](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.SfForm.html#Syncfusion_WinForms_Controls_SfForm_ThemeName) of `SfForm`. +The appearance of `SfForm` can be changed using the [ThemeName](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.SfForm.html#Syncfusion_WinForms_Controls_SfForm_ThemeName) property of `SfForm`. ### Office2016Colorful -This option helps to set the Office2016Colorful theme. +This option sets the Office2016Colorful theme. {% tabs %} {% highlight c# %} @@ -133,7 +133,7 @@ This option helps to set the Office2016Colorful theme. ### Office2016White -This option helps to set the Office2016White theme. +This option sets the Office2016White theme. {% tabs %} {% highlight c# %} @@ -148,7 +148,7 @@ This option helps to set the Office2016White theme. ### Office2016DarkGray -This option helps to set the Office2016DarkGray theme. +This option sets the Office2016DarkGray theme. {% tabs %} {% highlight c# %} @@ -163,7 +163,7 @@ This option helps to set the Office2016DarkGray theme. ### Office2016Black -This option helps to set the Office2016Black theme. +This option sets the Office2016Black theme. {% tabs %} {% highlight c# %} @@ -178,7 +178,7 @@ This option helps to set the Office2016Black theme. ### Office2019Colorful -This option helps to set the Office2019Colorful theme. +This option sets the Office2019Colorful theme. {% tabs %} {% highlight c# %} @@ -193,7 +193,7 @@ This option helps to set the Office2019Colorful theme. ### HighContrastBlack -This option helps to set the HighContrastBlack theme. +This option sets the HighContrastBlack theme. {% tabs %} {% highlight c# %} diff --git a/WindowsForms/Form/TitleBar.md b/WindowsForms/Form/TitleBar.md index 3a6b5e4eb..b9679c583 100644 --- a/WindowsForms/Form/TitleBar.md +++ b/WindowsForms/Form/TitleBar.md @@ -41,7 +41,7 @@ Me.Style.TitleBar.TextVerticalAlignment = VerticalAlignment.Top ## Customization of title bar buttons -Icons on the title bar buttons can be changed by loading any custom icon by using the button image properties in the [Style.TitleBar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.FormVisualStyle.html#Syncfusion_WinForms_Controls_Styles_FormVisualStyle_TitleBar) such as [CloseButtonImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_CloseButtonImage), [MaximizeButtonImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_MaximizeButtonImage) and [MinimizeButtonImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_MinimizeButtonImage). +Icons on the title bar buttons can be changed by loading custom icons through the button image properties in the [Style.TitleBar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.FormVisualStyle.html#Syncfusion_WinForms_Controls_Styles_FormVisualStyle_TitleBar) such as [CloseButtonImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_CloseButtonImage), [MaximizeButtonImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_MaximizeButtonImage), and [MinimizeButtonImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_MinimizeButtonImage). By default, the title bar buttons have the following states: @@ -49,7 +49,7 @@ By default, the title bar buttons have the following states: * Hover state * Pressed state -Icons for the title bar buttons can be changed to normal, hovered, and pressed states by using the image properties of the corresponding state such as [CloseButtonHoverImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_CloseButtonHoverImage) and [MaximizeButtonPressedImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_MaximizeButtonPressedImage). +Icons for the title bar buttons can be customized for the normal, hovered, and pressed states by using the image properties of the corresponding state, such as [CloseButtonHoverImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_CloseButtonHoverImage) and [MaximizeButtonPressedImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_MaximizeButtonPressedImage). {% tabs %} {% highlight c# %} @@ -88,7 +88,7 @@ Me.Style.TitleBar.MinimizeButtonPressedImage = Image.FromFile("pressedMin.ico") ### Hiding the title bar buttons -Buttons in the title bar can be hide by disabling the [MinimizeBox](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.minimizebox?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0), [MaximizeBox](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.maximizebox?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0) and [CloseButtonVisible](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.SfForm.html#Syncfusion_WinForms_Controls_SfForm_CloseButtonVisible) properties. +Buttons in the title bar can be hidden by disabling the [MinimizeBox](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.minimizebox?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0), [MaximizeBox](https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.maximizebox?view=windowsdesktop-7.0&viewFallbackFrom=net-5.0), and [CloseButtonVisible](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.SfForm.html#Syncfusion_WinForms_Controls_SfForm_CloseButtonVisible) properties. {% tabs %} {% highlight c# %} @@ -128,7 +128,7 @@ N> Adding rich text to the `Text` property will have no effect, if the `AllowRic ## Loading user control to the title bar -The [WinForms Form](https://www.syncfusion.com/winforms-ui-controls/form) (SfForm) allows you to load any user control into the title bar instead of title bar text by using the [TitleBarTextControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.SfForm.html#Syncfusion_WinForms_Controls_SfForm_TitleBarTextControl) property. Size of the user control should be set properly to fit the control within the title bar. +The [WinForms Form](https://www.syncfusion.com/winforms-ui-controls/form) (SfForm) allows you to load any user control into the title bar instead of the title bar text by using the [TitleBarTextControl](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.SfForm.html#Syncfusion_WinForms_Controls_SfForm_TitleBarTextControl) property. The size of the user control should be set properly to fit the control within the title bar. {% tabs %} {% highlight c# %} @@ -168,7 +168,7 @@ The following sample shows how to load user control to the title bar: ## Appearance -Appearance of the title bar can be customized by using the [Style.TitleBar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.FormVisualStyle.html#Syncfusion_WinForms_Controls_Styles_FormVisualStyle_TitleBar) property that contains all the settings for customizing the title bar appearance. +Appearance of the title bar can be customized by using the [Style.TitleBar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.FormVisualStyle.html#Syncfusion_WinForms_Controls_Styles_FormVisualStyle_TitleBar) property, which contains all the settings for customizing the title bar appearance. {% tabs %} {% highlight c# %} @@ -223,7 +223,7 @@ Me.Style.BackColor = Color.DarkGray ### Icon backcolor -You can customize the back color of the icon in title bar using the [IconBackColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_IconBackColor) property. +You can customize the back color of the icon in the title bar using the [IconBackColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_IconBackColor) property. {% tabs %} {% highlight c# %} @@ -265,7 +265,7 @@ Me.Style.TitleBar.CaptionImage = SystemIcons.Error.ToBitmap() ### Caption image location -You can change the location of the caption image in title bar by using the [CaptionImageLocation](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_CaptionImageLocation) property. +You can change the location of the caption image in the title bar by using the [CaptionImageLocation](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Controls.Styles.TitleBarStyleInfo.html#Syncfusion_WinForms_Controls_Styles_TitleBarStyleInfo_CaptionImageLocation) property. {% tabs %} {% highlight c# %} diff --git a/WindowsForms/Menu/Adding-menu-items-via-code.md b/WindowsForms/Menu/Adding-menu-items-via-code.md index d8c3a1191..ce642a0c3 100644 --- a/WindowsForms/Menu/Adding-menu-items-via-code.md +++ b/WindowsForms/Menu/Adding-menu-items-via-code.md @@ -11,7 +11,7 @@ documentation: ug This section provides a quick overview to add the menu items to a [Menu](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html) control through the code. -To add control manually in C# or VB, follow the below steps initially. +To add the control manually in C# or VB, follow the steps below. **Step 1** : Add the following required assembly references to the project: @@ -70,9 +70,9 @@ Me.mainFrameBarManager1.Form = Me; ## Adding main bar -The [Bar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html) component acts a place holder to the menu items. It can be added to menu using the `Bars` collection property of MainFrameBarManager instance. +The [Bar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html) component acts as a place holder for the menu items. It can be added to the menu using the `Bars` collection property of the `MainFrameBarManager` instance. -The below code snippet shows the addition of a bar to the menu. +The following code snippet shows the addition of a bar to the menu. {% tabs %} @@ -114,9 +114,9 @@ Me.mainFrameBarManager1.Categories.Add("Menu") ## Adding parent item -The [ParentBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ParentBarItem.html) is a type of [bar item](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html), that acts as a parent component for child bar items and sub-menu. +The [ParentBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ParentBarItem.html) is a type of [bar item](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html) that acts as a parent component for child bar items and a sub-menu. -The following code snippet shows the adding of parent bar item to a bar with child items. The sub-menu or the child items can be added via the `Items` property. +The following code snippet shows the addition of a parent bar item to a bar with child items. The sub-menu or the child items can be added via the `Items` property. {% tabs %} @@ -208,9 +208,9 @@ Me.bar1.Items.AddRange(New Syncfusion.Windows.Forms.Tools.XPMenus.BarItem() { pa ## Adding dropdown item -The [DropDownBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html) is a type of bar item, which will display a popup menu when clicked. A custom control can also be loaded when the menu item is clicked. This can be done by assigning the required component to the [`PopupControlContainer`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_DropDownBarItem_PopupControlContainer) property of the drop down bar item. +The [DropDownBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html) is a type of bar item that displays a popup menu when clicked. A custom control can also be loaded when the menu item is clicked. This can be done by assigning the required component to the [`PopupControlContainer`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_DropDownBarItem_PopupControlContainer) property of the drop-down bar item. -The following code snippet shows the drop down item is being added with a color picker control. +The following code snippet shows the drop-down item being added with a color picker control. {% tabs %} @@ -266,9 +266,9 @@ Me.bar1.Items.Add(dropDownBarItem1) ## Adding combo box item -The [ComboBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html) is a type of bar item, which behaves like combo box control. The items collection can be specified using the [`ChoiceList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_ComboBoxBarItem_ChoiceList) property. +The [ComboBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html) is a type of bar item that behaves like a combo box control. The items collection can be specified using the [`ChoiceList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_ComboBoxBarItem_ChoiceList) property. -The below code snippet shows the combo box is being added with a collection of items via the `ChoiceList` property. +The following code snippet shows the combo box being added with a collection of items via the `ChoiceList` property. {% tabs %} @@ -296,9 +296,9 @@ Me.bar1.Items.Add(Me.comboBoxBarItem1) ## Adding static item -A [StaticBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.StaticBarItem.html) is a type of bar item, which behaves like Label control. +A [StaticBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.StaticBarItem.html) is a type of bar item that behaves like a `Label` control. -The below code snippet shows the static bar item is added to the menu. +The following code snippet shows the static bar item being added to the menu. {% tabs %} @@ -332,9 +332,9 @@ Me.bar1.Items.Add(staticBarItem1) ## Adding toolbar item -A [ToolBarListBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ToolBarListBarItem.html) is a type of bar item, which behaves like a toolbar menu item. It displays the options to customize the menu items of the parent tool bar to which it gets associated. +A [ToolBarListBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ToolBarListBarItem.html) is a type of bar item that behaves like a toolbar menu item. It displays the options to customize the menu items of the parent toolbar to which it is associated. -The below code shows the toolbar item is added to the menu. +The following code shows the toolbar item being added to the menu. {% tabs %} @@ -368,9 +368,9 @@ Me.bar1.Items.Add(toolbarListBarItem) ## Adding textbox item -The [TextBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html) is a type of bar item, which behaves like text box control. The text edited can be obtained via the [`TextBoxValue`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_TextBoxBarItem_TextBoxValue) property. +The [TextBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html) is a type of bar item that behaves like a text box control. The text edited can be obtained via the [`TextBoxValue`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_TextBoxBarItem_TextBoxValue) property. -The below code snippet shows the text item is added to the menu. +The following code snippet shows the text item being added to the menu. {% tabs %} diff --git a/WindowsForms/Menu/Adding-menu-items-via-designer.md b/WindowsForms/Menu/Adding-menu-items-via-designer.md index d450f6607..063f6dd62 100644 --- a/WindowsForms/Menu/Adding-menu-items-via-designer.md +++ b/WindowsForms/Menu/Adding-menu-items-via-designer.md @@ -11,7 +11,7 @@ documentation: ug This section provides a quick overview to add the menu items to a [Menu](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html) control through the designer. -The MainFrameBarManager can be added to the application by drag and dropping from the tool box to the design form. The following required assembly references will be added automatically. +The `MainFrameBarManager` can be added to the application by dragging it from the toolbox and dropping it onto the design form. The required assembly references will be added automatically. * Syncfusion.Grid.Base.dll * Syncfusion.Grid.Windows.dll @@ -28,13 +28,13 @@ The MainFrameBarManager can be added to the application by drag and dropping fro ## Adding main bar -The [Bar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html) component acts as a place holder for the menu items. It can be added to the menu via the **Customize** dialog. To do so, select the `Customize...` option from the smart tags menu. Under the `Toolbars` tab of the dialog, the bar can be added. +The [Bar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html) component acts as a placeholder for the menu items. It can be added to the menu via the **Customize** dialog. To do so, select the `Customize...` option from the smart tags menu. Under the `Toolbars` tab of the dialog, the bar can be added. ![Adding bar](Adding-menu-items-via-designer-images/adding_Bar.png) ## Adding parent item -The [ParentBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ParentBarItem.html) is a type of [bar item](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html), that acts as a parent component for child bar items and sub-menu. +The [ParentBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ParentBarItem.html) is a type of [bar item](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html) that acts as a parent component for child bar items and a sub-menu. ![ParentBarItem](Adding-menu-items-via-designer-images/parentBarItem.gif) @@ -48,7 +48,7 @@ Note: This UI is only applicable for `.NET Core`. ## Adding drop down item -The [DropDownBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html) is a type of bar item, which will display a popup menu when clicked. A custom control can also be loaded and displayed when the menu item is clicked. This can be done by assigning the required component to the [PopupControlContainer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_DropDownBarItem_PopupControlContainer) property of the drop down bar item. +The [DropDownBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html) is a type of bar item that displays a popup menu when clicked. A custom control can also be loaded and displayed when the menu item is clicked. This can be done by assigning the required component to the [PopupControlContainer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.DropDownBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_DropDownBarItem_PopupControlContainer) property of the drop-down bar item. ![DropDownBarItem selection](Adding-menu-items-via-designer-images/dropDownBarItem_Selection.png) @@ -58,7 +58,7 @@ The [DropDownBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Win ## Adding combo box item -The [ComboBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html) is a type of bar item, which behaves like combo box control. The items collection can be specified using the [`ChoiceList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_ComboBoxBarItem_ChoiceList) property. The **String Collection Editor** gets opened to add or edit the items of the combo box bar item. +The [ComboBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html) is a type of bar item that behaves like a combo box control. The items collection can be specified using the [`ChoiceList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ComboBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_ComboBoxBarItem_ChoiceList) property. The **String Collection Editor** is opened to add or edit the items of the combo box bar item. ![ComboboxBarItem selection](Adding-menu-items-via-designer-images/comboboxBarItem_Selection.png) @@ -70,7 +70,7 @@ The [ComboBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Win ## Adding static item -A [StaticBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.StaticBarItem.html) is a type of bar item, which behaves like Label control. +A [StaticBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.StaticBarItem.html) is a type of bar item that behaves like a `Label` control. ![StaticBarItem selected](Adding-menu-items-via-designer-images/staticBarItem_Selected.png) @@ -78,7 +78,7 @@ A [StaticBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows ## Adding toolbar item -A [ToolBarListBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ToolBarListBarItem.html) is a type of bar item, which behaves like a toolbar menu item. It displays the options to customize the menu items of the parent tool bar to which it gets associated. +A [ToolBarListBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.ToolBarListBarItem.html) is a type of bar item that behaves like a toolbar menu item. It displays the options to customize the menu items of the parent toolbar to which it is associated. ![ToolBarListBarItem selected](Adding-menu-items-via-designer-images/toolBarListBarItem_Selected.png) @@ -86,7 +86,7 @@ A [ToolBarListBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Wi ## Adding textbox item -The [TextBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html) is a type of bar item, which behaves like text box control. The text edited can be obtained via the [TextBoxValue](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_TextBoxBarItem_TextBoxValue) property. +The [TextBoxBarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html) is a type of bar item that behaves like a text box control. The text edited can be obtained via the [TextBoxValue](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.TextBoxBarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_TextBoxBarItem_TextBoxValue) property. ![TextBoxBarItem selected](Adding-menu-items-via-designer-images/textBoxBarItem_Selected.png) diff --git a/WindowsForms/Menu/Appearance-Customization.md b/WindowsForms/Menu/Appearance-Customization.md index 927eea1f2..05048de79 100644 --- a/WindowsForms/Menu/Appearance-Customization.md +++ b/WindowsForms/Menu/Appearance-Customization.md @@ -9,15 +9,15 @@ documentation: ug # Appearance Customization in Windows Forms Menu (Menus) -In this section the appearance customization of the menu and child menu items is discussed. +This section discusses the appearance customization of the menu and child menu items. ## Customizing images in menu items -The images associated with a menu item can be customized depending upon its state either it is enabled, disabled, highlighted or performed an action upon it. +The images associated with a menu item can be customized depending on its state — enabled, disabled, highlighted, or pressed. ### Adding normal state images -Images can be added to menu items directly via the property [`Image`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_Image). The following code snippet shows the image added to a bar item. +Images can be added to menu items directly via the [`Image`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_Image) property. The following code snippet shows an image added to a bar item. {% tabs %} @@ -44,15 +44,15 @@ The below table discuss the image properties of customizing the image associated | [`ImageList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_ImageList) | Gets or sets the image list associated with a menu a item instance. | | [`ImageListAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_ImageListAdv) | Gets or sets the image list associated with a menu item instance. | | [`ImageSize`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_ImageSize) | Gets or sets the size of an image. | -| [`LargeImageList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_LargeImageList) | Gets or sets the ImageList that contains the images to display in the disabled state, if the bar manager is loaded with large icons mode. | -| [`LargeImageListAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_LargeImageListAdv) | Gets or sets the ImageList that contains the images to display in the disabled state, if the bar manager is loaded with large icons mode. | +| [`LargeImageList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_LargeImageList) | Gets or sets the `ImageList` that contains the images to display when the bar manager is loaded with large icons mode. | +| [`LargeImageListAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_LargeImageListAdv) | Gets or sets the `ImageListAdv` that contains the images to display when the bar manager is loaded with large icons mode. | | [`ImageIndex`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_ImageIndex) | Gets or sets the index of the image list collections. | N> By default, the `ImageIndex` is set to -1, the corresponding image in the list should be specified with a proper index value. ### Adding disabled state images -When a menu item tends to be in a disabled state, a different image can be associated with that menu item via the property [`DisabledImage`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_DisabledImage). The following code snippet shows the image associated with a disabled state menu item. +When a menu item is in a disabled state, a different image can be associated with that menu item via the [`DisabledImage`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_DisabledImage) property. The following code snippet shows the image associated with a disabled-state menu item. {% tabs %} @@ -114,10 +114,10 @@ The below table discuss the image properties of customizing the selected state i | Properties | Description | |-------------------|-------------------| -| [`HighlightedImageList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightImageList) | Gets or sets the ImageList that contains the images to display in the disabled menu item. | -| [`HighlightedImageListAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightImageListAdv) | Gets or sets the ImageList that contains the images to display in the disabled menu item. | -| [`HighlightedLargeImageList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightLargeImageList) | Gets or sets the ImageList that contains the images to display in the disabled state, if the bar manager is loaded with large icons mode. | -| [`HighlightedImageLargeListAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightLargeImageListAdv) | Gets or sets the ImageList that contains the images to display in the disabled state, if the bar manager is loaded with large icons mode. | +| [`HighlightedImageList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightImageList) | Gets or sets the `ImageList` that contains the images to display when the menu item is highlighted. | +| [`HighlightedImageListAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightImageListAdv) | Gets or sets the `ImageListAdv` that contains the images to display when the menu item is highlighted. | +| [`HighlightedLargeImageList`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightLargeImageList) | Gets or sets the `ImageList` that contains the images to display when the menu item is highlighted, if the bar manager is loaded with large icons mode. | +| [`HighlightedImageLargeListAdv`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightLargeImageListAdv) | Gets or sets the `ImageListAdv` that contains the images to display when the menu item is highlighted, if the bar manager is loaded with large icons mode. | | [`HighlightedImageIndex`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_HighlightedImageIndex) | Gets or sets the index of the image collections. | ![Before highlighting the menu item](Appearance-Customization-images/menuItem_non_HighlightedImage.png) @@ -188,7 +188,7 @@ The menu bar appearance can be customized with the usage scenario depending upon * IsStatusBar * TextBelowImage -The enum value of `BarStyle` cam also be adjoined to represent the bar with combined applied styles. The below image shows the bar items are combined with the `Visible` value. +The enum values of `BarStyle` can also be combined to represent a bar with multiple applied styles. The image below shows the bar items combined with the `Visible` value. ![Bar enabled with customizing options](Appearance-Customization-images/barStyle_AllowQuickCustomizing.png) @@ -347,7 +347,7 @@ Me.mainFrameBarManager1.EnableCustomizing = False ![Disabled customize option to all the menu bars](Appearance-Customization-images/customizeOptionDisabled_All.png) -The above code could disable the customization to all the bars of the menu control collectively. In order to disable the customize option for a specific bar, the respective bar instance's `AllowCustomizing` property should be set to `false`. The below image shows the customization to _bar1_ is being disabled while _bar2_ is not. +The above code disables the customization for all the bars of the menu control collectively. To disable the customize option for a specific bar, the respective bar instance's `AllowCustomizing` property should be set to `false`. The image below shows customization for _bar1_ being disabled while _bar2_ is not. {% tabs %} @@ -376,7 +376,7 @@ There are two events associated while customizing the menu items. The [`Customiz ## Grouping menu items -The menu items of a tool bar can be grouped together using the [`SeparatorIndices`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html#Syncfusion_Windows_Forms_Tools_XPMenus_Bar_SeparatorIndices) property. The specific tool bar instance is used to specific the grouping items. The below code snippet shows the menu items are grouped in a tool bar. +The menu items of a toolbar can be grouped together using the [`SeparatorIndices`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html#Syncfusion_Windows_Forms_Tools_XPMenus_Bar_SeparatorIndices) property. The specific toolbar instance is used to specify the grouping items. The following code snippet shows the menu items being grouped in a toolbar. {% tabs %} @@ -396,7 +396,7 @@ Me.bar1.SeparatorIndices.Add(3) ![Menu items are grouped in a bar](Appearance-Customization-images/menuItemsGrouped.png) -N> The index value represents the menu items incremental value for grouping. Its not likely to be the bar item index value in a tool bar. +N> The index value represents the menu item's incremental value for grouping. It is not necessarily the bar item index in a toolbar. ### Grouping methods @@ -404,12 +404,12 @@ N> The index value represents the menu items incremental value for grouping. Its |----------|--------------------| | [`BeginGroupAt`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html#Syncfusion_Windows_Forms_Tools_XPMenus_Bar_BeginGroupAt_Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_) | Begins the grouping of menu items from the bar item instance specified. | | [`RemoveGroupAt`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html#Syncfusion_Windows_Forms_Tools_XPMenus_Bar_RemoveGroupAt_Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_) | Removes the grouping of menu items from the bar item instance specified. | -| [`IsGroupBeginning`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html#Syncfusion_Windows_Forms_Tools_XPMenus_Bar_IsGroupBeginning_Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_) | Returns a boolean value whether the specified bar item instance is at the begining of the grouping or not. | +| [`IsGroupBeginning`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html#Syncfusion_Windows_Forms_Tools_XPMenus_Bar_IsGroupBeginning_Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_) | Returns a boolean value indicating whether the specified bar item instance is at the beginning of a group. | | [`ClearSeparators`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html#Syncfusion_Windows_Forms_Tools_XPMenus_Bar_ClearSeparators) | Removes every grouping of menu items in a given tool bar. | ## Backward compatibility -The menu control supports to customize the appearance and scale modes similar to the older version of the menu control. This can be used by enabling the [`UseBackwardCompatiblity`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarManager_UseBackwardCompatiblity) property. +The menu control supports customizing the appearance and scale modes similar to older versions of the menu control. This can be enabled by setting the [`UseBackwardCompatiblity`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarManager_UseBackwardCompatiblity) property to `true`. The color schemes can be modified by applying and customizing the theme colors. diff --git a/WindowsForms/Menu/Detachable-CommandBar.md b/WindowsForms/Menu/Detachable-CommandBar.md index 974e4e832..70016f7e8 100644 --- a/WindowsForms/Menu/Detachable-CommandBar.md +++ b/WindowsForms/Menu/Detachable-CommandBar.md @@ -9,11 +9,11 @@ documentation: ug # Detachable Command Bar in Windows Forms Menu (Menus) -The [`CommandBar`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.CommandBar.html) instance can be added to the menu bar and can be set to detach from the parent menu bar. +The [`CommandBar`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.CommandBar.html) instance can be added to the menu bar and set to detach from the parent menu bar. ## Adding command bar via designer -The command bar can be added via the `DetachedCommandBars` selection from the smart tags options. The below image shows the command bar is added to the menu via the designer settings. +The command bar can be added via the `DetachedCommandBars` selection from the smart tags options. The image below shows the command bar being added to the menu via the designer settings. ![Command bar added to the bar](Detachable-Commandbar-images/adding_CommandBar_Designer.png) @@ -21,7 +21,7 @@ The command bar can be added via the `DetachedCommandBars` selection from the sm ## Adding command bar via code -The command bar instance should be created with required settings and added to the `DetachedCommandBars` collection property. The below code snippet shows the command bar is added to the menu control with top docked position. +The command bar instance should be created with the required settings and added to the `DetachedCommandBars` collection property. The following code snippet shows the command bar being added to the menu control with top-docked position. {% tabs %} diff --git a/WindowsForms/Menu/Detachable-ControlBar.md b/WindowsForms/Menu/Detachable-ControlBar.md index 7a164e874..c1173fcaa 100644 --- a/WindowsForms/Menu/Detachable-ControlBar.md +++ b/WindowsForms/Menu/Detachable-ControlBar.md @@ -9,21 +9,21 @@ documentation: ug # Detachable Control Bar in Windows Forms Menu (Menus) -Control bars enables application developers to add dock-able / floatable controls to their form's toolbar layout. A common example of a control bar is the task pane window found in the Microsoft Office 2003 product suite. +Control bars enable application developers to add dock-able / floatable controls to their form's toolbar layout. A common example of a control bar is the task pane window found in the Microsoft Office 2003 product suite. A [`ControlBar`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.ControlBar.html) is a full-featured docking container that can host any control and be docked along the border of the host form or floated as a top-level window. Control bars, however, differ from traditional docking windows by adopting the characteristic layout behavior of a toolbar rather than that of a classic dock-able control. ## Adding control bar via designer -The control bar can be added via the designer settings selecting the `Add Detachable Control Bars` option from the smart tag menu. The below image shows the added control bar to the form via designer. +The control bar can be added via the designer settings by selecting the `Add Detachable Control Bars` option from the smart tag menu. The image below shows the control bar being added to the form via the designer. ![Control bar added via designer](Detachable-Controlbar-images/adding_ControlBar_Designer.png) ![Control bar added via designer](Detachable-Controlbar-images/form_with_ControlBar.png) -## Adding control var via code +## Adding control bar via code -The control bar instance can be created with required settings and added to the `DetachedCommandBars` collection property of the menu instance. The below code snippet shows the control bar is added to the menu control with top docked position. +The control bar instance can be created with the required settings and added to the `DetachedCommandBars` collection property of the menu instance. The following code snippet shows the control bar being added to the menu control with top-docked position. The below code snippet shows the control bar it being added to the menu item. @@ -60,7 +60,7 @@ A control bar is capable of hosting two controls. ### Caption region -The controls added in this region will be loaded on the caption region of the control bar. Controls with single-line structure like text box, combo box, buttons or menu items can be included in this region. The below code snippet shows the text box is being added to the caption region. +The controls added in this region will be loaded on the caption region of the control bar. Controls with single-line structure like text box, combo box, buttons, or menu items can be included in this region. The following code snippet shows a text box being added to the caption region. {% tabs %} @@ -90,4 +90,4 @@ Me.controlBar1.CaptionControl = textBox1 ### Client region -This region holds the main control that gets hosted with the control bar. The control bar with tool bar and card layout controls are illustrated in this-example. +This region holds the main control that is hosted with the control bar. The control bar with toolbar and card layout controls is illustrated in this-example. diff --git a/WindowsForms/Menu/Getting-Started.md b/WindowsForms/Menu/Getting-Started.md index bcbcc530e..a0c326641 100644 --- a/WindowsForms/Menu/Getting-Started.md +++ b/WindowsForms/Menu/Getting-Started.md @@ -18,11 +18,11 @@ This section describes how to configure a [MainFrameBarManager](https://help.syn ## Assembly deployment -Refer [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#mainframebarmanager) section to get the list of assemblies or NuGet package needs to be added as reference to use the control in any application. Please find more details regarding [installation of nuget packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) in a windows form application. +Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#mainframebarmanager) section to get the list of assemblies or NuGet packages that need to be added as a reference to use the control in any application. See [installing NuGet packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) for more details. ## Creating an application with menu -You can create a Windows Forms application with menu control as either of the following ways. +You can create a Windows Forms application with the menu control in one of the following ways. * [Adding menu items via designer](https://help.syncfusion.com/windowsforms/menu/adding-menu-items-via-designer) * [Adding menu items via code](https://help.syncfusion.com/windowsforms/menu/adding-menu-items-via-code) diff --git a/WindowsForms/Menu/Interactive-Features.md b/WindowsForms/Menu/Interactive-Features.md index 52e372aa4..6d783e4f4 100644 --- a/WindowsForms/Menu/Interactive-Features.md +++ b/WindowsForms/Menu/Interactive-Features.md @@ -9,11 +9,11 @@ documentation: ug # Interactive Features in Windows Forms Menu (Menus) -Menu control supports interactive features like tooltip and context menu associated with specified menu items. In this page such interactive features are discussed. +Menu control supports interactive features like tooltip and context menu associated with specified menu items. This page discusses such interactive features. ## Super tooltip -The menu control supports [`Super Tooltip`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.SuperToolTip.html) support via the super tooltip control. In this topic we discuss about associating a super tooltip control to a bar item. +The menu control supports a [`Super ToolTip`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.SuperToolTip.html) via the super tooltip control. In this topic, we discuss associating a super tooltip control with a bar item. ### Adding super tooltip @@ -23,7 +23,7 @@ The super tooltip control can be drag and dropped to the form via the toolbox of ### Enabling super tooltip -The menu item should be associated with the super tooltip to display the content of the tooltip. This can be done either via the designer. The below image shows the menu item `ToolTip` extended property is being set to the super tooltip instance created. +The menu item should be associated with the super tooltip to display the content of the tooltip. This can be done either via the designer. The image below shows the menu item `ToolTip` extended property being set to the super tooltip instance created. The content of the super tooltip can be edited via the **ToolTip Editor**. This can be opened via the ellipses button `...`. The below image shows the tooltip editor is being opened and the text property is being set. @@ -31,7 +31,7 @@ The content of the super tooltip can be edited via the **ToolTip Editor**. This ![Menu item with super tooltip](Interactive-Features-images/toolTipEditor_TextUpdated.png) -By default the tooltip for every menu item is enabled via the [`ShowTooltip`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_ShowTooltip). This can be disabled so that no overlapping of content gets displayed. The following code snippet shows the tooltip menu item is being disabled. +By default, the tooltip for every menu item is enabled via the [`ShowTooltip`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarItem_ShowTooltip) property. This can be disabled so that no overlapping of content occurs. The following code snippet shows the tooltip for a menu item being disabled. {% tabs %} @@ -51,7 +51,7 @@ Me.barItem3.ShowTooltip = False ![Super tooltip customized in Tooltip editor](Interactive-Features-images/menuItem_with_SuperToolTip.png) -N> Disabling the default tooltip of the menu item is not mandatory. However the overlapping of both tooltip could possibly occur. Its recommended to hide the default tooltip to get better view of the super tooltip. +N> Disabling the default tooltip of the menu item is not mandatory. However, overlapping of both tooltips can occur. It is recommended to hide the default tooltip for a better view of the super tooltip. ### Appearance customization @@ -63,7 +63,7 @@ The super tooltip appearance can be customized depending upon the requirement. T ## Context menu -By default, the context menu appears while right-clicking of the desired tool bar in the menu control. This provides the on-demand customization of the menu items in the specified tool bar. The below image shows the context menu being shown while right-clicking the toolbar. +By default, the context menu appears when right-clicking the desired toolbar in the menu control. This provides on-demand customization of the menu items in the specified toolbar. The image below shows the context menu being shown when right-clicking the toolbar. ![Menu with conetxt menu](Interactive-Features-images/contextMenu_in_Toolbar.png) diff --git a/WindowsForms/Menu/KeyBoard-Support.md b/WindowsForms/Menu/KeyBoard-Support.md index 25415d3c3..e542fbcce 100644 --- a/WindowsForms/Menu/KeyBoard-Support.md +++ b/WindowsForms/Menu/KeyBoard-Support.md @@ -9,11 +9,11 @@ documentation: ug # Keyboard Support in Windows Forms Menu (Menus) -The menu control supports keyboard functionalities for navigation and selection of menu items. In this topic such keyboard support is discussed. +The menu control supports keyboard functionality for navigation and selection of menu items. This topic discusses such keyboard support. ## Displaying shortcut text in menu item -The menu items can be selected and the respective action can be done by specifying the shortcuts via the `Shortcut` property of the menu item. The below code snippet shows a shortcut is being assigned to the menu item. +The menu items can be selected and the respective action can be performed by specifying the shortcuts via the `Shortcut` property of the menu item. The following code snippet shows a shortcut being assigned to the menu item. {% tabs %} @@ -35,9 +35,9 @@ Me.barItem1.Shortcut = Shortcut.AltDownArrow ## Displaying Mnemonic in menu items -The menu items supports to add mnemonic text. As usual, the required mnemonic character is appended with `&` symbol in the `Text` property of the menu item. This character can be made visible all the time using the `ShowMnemonicUnderlinesAlways` property of the menu item. +The menu items support mnemonic text. As usual, the required mnemonic character is prefixed with the `&` symbol in the `Text` property of the menu item. This character can be made visible all the time using the `ShowMnemonicUnderlinesAlways` property of the menu item. -The below snippet shows the drop down item is applied with the mnemonics. +The following snippet shows the drop-down item being applied with mnemonics. {% tabs %} diff --git a/WindowsForms/Menu/MDI-Child-Forms.md b/WindowsForms/Menu/MDI-Child-Forms.md index ad23131ca..b22453ebe 100644 --- a/WindowsForms/Menu/MDI-Child-Forms.md +++ b/WindowsForms/Menu/MDI-Child-Forms.md @@ -16,11 +16,11 @@ This section illustrates how to create MDI Child forms using the ChildFrameBarMa ## Assembly deployment -Refer [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#childframebarmanager) section to get the list of assemblies or NuGet package needs to be added as reference to use the control in any application. Please find more details regarding [installation of nuget packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) in a windows form application. +Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#childframebarmanager) section to get the list of assemblies or NuGet packages that need to be added as a reference to use the control in any application. See [installing NuGet packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) for more details. ## Creating MDI parent form -To create MDI parent form and MDI child form follow the below steps +To create an MDI parent form and an MDI child form, follow the steps below: 1. Set up an MDIParent form by setting Form.IsMdIContainer property to true. 2. Add menu items, 'Open' and 'Exit', under File menu bar using MainFrameBarManager. You can refer [this topic](https://help.syncfusion.com/windowsforms/menus/adding-menu-items-via-code) to add menu items to the menu. @@ -37,12 +37,12 @@ To create MDI parent form and MDI child form follow the below steps ## MDI merging -The XP Menus Framework goes to a great extent to support associating menus and toolbars for MDIChild forms. It helps users to create custom menu items and toolbars for child forms and handle menu events right within the child form. Without this support, users would have to handle menu click events in their main form and delegate it to the appropriate child forms with drawn-out casting and run-time checks and would also have to manually control menu and toolbar visibility based on the active MDIChild forms. +The XP Menus Framework goes to a great extent to support associating menus and toolbars for MDIChild forms. It helps users to create custom menu items and toolbars for child forms and handle menu events right within the child form. Without this support, users would have to handle menu click events in their main form and delegate them to the appropriate child forms with drawn-out casting and run-time checks, and would also have to manually control menu and toolbar visibility based on the active MDI child forms. -Once an MDIChild form is associated with a ChildFrameBarManager, the XP Menus Framework merges the menus and toolbars of the child form with that of the main form. There are two ways in which MDI merging can happen. +Once an MDI child form is associated with a `ChildFrameBarManager`, the XP Menus Framework merges the menus and toolbars of the child form with those of the main form. There are two ways in which MDI merging can happen. -* Auto Merging - The Framework will automatically merge the menus of the child forms with that of the main form when a new instance of the child type is parented by the MDIParent. This merging will be undone when all instances of that child type are closed. This is the default behavior. -* Explicit Merging - Explicitly merging the child types when the application loads will provide a completely merged menu/toolbar structure to the end users, all the time. This merged state will stay unaffected through out the lifetime of the application (whether or not there are instances of the child types currently loaded). Note that the merged BarItems of the MDI child forms would be displayed in the runtime customization dialog only, and will not be visible in the parent form's menus or toolbars until an actual instance of the child form is loaded. This is the behavior exhibited in VS .NET. You can explicitly merge child types by registering the child form types with the MainFrameBarManager, as follows. +* Auto Merging - The Framework will automatically merge the menus of the child forms with those of the main form when a new instance of the child type is parented by the MDIParent. This merging will be undone when all instances of that child type are closed. This is the default behavior. +* Explicit Merging - Explicitly merging the child types when the application loads will provide a completely merged menu/toolbar structure to the end users at all times. This merged state will stay unaffected throughout the lifetime of the application (whether or not there are instances of the child types currently loaded). Note that the merged `BarItem`s of the MDI child forms are displayed in the runtime customization dialog only, and will not be visible in the parent form's menus or toolbars until an actual instance of the child form is loaded. This is the behavior exhibited in VS .NET. You can explicitly merge child types by registering the child form types with the `MainFrameBarManager`, as follows. N> Here the child forms created in the above example is being used. @@ -66,13 +66,13 @@ The MainFrameBarManager will then create an instance of these form types and obt The following applies to the explicit merging scenario only: -_Warning_ Explicit merging imposes the requirement that the child form types should have a public default constructor (constructor with no arguments). +**Warning**: Explicit merging imposes the requirement that the child form types should have a public default constructor (a constructor with no arguments). N> During explicit merging, a new 'dummy' instance of the child forms (one for each type) will be created by the Framework in the background. However, these child forms will never be made visible. ## Types of Merging -There are three types of MDI merging supported in menu control. +There are three types of MDI merging supported in the menu control. 1. Main menu Merging: MainMenus (bars with the MainMenu BarStyle) in the main form and the child forms will automatically be merged into one, irrespective of their BarName. 2. Toolbars Merging: Toolbars with the same BarName (in different forms) will be merged into one. @@ -97,7 +97,7 @@ The merge behavior is also controlled by the `MergeType` property, as follows. | Replace | Replace | Child item will replace the parent item | | Replace | Remove | Parent item stays visible; child item will be hidden | -You can choose anyone of the following for MDI merging. +You can choose any one of the following for MDI merging. * To let the Framework automatically merge as new instances of the child types that are created. * Explicitly merge child types as soon as the application is started. diff --git a/WindowsForms/Menu/Overview.md b/WindowsForms/Menu/Overview.md index 256878d85..28746b79d 100644 --- a/WindowsForms/Menu/Overview.md +++ b/WindowsForms/Menu/Overview.md @@ -9,25 +9,25 @@ documentation: ug # Windows Forms Menu (Menus) Overview -[MainFrameBarManager](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html) control allows the hierarchal menu model of elements that are associated with commands and toolbars. This control contains a collection of [BarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html), which can be expanded to display additional [BarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html) or to perform a specific action when being clicked. +[MainFrameBarManager](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html) control allows a hierarchical menu model of elements that are associated with commands and toolbars. This control contains a collection of [BarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html), which can be expanded to display additional [BarItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarItem.html) entries or to perform a specific action when clicked. ## Key features -* **Bar** - Supports [Bar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html) which is an unique structure represents a main menu, status bar or a regular toolbar in the XP Menus Framework. +* **Bar** - Supports [Bar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.Bar.html), a unique structure that represents a main menu, status bar, or a regular toolbar in the XP Menus Framework. -* **Host form** - Provides option to host into any kind of forms. +* **Host form** - Provides the option to host into any kind of form. -* **Localization** - Provides localization support for all elements into any desired language +* **Localization** - Provides localization support for all elements into any desired language. -* **BarItem types** - Provides rich set of built-in controls such as ParentBarItem, BarItem, ComboBoxBarItem, TextBoxBarItem and much more. +* **BarItem types** - Provides a rich set of built-in controls such as `ParentBarItem`, `BarItem`, `ComboBoxBarItem`, `TextBoxBarItem`, and many more. -* **Serialization** - Provides options to save and load the state of the BarItem. +* **Serialization** - Provides options to save and load the state of the `BarItem`. -* **Customization** - Supports Customization dialog to allow the end user to customize the menu structure at runtime. +* **Customization** - Supports a Customization dialog that lets the end user customize the menu structure at runtime. -* **Visual style** - Supports rich set of visual styles to customize the look and feel of MainFrameBarManager. +* **Visual style** - Supports a rich set of visual styles to customize the look and feel of the `MainFrameBarManager`. -* **MDI layout** - Supports MDI Layout, Learn more [MDIChildForms](https://help.syncfusion.com/windowsforms/menu/mdi-child-forms) +* **MDI layout** - Supports MDI layout. Learn more in [MDIChildForms](https://help.syncfusion.com/windowsforms/menu/mdi-child-forms). -* **ToolTip** - Provides options to set ToolTip for each BarItem. +* **ToolTip** - Provides options to set a ToolTip for each `BarItem`. diff --git a/WindowsForms/Menu/State-Persistance.md b/WindowsForms/Menu/State-Persistance.md index b2d047814..f60a88e27 100644 --- a/WindowsForms/Menu/State-Persistance.md +++ b/WindowsForms/Menu/State-Persistance.md @@ -13,13 +13,13 @@ The menu control supports serialization persisting the state of the toolbars and ## Enabling state persistence -The menu control by default, enables the serialization and state persistence of the menu items. This can be done via the [`AutoLoadToolBarPositions`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_MainFrameBarManager_AutoLoadToolBarPositions) and [`AutoPersistCustomization`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_MainFrameBarManager_AutoLoadToolBarPositions). This can be done either via designer **Smart tag** options or through code. +The menu control by default enables the serialization and state persistence of the menu items. This can be done via the [`AutoLoadToolBarPositions`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_MainFrameBarManager_AutoLoadToolBarPositions) and [`AutoPersistCustomization`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.MainFrameBarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_MainFrameBarManager_AutoPersistCustomization) properties. This can be done either via the designer **Smart tag** options or through code. The below image shows the serialization is being enabled via the designer ![Enabling Serialization via designer](State-Persistance-images/enablingStatePersistence_Designer.png) -The below code snippet shows the enabling of toolbar state persistence and serialization of menu item state. +The following code snippet shows the enabling of toolbar state persistence and serialization of the menu item state. {% tabs %} diff --git a/WindowsForms/Menu/Theming.md b/WindowsForms/Menu/Theming.md index 3d4a767a1..47c83040b 100644 --- a/WindowsForms/Menu/Theming.md +++ b/WindowsForms/Menu/Theming.md @@ -9,7 +9,7 @@ documentation: ug # Theming in Windows Forms Menu (Menus) -In this section, the various themes supported in menu control is discussed. The required theme can be set via the [`Style`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarManager_Style) property of the menu instance. The following are the list of applicable themes to menu control. +This section discusses the various themes supported by the menu control. The required theme can be set via the [`Style`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarManager_Style) property of the menu instance. The following is the list of themes applicable to the menu control. * Default theme * Metro theme @@ -22,7 +22,7 @@ In this section, the various themes supported in menu control is discussed. The ## Default theme -The `Default` theme is applies the default styles to the visual components of the menu control. When this theme is applied the default color values can be modified based on the desired color values. The below code snippet shows the default theme is applied to the menu control. +The `Default` theme applies the default styles to the visual components of the menu control. When this theme is applied, the default color values can be modified based on the desired color values. The following code snippet shows the default theme being applied to the menu control. {% tabs %} @@ -68,7 +68,7 @@ MenuColors.CommandBarBackColor = Color.Yellow ## Metro Theme -The menu control is applied with standard metro colors to provide rich look and feel of the control. The below code snippet shows the `Metro` theme is applied to the menu control. +The menu control is applied with standard metro colors to provide a rich look and feel to the control. The following code snippet shows the `Metro` theme being applied to the menu control. {% tabs %} @@ -90,7 +90,7 @@ Me.mainFrameBarManager1.Style = Syncfusion.Windows.Forms.VisualStyle.Metro ## Office XP theme -The `OfficeXP` theme is the default theme of the menu control. This applies the default color values to all the components of the control. The below code snippet shows the Office XP theme is applied to the menu control. +The `OfficeXP` theme is the default theme of the menu control. This applies the default color values to all the components of the control. The following code snippet shows the Office XP theme being applied to the menu control. {% tabs %} @@ -134,7 +134,7 @@ Me.mainFrameBarManager1.Style = Syncfusion.Windows.Forms.VisualStyle.Office2003 ## Office 2007 theme -The menu control can be applied with 4 different Office 2007 color values. The color scheme can be selected via the `Office2007Theme` property is used. This color values can also be customized to required color scheme +The menu control can be applied with 4 different Office 2007 color values. The color scheme is selected via the `Office2007Theme` property. These color values can also be customized to a required color scheme. * Blue * Silver @@ -215,7 +215,7 @@ Me.mainFrameBarManager1.Office2007Theme = Office2007Theme.Silver ### Managed theme -The `Managed` color scheme applies with custom base color to the default Office colored theme. This custom base color is set via the `ApplyManagedColors` method in **Office2007Colors** class. The below code snippet shows the Office 2007 theme is applied to the menu control with red colored style. +The `Managed` color scheme applies a custom base color to the default Office colored theme. This custom base color is set via the `ApplyManagedColors` method in the **Office2007Colors** class. The following code snippet shows the Office 2007 theme being applied to the menu control with a red-colored style. {% tabs %} @@ -263,7 +263,7 @@ Me.mainFrameBarManager1.Style = Syncfusion.Windows.Forms.VisualStyle.Office2007O ## Office 2010 theme -The menu control can be applied with 4 different Office 2010 color values. The color scheme can be selected via the `Office2010Theme` property is used. This color values can also be customized to required color scheme. +The menu control can be applied with 4 different Office 2010 color values. The color scheme is selected via the `Office2010Theme` property. These color values can also be customized to a required color scheme. * Blue * Silver @@ -344,7 +344,7 @@ Me.mainFrameBarManager1.Office2010Theme = Office2010Theme.Silver ### Managed theme -The `Managed` color scheme applies with custom base color to the default Office colored theme. This custom base color is set via the `ApplyManagedColors` method in **Office2010Colors** class. The below code snippet shows the Office 2010 theme is applied to the menu control with brick colored style. +The `Managed` color scheme applies a custom base color to the default Office colored theme. This custom base color is set via the `ApplyManagedColors` method in the **Office2010Colors** class. The following code snippet shows the Office 2010 theme being applied to the menu control with a brick-colored style. {% tabs %} diff --git a/WindowsForms/Menu/Touch-Support.md b/WindowsForms/Menu/Touch-Support.md index 5da7a1dca..bdb052667 100644 --- a/WindowsForms/Menu/Touch-Support.md +++ b/WindowsForms/Menu/Touch-Support.md @@ -9,7 +9,7 @@ documentation: ug # Touch Support in Windows Forms Menu (Menus) -The menu control supports to touch mode to the menu items and other visual elements. The components are also scaled automatically to render the menu items. This can be done by using the [`EnableTouchMode`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarManager_EnableTouchMode) property or the menu instance. The below code snippet shows the touch mode is being enabled in the menu. +The menu control supports touch mode for the menu items and other visual elements. The components are also scaled automatically to render the menu items appropriately. This can be done by setting the [`EnableTouchMode`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.XPMenus.BarManager.html#Syncfusion_Windows_Forms_Tools_XPMenus_BarManager_EnableTouchMode) property of the menu instance. The following code snippet shows touch mode being enabled in the menu. By default, this property is set to `false`. @@ -35,12 +35,12 @@ Me.mainFrameBarManager1.EnableTouchMode = True ## Touch selection -When the property `EnableTouchMode` is set to `true`, menu items can be selected via general touch action. The below image shows the menu items are being selected with touch action. +When the `EnableTouchMode` property is set to `true`, menu items can be selected via a general touch action. The image below shows menu items being selected with a touch action. ![Menu items selected with touch action](Touch-Support-images/menu_Touch_Selection.png) ## Context menu -Tap and holding on the menu bar or a menu item will display the corresponding context menu for the menu bar. The below screen shot shows the context menu is displayed when tap and hold on the main menu bar. +Tap and holding on the menu bar or a menu item displays the corresponding context menu for the menu bar. The screenshot below shows the context menu displayed when tapping and holding on the main menu bar. ![Context menu in menu bar](Touch-Support-images/menu_with_ContextMenu.png) diff --git a/WindowsForms/Metro-Form/Appearance.md b/WindowsForms/Metro-Form/Appearance.md index e2e468884..fdaee1d4b 100644 --- a/WindowsForms/Metro-Form/Appearance.md +++ b/WindowsForms/Metro-Form/Appearance.md @@ -77,7 +77,7 @@ Me.CaptionBarHeight = 40 ### Retain the caption bar height on maximized mode -By Default, the height of the caption bar will be reduced when the form is in maximized state. It can be retained same in both normal and maximized state by setting the property [MetroForm.CaptionBarHeightMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.MetroForm.html#Syncfusion_Windows_Forms_MetroForm_CaptionBarHeightMode) as `SameAlwaysOnMaximize`. +By default, the height of the caption bar is reduced when the form is in the maximized state. The same height can be retained in both normal and maximized state by setting the [MetroForm.CaptionBarHeightMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.MetroForm.html#Syncfusion_Windows_Forms_MetroForm_CaptionBarHeightMode) property to `SameAlwaysOnMaximize`. {% tabs %} diff --git a/WindowsForms/Metro-Form/Customization.md b/WindowsForms/Metro-Form/Customization.md index cfd1201ef..af70351f4 100644 --- a/WindowsForms/Metro-Form/Customization.md +++ b/WindowsForms/Metro-Form/Customization.md @@ -16,11 +16,11 @@ Caption label can be added to the MetroForm through designer or code. ### Through designer -1) Labels can be added to the CaptionBar using `CaptionLabels` collection property. +1. Labels can be added to the CaptionBar using the `CaptionLabels` collection property. ![Caption label With Designer](Customization_images/customization_img2.png) -2) Add Labels through collection editor window. +2. Add Labels through the collection editor window. ![Add Labels With collection editor window](Customization_images/customization_img3.png) @@ -72,28 +72,28 @@ Me.CaptionLabels.Add(captionLabel1) ## Caption images -Caption images can be added to the MetroForm through designer or code. +Caption images can be added to the MetroForm through the designer or code. ### Through designer -1) Images can be added to the CaptionBar using CaptionImages collection property. +1. Images can be added to the CaptionBar using the `CaptionImages` collection property. ![Caption image added through CaptionBar](Customization_images/Caption-Image-Customization_img1.jpeg) -2) Add images through collection editor window. +2. Add images through the collection editor window. ![Caption image added through collection editor window](Customization_images/Caption-Image-Customization_img2.jpeg) -3) Image can be added to the CaptionImage using Image property in Collection Editor. +3. An image can be added to the CaptionImage using the `Image` property in the **Collection Editor**. ![Caption image added with Image property](Customization_images/Caption-Image-Customization_img3.jpeg) ### Through code -The following code sample shows how to add an image to the caption bar of the Metro form. +The following code sample shows how to add an image to the caption bar of the MetroForm. {% tabs %} @@ -236,7 +236,7 @@ Me.CaptionButtonHoverColor = System.Drawing.Color.Lime ## Caption bar background -User can customize the Brush effects in Caption Bar using the event CaptionBarPaint and the property CaptionBarBrush. +You can customize the Brush effects in the CaptionBar using the `CaptionBarPaint` event and the `CaptionBarBrush` property. {% tabs %} @@ -282,23 +282,23 @@ End Sub ### ImageMouseDown event -The ImageMouseDown event is raised when the mouse pointer is over the caption image and a mouse button is pressed. +The `ImageMouseDown` event is raised when the mouse pointer is over the caption image and a mouse button is pressed. ### ImageMouseUp event -The ImageMouseUp event is raised when the mouse pointer is over the caption image and a mouse button is released. +The `ImageMouseUp` event is raised when the mouse pointer is over the caption image and a mouse button is released. ### ImageMouseEnter event -The ImageMouseEnter event is raised when the mouse pointer enters the caption image. +The `ImageMouseEnter` event is raised when the mouse pointer enters the caption image. ### ImageMouseLeave event -The ImageMouseLeave event is raised when the mouse pointer leaves the caption image. +The `ImageMouseLeave` event is raised when the mouse pointer leaves the caption image. ### ImageMouseMove event -The ImageMouseMove event is raised when the mouse pointer moves within the caption image. +The `ImageMouseMove` event is raised when the mouse pointer moves within the caption image. #### Event data diff --git a/WindowsForms/Metro-Form/Getting-Started.md b/WindowsForms/Metro-Form/Getting-Started.md index a21bff9e5..c3e58a5c8 100644 --- a/WindowsForms/Metro-Form/Getting-Started.md +++ b/WindowsForms/Metro-Form/Getting-Started.md @@ -13,7 +13,7 @@ This section describes how to configure `MetroForm` control in a Windows Forms a ## Assembly deployment -Refer [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#metroform) section to get the list of assemblies or NuGet package needs to be added as reference to use the control in any application. +Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#metroform) section to get the list of assemblies or NuGet packages that need to be added as a reference to use the control in any application. Please find more details regarding how to install the nuget packages in windows form application in the below link: @@ -21,7 +21,7 @@ Please find more details regarding how to install the nuget packages in windows ## Creating simple application with MetroForm -You can create the Windows Forms application with MetroForm control as follows: +You can create a Windows Forms application with the MetroForm control as follows: 1. [Creating project](#creating-the-project) 2. [Configure MetroForm](#configure-metroForm) @@ -40,7 +40,7 @@ Create a new Windows Forms project in the Visual Studio to change the default fo * Syncfusion.Shared.Base.dll -**Step 2** - Include the namespaces **Syncfusion.Windows.Forms**. +**Step 2** - Include the namespace **Syncfusion.Windows.Forms**. {% tabs %} @@ -58,7 +58,7 @@ Imports Syncfusion.Windows.Forms {% endtabs %} -**Step 3** - Change the class to inherit MetroForm instead of the default Form as follows. +**Step 3** - Change the class to inherit `MetroForm` instead of the default `Form` as follows. {% tabs %} diff --git a/WindowsForms/Metro-Form/Overview.md b/WindowsForms/Metro-Form/Overview.md index a90cf45fb..3688bf165 100644 --- a/WindowsForms/Metro-Form/Overview.md +++ b/WindowsForms/Metro-Form/Overview.md @@ -9,7 +9,7 @@ documentation: ug # Windows Forms MetroForm Overview -[MetroForm](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.MetroForm.html) is used to create customizable window for the end user’s applications. The features offered includes resizing, dragging and moving the window. It also supports various built in skins and let the user to control its behavior and appearance . +[MetroForm](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.MetroForm.html) is used to create a customizable window for the end user's application. The features offered include resizing, dragging, and moving the window. It also supports various built-in skins and lets the user control its behavior and appearance. ![Metro style form for Windows Forms](Overview_images/Overview.png) @@ -27,4 +27,4 @@ documentation: ug ## Choose between different form controls -You can refer to the different button controls [here](https://help.syncfusion.com/windowsforms/form/overview#choose-between-different-form-controls). +You can refer to the different form controls [here](https://help.syncfusion.com/windowsforms/form/overview#choose-between-different-form-controls). diff --git a/WindowsForms/autocomplete/AutoComplete-Events.md b/WindowsForms/autocomplete/AutoComplete-Events.md index 10a64cdf3..efbab7616 100644 --- a/WindowsForms/autocomplete/AutoComplete-Events.md +++ b/WindowsForms/autocomplete/AutoComplete-Events.md @@ -7,9 +7,9 @@ control: AutoComplete documentation: ug --- -# Autocomplete Events in Windows Forms AutoComplete +# AutoComplete Events in Windows Forms AutoComplete -The events of the AutoComplete component are as follows. +The events of the AutoComplete component are listed below. @@ -56,7 +56,7 @@ Occurs when the editor control of the AutoComplete component changes. ## AutoCompleteItemSelected event -This event occurs while selecting a new item when the AutoComplete mode is set to AutoSuggest. +This event is raised while a new item is selected when the AutoComplete mode is set to `AutoSuggest`. The event handler receives an argument of type `AutoCompleteItemEventArgs`. ## BeforeAddItem Event @@ -79,7 +79,7 @@ Gets or sets the ColumnIndex into the AutoComplete.ImageList property. +It is the `System.Data.DataRow` object that contains the value that is to be added to the history list.
RowItem -It is the System.Data.DataRow object that contains the value that is to be added to the history list.
{% tabs %} @@ -114,7 +114,7 @@ End Sub ## AutoCompleteItemBrowsed event -This event occurs when selecting an item from the list of possible matches when the AutoComplete is set to AutoSuggest. The event handler receives an argument of type AutoCompleteItemEventArgs. The event properties associated with the AutoCompleteItemEventArgs are as follows. +This event is raised when selecting an item from the list of possible matches when the AutoComplete is set to `AutoSuggest`. The event handler receives an argument of type `AutoCompleteItemEventArgs`. The event properties associated with the `AutoCompleteItemEventArgs` are as follows. @@ -128,7 +128,7 @@ Gets or sets the value selected. +Specifies whether `SelectedValue` should be applied to the editor control. This property can be used only with the `AutoCompleteItemSelected` event. +Sets the Datasource to the AutoComplete component. The AutoComplete component automatically picks the "History Data List" mode or "Data source" mode based on the values set for the DataSource property. When the DataSource property is set to NULL (default value is NULL), the component defaults to History Data List mode. The properties `CategoryName`, `AutoAddItem`, and `AutoSerialize` have to be set appropriately for the History Data List mode to work properly.
Handled -Specifies whether SelectedValue should be applied to editor control. This can be used only with AutoCompleteItemSelected.
ItemArray diff --git a/WindowsForms/autocomplete/Customization.md b/WindowsForms/autocomplete/Customization.md index fd0844c90..8749d3818 100644 --- a/WindowsForms/autocomplete/Customization.md +++ b/WindowsForms/autocomplete/Customization.md @@ -335,7 +335,7 @@ Sets the default theme. ## Persistence -The history list of AutoComplete component can be saved in the following formats: +The history list of the AutoComplete component can be saved in the following formats: * Binary Format * XML Format @@ -343,11 +343,11 @@ The history list of AutoComplete component can be saved in the following formats * MemoryStream * PersistState property -The AutoComplete component has a fully built-in serialization feature that provides automatic serialization for the AutoComplete's history list. The serialization mechanism is implemented using the standardized Syncfusion.Windows.Forms.AppStateSerializer component that acts as a central coordinator for all the Essential tools components and provides options to read or write to different media such as the default isolated storage, XML file, XML stream, binary file, binary stream, and the Windows Registry. +The AutoComplete component has a fully built-in serialization feature that provides automatic serialization for the AutoComplete's history list. The serialization mechanism is implemented using the standardized `Syncfusion.Windows.Forms.AppStateSerializer` component, which acts as a central coordinator for all the Essential Tools components and provides options to read or write to different media such as the default isolated storage, XML file, XML stream, binary file, binary stream, and the Windows Registry. ### Persisting AutoComplete's data in the default storage -The data of AutoComplete component can be persisted by setting the [AutoSerialize](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoSerialize) property to `true`. It specifies whether the AutoComplete component can persist its data. This information is stored in the isolated storage. +The data of the AutoComplete component can be persisted by setting the [AutoSerialize](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoSerialize) property to `true`. This specifies whether the AutoComplete component can persist its data. The information is stored in the isolated storage. {% tabs %} diff --git a/WindowsForms/autocomplete/DataSource.md b/WindowsForms/autocomplete/DataSource.md index ff46f8cb5..5853405da 100644 --- a/WindowsForms/autocomplete/DataSource.md +++ b/WindowsForms/autocomplete/DataSource.md @@ -9,7 +9,7 @@ documentation: ug # DataSource in Windows Forms AutoComplete -The AutoComplete component supports variety of data sources such as DataTables, DataSets, or any component that implement interfaces such as IList, IBindingList, ITypedList, and IListSource. For assigning data source to AutoComplete, use the [DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_DataSource) property. This section explains about the different types of data binding mechanisms and data settings supported by the AutoComplete component. +The AutoComplete component supports a variety of data sources such as DataTables, DataSets, or any component that implements interfaces such as `IList`, `IBindingList`, `ITypedList`, and `IListSource`. For assigning a data source to AutoComplete, use the [DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_DataSource) property. This section explains the different types of data binding mechanisms and data settings supported by the AutoComplete component. ## Data settings @@ -27,7 +27,7 @@ Specifies a unique or shared name that can be given to an AutoComplete component
DataSource -Sets the Datasource to the Autocomplete component. The AutoComplete component automatically picks the "History Data List" mode or "Data source" mode based on the values set for the DataSource property. When the datasource property is set to NULL (default value is NULL), the component defaults to History Data List mode. It is to be remembered that the properties CategoryName, AutoAddItem, and AutoSerialize have to be set appropriately for the History Data List mode to work properly.
{% tabs %} @@ -52,11 +52,11 @@ Me.autoComplete1.DataSource = DataTable1 ## Dynamic source at run time -Enabling the [AutoAddItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoAddItem) property allows you to save your entries at run time, and pressing the `Enter` key saves your entry. +Enabling the [AutoAddItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoAddItem) property allows you to save your entries at runtime. Pressing the `Enter` key adds the current entry to the history list. ## Built-in source -The different built-in source (FileSystem, HistoryList, AllUrl, etc) can be set to the AutoComplete component using the `AutoCompleteSource` property of the editor control. +The different built-in sources (`FileSystem`, `HistoryList`, `AllUrl`, etc.) can be set on the editor control using the standard `System.Windows.Forms.AutoCompleteSource` property, which is then used by the Syncfusion `AutoComplete` component when bound to that editor. @@ -121,7 +121,7 @@ Me.textBox1.AutoCompleteSource = System.Windows.Forms.AutoCompleteSource.History ## Custom source -The AutoComplete component allows you add a set of text using `String Collection Editor`, and this editor window will be shown by clicking the `AutoCompleteCustomSource` property in property window of the editor control. The `AutoCompleteSource` property should be set to `CustomSource` for using custom items added through String Collection Editor. +The AutoComplete component allows you to add a set of text using the `String Collection Editor`, which is shown by clicking the `AutoCompleteCustomSource` property in the property window of the editor control. The `AutoCompleteSource` property should be set to `CustomSource` to use the custom items added through the String Collection Editor. ![Windows Forms AutoComplete Customsource datasource](DataSource_images/AutoComplete_Customsource.png) @@ -150,7 +150,7 @@ The AutoComplete component allows you add a set of text using `String Collection ![Windows Forms AutoComplete Customsource datasource](DataSource_images/AutoComplete_Customsourcecode.png) -## Binding custom collections +## Binding custom collections The different custom collections that can be bound to the [DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_DataSource) property of the AutoComplete component are listed as follows. @@ -161,4 +161,4 @@ The different custom collections that can be bound to the [DataSource](https://h * Generic Collections * DataTable -A sample that demonstrates the binding of various data source is available [here](https://github.com/SyncfusionExamples/AutoCompleteModes_in_AutoComplete_Component/tree/master/DataSourceBinding) +A sample that demonstrates binding various data sources is available [here](https://github.com/SyncfusionExamples/AutoCompleteModes_in_AutoComplete_Component/tree/master/DataSourceBinding). diff --git a/WindowsForms/autocomplete/Getting-started.md b/WindowsForms/autocomplete/Getting-started.md index 52fab3940..876fe2bbe 100644 --- a/WindowsForms/autocomplete/Getting-started.md +++ b/WindowsForms/autocomplete/Getting-started.md @@ -13,17 +13,17 @@ This section provides a quick overview for working with the [AutoComplete](https ## Assembly deployment -Refer to the [Control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#autocomplete) section to get the list of assemblies or NuGet package that needs to be added as reference to use the component in any application. +Refer to the [Control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#autocomplete) section to get the list of assemblies or NuGet packages that need to be added as a reference to use the component in any application. -Refer to this [documentation](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to find more details about installing nuget packages in a Windows Forms application. +Refer to this [documentation](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to find more details about installing NuGet packages in a Windows Forms application. ## Creating Application with AutoComplete -In this walk through, users will create WinForms application that contains [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) control. +In this walk through, users will create a WinForms application that contains the [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) control. ### Creating the Project -Create new Windows Forms Project in Visual Studio to display [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) control. +Create a new Windows Forms project in Visual Studio to display the [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) control. ### Adding control via designer @@ -45,13 +45,13 @@ Create new Windows Forms Project in Visual Studio to display [AutoComplete](http * Syncfusion.Tools.Base * Syncfusion.Tools.Windows -2. Add the required namespace and create an instance for [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) and TextBox controls. +2. Add the required namespace and create an instance of the [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) and `TextBox` controls, then call `SetAutoComplete` to enable AutoComplete on the `TextBox`. {% capture codesnippet1 %} {% tabs %} {% highlight C# %} -Using Syncfusion.Windows.Forms.Tools +using Syncfusion.Windows.Forms.Tools; public Form1() { @@ -81,7 +81,7 @@ End Sub ### Enabling via designer -Set the **AutoComplete on autoComplete1** property as AutoSuggest using the drop-down provided in the TextBox properties dialog window. The Default value is `Disabled`. +Set the **AutoComplete on autoComplete1** property to `AutoSuggest` using the drop-down provided in the TextBox properties dialog window. The default value is `Disabled`. ![Windows forms AutoComplete toolbox customization](GettingStarted_images/Autocomplete_Propertywindow.png) @@ -117,19 +117,19 @@ End Sub ## Creating Datasource for Sample Application -The [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) component supports variety of data sources such as DataTables, DataSets, or any component that implement interfaces like IList, IBindingList, ITypedList, or IListSource. For assigning data source to AutoComplete, use the [DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_DataSource) property. +The [AutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html) component supports a variety of data sources such as DataTables, DataSets, or any component that implements interfaces like `IList`, `IBindingList`, `ITypedList`, or `IListSource`. For assigning a data source to AutoComplete, use the [DataSource](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_DataSource) property. {% tabs %} {% highlight C# %} private void Form1_Load(object sender, EventArgs e) { - //Create a data table + // Create a data table DataTable dt = new DataTable("Table1"); dt.Columns.Add("Country"); dt.Columns.Add("Capital"); - // Create a data set + // Create a DataSet DataSet ds = new DataSet(); ds.Tables.Add(dt); dt.Rows.Add(new string[] { "United Kingdom ", "London" }); diff --git a/WindowsForms/autocomplete/Overview.md b/WindowsForms/autocomplete/Overview.md index 1371d9b30..ceef79363 100644 --- a/WindowsForms/autocomplete/Overview.md +++ b/WindowsForms/autocomplete/Overview.md @@ -9,9 +9,9 @@ documentation: ug # Windows Forms AutoComplete Overview -The AutoComplete control is an extender control that provides AutoCompletion services to any edit control on the same form as the AutoComplete control. +The `AutoComplete` control is an extender control that provides AutoCompletion services to any edit control on the same form as the AutoComplete control. -AutoCompletion can be defined as prompting you with probable matches during data entry. This feature is similar to the AutoCompletion of the web addresses in the Internet Explorer address box. +AutoCompletion can be defined as prompting you with probable matches during data entry. This feature is similar to the AutoCompletion of web addresses in the Internet Explorer address box. ![Overview for Autocomplete](Overview_images/Overview_image1.png) diff --git a/WindowsForms/autocomplete/Working-with-AutoComplete.md b/WindowsForms/autocomplete/Working-with-AutoComplete.md index db52c4c4e..31aec4a80 100644 --- a/WindowsForms/autocomplete/Working-with-AutoComplete.md +++ b/WindowsForms/autocomplete/Working-with-AutoComplete.md @@ -13,7 +13,7 @@ This section explains how to work with various options in the AutoComplete compo ## Setting AutoComplete modes -The AutoComplete component provides the auto-complete support to the editor control based on the input text. It can be done using the [SetAutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_SetAutoComplete_System_Windows_Forms_Control_Syncfusion_Windows_Forms_Tools_AutoCompleteModes_) method. +The AutoComplete component provides the auto-complete support to the editor control based on the input text. You can enable a specific mode using the [SetAutoComplete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_SetAutoComplete_System_Windows_Forms_Control_Syncfusion_Windows_Forms_Tools_AutoCompleteModes_) method. The different types of AutoComplete modes are as follows. @@ -102,7 +102,7 @@ A sample that demonstrates the AutoComplete mode is available [here](https://git ## Case sensitivity -Specifies whether to ignore case for string comparison. It can be enabled by setting the [CaseSensitive](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_CaseSensitive) property to `true`. The default value of this property is `true`. +Specifies whether the string comparison is case-sensitive. When the [CaseSensitive](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_CaseSensitive) property is set to `true`, comparisons are case-sensitive; when set to `false`, case is ignored. The default value of this property is `true`. {% tabs %} @@ -122,7 +122,7 @@ Specifies whether to ignore case for string comparison. It can be enabled by set ## Match mode -The [MatchMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_MatchMode) property specifies the mode where the most appropriate match for the current content in the editor control is filled in the AutoComplete history list. The default value is `Automatic`. +The [MatchMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_MatchMode) property specifies the matching algorithm used to find the most appropriate match for the current content in the editor control from the AutoComplete history list. The default value is `Automatic`. The following code snippet implements column configuration. @@ -143,11 +143,11 @@ Me.autoComplete1.MatchMode = AutoCompleteMatchModes.Automatic {% endtabs %} -## Matching column +## Matching column -The [MatchingColumn](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoCompleteDataColumnInfo.html#Syncfusion_Windows_Forms_Tools_AutoCompleteDataColumnInfo_MatchingColumn) indicates the represented column to be treated as matching column. The default value of this property is `true` for 0th index column. +The [MatchingColumn](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoCompleteDataColumnInfo.html#Syncfusion_Windows_Forms_Tools_AutoCompleteDataColumnInfo_MatchingColumn) property indicates whether the column it represents should be treated as the matching column. The default value of this property is `true` for the column at the 0th index. -Refresh column before setting MatchingColumn using the [RefreshColumns](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_RefreshColumns) method. +Refresh the columns before setting `MatchingColumn` by calling the [RefreshColumns](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_RefreshColumns) method. {% tabs %} @@ -169,7 +169,7 @@ this.autoComplete1.Columns[1].MatchingColumn = true; ## Sorting items -Specifies whether sorting needs to be performed in the items present in the AutoComplete popup. It can be done by setting the [AutoSortList](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoSortList) property to `true`. The default value of this property is `true`. +Specifies whether sorting is performed on the items displayed in the AutoComplete popup. Sorting can be enabled by setting the [AutoSortList](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoSortList) property to `true`. The default value of this property is `true`. {% tabs %} @@ -191,7 +191,7 @@ N> The items are sorted on the basis of the column whose [MatchingColumn](https: ## Handling duplicate values -The duplicate values can be used in AutoComplete data source by setting the [EnableDuplicateValues](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_EnableDuplicateValues) property to `true`. +Duplicate values are allowed in the AutoComplete data source when the [EnableDuplicateValues](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_EnableDuplicateValues) property is set to `true`. The default value is `false`. {% tabs %} @@ -213,7 +213,7 @@ The duplicate values can be used in AutoComplete data source by setting the [Ena ### Adding items to history list -The current input text in the editor control can be added to the history list at run time when the Enter key is pressed. This support can be enabled by setting the [AutoAddItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoAddItem) property to `true`. The default value of this property is `false`. +The current input text in the editor control can be added to the history list at runtime when the `Enter` key is pressed. This support can be enabled by setting the [AutoAddItem](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoAddItem) property to `true`. The default value of this property is `false`. {% tabs %} @@ -233,7 +233,7 @@ The current input text in the editor control can be added to the history list at ### Deleting items from history list -The current selected item can be removed from auto complete popup when the `Delete` key is pressed at run time. This support can be enabled by setting the [AllowListDelete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AllowListDelete) property to `true`. +The currently selected item can be removed from the AutoComplete popup when the `Delete` key is pressed at runtime. This support can be enabled by setting the [AllowListDelete](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AllowListDelete) property to `true`. {% tabs %} @@ -253,7 +253,7 @@ The current selected item can be removed from auto complete popup when the `Dele ### Deleting history -The history items persisted by the AutoComplete component can be deleted by invoking the [ResetHistory](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_ResetHistory) method. The entire history list in the AutoComplete popup will be deleted. +The history items persisted by the AutoComplete component can be deleted by invoking the [ResetHistory](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_ResetHistory) method. The entire history list in the AutoComplete popup is cleared. {% tabs %} @@ -273,7 +273,7 @@ The history items persisted by the AutoComplete component can be deleted by invo ## Setting maximum number of suggestions -You can limit the number of suggestions need to be displayed in the AutoComplete popup using the [MaxNumberofSuggestion](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_MaxNumberofSuggestion) property. +You can limit the number of suggestions displayed in the AutoComplete popup using the [MaxNumberOfSuggestions](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_MaxNumberofSuggestion) property. ![Windows Forms AutoComplete Maximum number of suggestions](WorkingwithAutoComplete_images/AutoComplete_Maxsuggestions.png) @@ -303,7 +303,7 @@ A sample that demonstrates the above feature is available [here](https://github. ## Integration with RichTextBox control -The auto-complete functionality can be added to the RichTextBox control. The following steps are used to integrate the RichTextBox with the AutoComplete component: +The auto-complete functionality can be added to a `RichTextBox` control. The following steps are used to integrate the `RichTextBox` with the AutoComplete component: 1. Implement the `IEditControlsEmbed` interface in a CustomRichTextBox class that enables the AutoComplete functionality for the RichTextBox control. @@ -369,7 +369,7 @@ A sample that demonstrates the integration with RichTextBox control is available ## Opening the AutoComplete popup programmatically -The AutoComplete popup can be shown programmatically using the [AutoCompletePopup](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoCompletePopup) method. +The AutoComplete popup can be shown programmatically by setting the parent control and calling `ShowPopup` on the [AutoCompletePopup](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.AutoComplete.html#Syncfusion_Windows_Forms_Tools_AutoComplete_AutoCompletePopup) property. {% tabs %} From 3e02df890983df2d66c713a568046e665105c913 Mon Sep 17 00:00:00 2001 From: harinath-2699 Date: Thu, 9 Jul 2026 13:09:55 +0530 Subject: [PATCH 07/36] 1039182 - Committed TabControl changes for doc issues --- .../TabControl/Appearance-Settings.md | 32 +++++++++---------- WindowsForms/TabControl/Customization.md | 26 +++++++-------- WindowsForms/TabControl/Events.md | 24 +++++++------- WindowsForms/TabControl/Getting-Started.md | 12 +++---- .../TabControl/Interactive-Features.md | 16 +++++----- WindowsForms/TabControl/Overview.md | 4 +-- WindowsForms/TabControl/Tab-Navigation.md | 8 ++--- 7 files changed, 59 insertions(+), 63 deletions(-) diff --git a/WindowsForms/TabControl/Appearance-Settings.md b/WindowsForms/TabControl/Appearance-Settings.md index 49524c4db..7a77ff3d8 100644 --- a/WindowsForms/TabControl/Appearance-Settings.md +++ b/WindowsForms/TabControl/Appearance-Settings.md @@ -82,15 +82,15 @@ this.tabPageAdv1.BackgroundImageLayout = System.Windows.Forms.ImageLayout.Right; -Private Me.tabPageAdv1.BackgroundImage = imageList1.Images(0) +Me.tabPageAdv1.BackgroundImage = imageList1.Images(0) -Private Me.tabPageAdv1.BackgroundImageLayout = System.Windows.Forms.ImageLayout.Right +Me.tabPageAdv1.BackgroundImageLayout = System.Windows.Forms.ImageLayout.Right {% endhighlight %} {% endtabs %} -### DisableInActivePageImage +### Disable Inactive Page Image The [DisableInactivePageImage](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_DisableInactivePageImage) property specifies the value which determines whether the image should be disabled when the TabPage is not selected. The default value is `true`. @@ -98,14 +98,14 @@ The [DisableInactivePageImage](https://help.syncfusion.com/cr/windowsforms/Syncf {% highlight C# %} -this.tabPageAdv1.DisableInactivePageImage = imageList1.Images[0]; +this.tabPageAdv1.DisableInactivePageImage = true; {% endhighlight %} {% highlight VB %} -Private Me.tabPageAdv1.DisableInactivePageImage = imageList1.Images(0) +Me.tabPageAdv1.DisableInactivePageImage = True {% endhighlight %} @@ -139,15 +139,15 @@ this.tabPageAdv1.TabBackColor = System.Drawing.Color.Pink; {% highlight VB %} -Private Me.tabControlAdv1.ActiveTabColor = System.Drawing.Color.Ivory +Me.tabControlAdv1.ActiveTabColor = System.Drawing.Color.Ivory -Private Me.tabControlAdv1.InactiveTabColor = System.Drawing.Color.Silver +Me.tabControlAdv1.InactiveTabColor = System.Drawing.Color.Silver -Private Me.tabControlAdv1.TabPanelBackColor = System.Drawing.Color.White +Me.tabControlAdv1.TabPanelBackColor = System.Drawing.Color.White -Private Me.tabControlAdv1.BackColor = System.Drawing.Color.Yellow +Me.tabControlAdv1.BackColor = System.Drawing.Color.Yellow -Private Me.tabPageAdv1.TabBackColor = System.Drawing.Color.Pink +Me.tabPageAdv1.TabBackColor = System.Drawing.Color.Pink {% endhighlight %} @@ -172,9 +172,9 @@ The font settings for the [TabControlAdv](https://help.syncfusion.com/cr/windows {% highlight C# %} -this.tabControlAdv1.ActiveTabFont = new System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, ((byte)(0))); +this.tabControlAdv1.ActiveTabFont = new System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, (byte)0); -this.tabControlAdv1.Font = new System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0))); +this.tabControlAdv1.Font = new System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, (byte)0); {% endhighlight %} @@ -182,9 +182,9 @@ this.tabControlAdv1.Font = new System.Drawing.Font("Verdana", 8.25F, System.Draw -Private Me.tabControlAdv1.ActiveTabFont = New System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, (CByte(0))) +Me.tabControlAdv1.ActiveTabFont = New System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, CByte(0)) -Private Me.tabControlAdv1.Font = New System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, (CByte(0))) +Me.tabControlAdv1.Font = New System.Drawing.Font("Verdana", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, CByte(0)) {% endhighlight %} @@ -205,7 +205,7 @@ Specifies the Font for the tab item. {% highlight C# %} -this.tabPageAdv1.TabFont = new System.Drawing.Font("Trebuchet MS", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0))); +this.tabPageAdv1.TabFont = new System.Drawing.Font("Trebuchet MS", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, (byte)0); {% endhighlight %} @@ -238,7 +238,7 @@ this.tabPageAdv1.TabForeColor = System.Drawing.Color.Sienna; {% highlight VB %} -Private Me.tabPageAdv1.TabForeColor = System.Drawing.Color.Sienna +Me.tabPageAdv1.TabForeColor = System.Drawing.Color.Sienna {% endhighlight %} diff --git a/WindowsForms/TabControl/Customization.md b/WindowsForms/TabControl/Customization.md index 6304fbbd1..a144b4776 100644 --- a/WindowsForms/TabControl/Customization.md +++ b/WindowsForms/TabControl/Customization.md @@ -17,7 +17,7 @@ TabControlAdv comes with the renaming functionality similar to Microsoft Excel. To bring the text of the TabItem to the edit mode, the following can be done. -1. Select the text of the TabItem to be edited and right-click on the tab to bring the text to edit mode. The text can now be edited and it can be saved by pressing the Enter key. +1. Select the text of the TabItem to be edited and right-click on the tab to bring the text to edit mode. The text can now be edited and saved by pressing Enter. 2. Also, double-clicking on a tab makes the text change to edit mode. ![Renaming tab item](TabControlAdv_images/TabControlAdv_img1.png) @@ -80,18 +80,18 @@ Code snippets to set the padding {% highlight C# %} -// Setting the Padding for TabControlAdv through Coding. +// Setting the Padding for TabControlAdv through Coding. -this.tabControlAdv1.Padding = new Point(12, 12); +this.tabControlAdv1.Padding = new System.Windows.Forms.Padding(12, 12); {% endhighlight %} {% highlight VB %} -'Setting the Padding for TabControlAdv through Coding. +'Setting the Padding for TabControlAdv through Coding. -Me.tabControlAdv1.Padding = New Point(12, 12) +Me.tabControlAdv1.Padding = New System.Windows.Forms.Padding(12, 12) {% endhighlight %} @@ -101,7 +101,7 @@ Me.tabControlAdv1.Padding = New Point(12, 12) ## UseMnemonic -This [UseMnemonic](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_UseMnemonic) property specifies whether the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html) interprets the Ampersand character (&) as an Access key prefix character or not. The default value is set to `false`. +This [UseMnemonic](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_UseMnemonic) property specifies whether the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html) interprets the ampersand character (&) as an access-key prefix character. The default value is set to `false`. ## TabPages @@ -112,7 +112,7 @@ The [BorderStyle](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows The three types of border styles are given below. * FixedSingle -* Fixed 3D +* Fixed3D * None ![Tab border style](TabControlAdv_images/TabControlAdv_img6.jpeg) @@ -162,7 +162,7 @@ The following code illustrates insertion of the required GIF image. {% highlight C# %} -this.tabPageAdv.Image = Image.FromFile(“sample.gif”); +this.tabPageAdv.Image = Image.FromFile("sample.gif"); this.tabPageAdv.ImageSize = new System.Drawing.Size(16,16); @@ -183,7 +183,7 @@ Now, the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion. //Prevents moving the tab. -this this.tabControlAdv1.TabMoving += new Syncfusion.Windows.Forms.Tools.TabMovingEventHandler(tabControlAdv1_TabMoving); +this.tabControlAdv1.TabMoving += new Syncfusion.Windows.Forms.Tools.TabMovingEventHandler(tabControlAdv1_TabMoving); void tabControlAdv1_TabMoving(object sender, Syncfusion.Windows.Forms.Tools.TabMovingEventArgs e) { @@ -196,17 +196,15 @@ void tabControlAdv1_TabMoving(object sender, Syncfusion.Windows.Forms.Tools.TabM } - } + } {% endhighlight %} {% highlight VB %} -‘Prevents moving the tab. - -Private Me.tabControlAdv1.TabMoving += New Syncfusion.Windows.Forms.Tools.TabMovingEventHandler(AddressOf tabControlAdv1_TabMoving) - +'Prevents moving the tab. +AddHandler Me.tabControlAdv1.TabMoving, AddressOf tabControlAdv1_TabMoving Private Sub tabControlAdv1_TabMoving(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Tools.TabMovingEventArgs) diff --git a/WindowsForms/TabControl/Events.md b/WindowsForms/TabControl/Events.md index da5a12abb..300d674ac 100644 --- a/WindowsForms/TabControl/Events.md +++ b/WindowsForms/TabControl/Events.md @@ -11,7 +11,7 @@ documentation: ug ## AfterEdit event -This [AfterEdit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_AfterEdit) event occurs after text editing is completed. It is fired even if no changes are made. +This [AfterEdit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_AfterEdit) event occurs after text editing is completed. It fires even if no changes are made. ### Event data @@ -59,7 +59,7 @@ End Sub ## BeforeEdit event -This [BeforeEdit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_BeforeEdit) event occurs when the text enters into Edit mode. +This [BeforeEdit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_BeforeEdit) event occurs when the text enters Edit mode. ### Event data @@ -175,7 +175,7 @@ Console.Write("BackgroundImageLayoutChanged event is raised"); {% highlight VB %} -Private Sub tabControlAdv1_BackgroundImageLayout(ByVal sender As Object, ByVal e As System.Windows.Forms.EventArgs) +Private Sub tabControlAdv1_BackgroundImageLayoutChanged(ByVal sender As Object, ByVal e As System.Windows.Forms.EventArgs) 'Below line will be displayed in the output window at run-time, when this event is fired. @@ -393,6 +393,8 @@ switch(this.comboBox1.SelectedIndex) { +// The helper methods (Tab_DrawItemYahooMessengerLike / Tab_DrawItemMSNMessengerLike) are sample-specific and must be defined in your project. + case 0:this.Tab_DrawItemYahooMessengerLike(sender, drawItemInfo); break; @@ -411,7 +413,7 @@ break; -Private Sub tabControlExt1_DrawItem(ByVal sender As System.Object, ByVal drawItemInfo As Syncfusion.Windows.Forms.Tools.DrawTabEventArgs) Handles tabControlExt1.DrawItem +Private Sub tabControlAdv1_DrawItem(ByVal sender As System.Object, ByVal drawItemInfo As Syncfusion.Windows.Forms.Tools.DrawTabEventArgs) Handles tabControlAdv1.DrawItem drawItemInfo.DrawBackground() @@ -725,7 +727,7 @@ Console.Write("Key code :" + e.KeyCode.ToString() + "\n" + "Key Value :" + e.Key Private Sub tabControlAdv1_PreviewKeyDown(ByVal sender As Object, ByVal e As System.Windows.Forms.PreviewKeyDownEventArgs) -//Below line will be displayed in the output window at run-time, when this event is fired. +'Below line will be displayed in the output window at run-time, when this event is fired. Console.Write("PreviewKeyDown event is raised") @@ -778,7 +780,7 @@ End Sub ## TabPrimitiveClick event -This [TabPrimitiveClick](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_TabPrimitiveClick) event occurs before the `NavigationButton` click. +This [TabPrimitiveClick](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_TabPrimitiveClick) event occurs when a navigation button is clicked. ### Event data @@ -846,7 +848,7 @@ End Sub ## SelectedIndexChanging event -[SelectedIndexChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_SelectedIndexChanging) event occurs while changing the [SelectedIndex](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_SelectedIndex) or [SelectedTab](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_SelectedTab) of the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html). Tab Selection can be restricted by setting args.Cancel to `true`. +[SelectedIndexChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_SelectedIndexChanging) event occurs while changing the [SelectedIndex](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_SelectedIndex) or [SelectedTab](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_SelectedTab) of the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html). Tab selection can be canceled by setting `args.Cancel = true`. {% tabs %} @@ -896,7 +898,7 @@ private void TabControlAdv1_SelectedIndexChanged(object sender, EventArgs e) { -foreach (TabPageAdv item in this.tabControlAdv1.TabPages) +foreach (Syncfusion.Windows.Forms.Tools.TabPageAdv item in this.tabControlAdv1.TabPages) { @@ -936,7 +938,7 @@ End Sub ## TabsOrderChanged event -This [TabsOrderChanged](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_TabsOrderChanged) event occurs when the order of the tabs are changed in the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html). +This [TabsOrderChanged](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_TabsOrderChanged) event occurs when the order of the tabs is changed in the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html). {% tabs %} @@ -954,10 +956,6 @@ this.tabControlAdv1.UserMoveTabs = true; this.tabControlAdv1.TabsOrderChanged+=new EventHandler(tabControlAdv1_TabsOrderChanged); -} - - - private void tabControlAdv1_TabsOrderChanged(object sender, EventArgs e) { diff --git a/WindowsForms/TabControl/Getting-Started.md b/WindowsForms/TabControl/Getting-Started.md index cede654fe..6cab3fc90 100644 --- a/WindowsForms/TabControl/Getting-Started.md +++ b/WindowsForms/TabControl/Getting-Started.md @@ -58,7 +58,7 @@ You can add any control in tab page. ## Add control manually in code -To add the control manually in C#, follow the given steps: +To add the control manually in code, follow the given steps: 1. Add the following required assembly references to the project: @@ -105,13 +105,13 @@ Create an instance of [TabPageAdv](https://help.syncfusion.com/cr/windowsforms/S {% tabs %} {% highlight C# %} TabPageAdv tabPageAdv1 = new TabPageAdv(); -this.tabPageAdv1.Text = "tabPageAdv1"; -this.tabControlAdv1.Controls.Add(this.tabPageAdv1); +tabPageAdv1.Text = "tabPageAdv1"; +this.tabControlAdv1.Controls.Add(tabPageAdv1); {% endhighlight %} {% highlight VB %} Dim tabPageAdv1 As TabPageAdv = New TabPageAdv() -Me.tabControlAdv1.Controls.Add(Me.tabPageAdv1) -Me.tabPageAdv1.Text = "tabPageAdv1" +tabPageAdv1.Text = "tabPageAdv1" +Me.tabControlAdv1.Controls.Add(tabPageAdv1) {% endhighlight %} {% endtabs %} @@ -167,7 +167,7 @@ tabControlAdv1.Alignment = TabAlignment.Bottom ## Edit header at run time -You can rename or edit the header at run time by enabling the [LabelEdit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_LabelEdit) property of [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html). +You can rename the tab header at run time by setting the [LabelEdit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_LabelEdit) property of [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html) to `true`. {% tabs %} {% highlight C# %} diff --git a/WindowsForms/TabControl/Interactive-Features.md b/WindowsForms/TabControl/Interactive-Features.md index 228075ebe..e2a8b33f2 100644 --- a/WindowsForms/TabControl/Interactive-Features.md +++ b/WindowsForms/TabControl/Interactive-Features.md @@ -15,7 +15,7 @@ documentation: ug ![Tabs with close button](Interactive-Features_images/Interactive-Features_img3.jpeg) -Close button on all the TabItems can be made visible by setting the [ShowTabCloseButton](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_ShowTabCloseButton) property to`true`. +Close button on all the TabItems can be made visible by setting the [ShowTabCloseButton](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_ShowTabCloseButton) property to `true`. {% tabs %} @@ -65,7 +65,7 @@ this.tabControlAdv1.CloseTabOnMiddleClick = true; {% endhighlight %} {% highlight VB %} -Me.tabControlAdv1.CloseTabOnMiddleClick = true +Me.tabControlAdv1.CloseTabOnMiddleClick = True {% endhighlight %} {% endtabs %} @@ -131,7 +131,7 @@ This section discusses about the Scrolling properties available in the [TabContr ### ScrollButton -TabControlAdv has the ability to add ScrollButtons on the TabPanel when the number of tab items increase. These ScrollButtons allows the user to navigate through the TabPages in the front and back. For this, the [ShowScroll](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_ShowScroll) property of the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html) must be set. +TabControlAdv has the ability to add ScrollButtons on the TabPanel when the number of tab items increase. These ScrollButtons allow the user to navigate through the TabPages in the front and back. For this, the [ShowScroll](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html#Syncfusion_Windows_Forms_Tools_TabControlAdv_ShowScroll) property of the [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html) must be set. ScrollButtons can have a VS like scroll button-look and normal button look. @@ -191,15 +191,15 @@ this.tabControlAdv1.BringSelectedTabToView(); {% highlight VB %} -Private Me.tabPageAdv1.AutoScroll = True +Me.tabPageAdv1.AutoScroll = True -Private Me.tabPageAdv1.AutoScrollMargin = New System.Drawing.Size(20, 20) +Me.tabPageAdv1.AutoScrollMargin = New System.Drawing.Size(20, 20) -Private Me.tabPageAdv1.AutoScrollMinSize = New System.Drawing.Size(50, 50) +Me.tabPageAdv1.AutoScrollMinSize = New System.Drawing.Size(50, 50) -Private Me.tabControlAdv1.ScrollIncrement = Syncfusion.Windows.Forms.Tools.ScrollIncrement.Page +Me.tabControlAdv1.ScrollIncrement = Syncfusion.Windows.Forms.Tools.ScrollIncrement.Page -Private Me.tabPageAdv1.BringSelectedTabToView() +Me.tabControlAdv1.BringSelectedTabToView() {% endhighlight %} diff --git a/WindowsForms/TabControl/Overview.md b/WindowsForms/TabControl/Overview.md index 18ca1a2aa..3d8737e30 100644 --- a/WindowsForms/TabControl/Overview.md +++ b/WindowsForms/TabControl/Overview.md @@ -9,7 +9,7 @@ documentation: ug # Windows Forms TabControl (TabControlAdv) Overview -The [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html) is an advanced form of standard TabControl that enables an end-user to arrange visual content in a compacted and organized form in less space. It has many efficient features like standard TabControl, along with plenty of appearance customization and configuration capabilities. +The [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TabControlAdv.html) is an advanced form of the standard TabControl that enables an end-user to arrange visual content in a compacted and organized form in less space. It includes all standard TabControl features, plus extensive appearance and configuration options. ![TabControlAdv for Windows Forms with multiline and reorder support](Overview_images/Overview.png) @@ -24,4 +24,4 @@ The [TabControlAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windo * **ToolTip** - Provides options to show / hide ToolTip when the mouse pointer is placed over the tabs. * **Styling** - Supports for wide variety of built-in themes like 2D, 3D, Metro, Office themes, OneNoteStyle, InternetExplorer7 and much more. * **Serialization** - Provides serialization support to save and load the tab states. -* **Scrolling** - Provides extremely a smooth scrolling behavior even when tabs overflow onto the tab panel. +* **Scrolling** - Provides an extremely smooth scrolling behavior even when tabs overflow onto the tab panel. diff --git a/WindowsForms/TabControl/Tab-Navigation.md b/WindowsForms/TabControl/Tab-Navigation.md index 1c66768d5..88f7e53c7 100644 --- a/WindowsForms/TabControl/Tab-Navigation.md +++ b/WindowsForms/TabControl/Tab-Navigation.md @@ -51,7 +51,7 @@ To create [TabPrimitives](https://help.syncfusion.com/cr/windowsforms/Syncfusion -2. A TabPrimitives Collection Editor will be opened. Click the Add option in the Editor to add a TabPrimitive. +2. The TabPrimitives Collection Editor opens. Click the Add option in the Editor to add a TabPrimitive. ![Need to set tab primitive](TabPrimitives_images/TabPrimitives_img6.jpeg) @@ -71,7 +71,7 @@ To create [TabPrimitives](https://help.syncfusion.com/cr/windowsforms/Syncfusion //Adds a TabPrimitive of type DropDown. -this.tabControlAdv4.TabPrimitivesHost.TabPrimitives.Add(new Syncfusion.Windows.Forms.Tools.TabPrimitive(Syncfusion.Windows.Forms.Tools.TabPrimitiveType.DropDown, null, System.Drawing.Color.Empty, true, 1, "TabPrimitive0")); +this.tabControlAdv1.TabPrimitivesHost.TabPrimitives.Add(new Syncfusion.Windows.Forms.Tools.TabPrimitive(Syncfusion.Windows.Forms.Tools.TabPrimitiveType.DropDown, null, System.Drawing.Color.Empty, true, 1, "TabPrimitive0")); @@ -95,7 +95,7 @@ this.tabControlAdv1.TabPrimitivesHost.Visible = true; 'Adds a TabPrimitive of type DropDown. -Me.tabControlAdv4.TabPrimitivesHost.TabPrimitives.Add(New Syncfusion.Windows.Forms.Tools.TabPrimitive(Syncfusion.Windows.Forms.Tools.TabPrimitiveType.DropDown, Nothing, System.Drawing.Color.Empty, True, 1, "TabPrimitive0")) +Me.tabControlAdv1.TabPrimitivesHost.TabPrimitives.Add(New Syncfusion.Windows.Forms.Tools.TabPrimitive(Syncfusion.Windows.Forms.Tools.TabPrimitiveType.DropDown, Nothing, System.Drawing.Color.Empty, True, 1, "TabPrimitive0")) @@ -111,7 +111,7 @@ Me.tabControlAdv1.TabPrimitivesHost.TabPrimitives.Add(New Syncfusion.Windows.For 'Makes the TabPrimitive visible in the control. -Private Me.tabControlAdv1.TabPrimitivesHost.Visible = True +Me.tabControlAdv1.TabPrimitivesHost.Visible = True {% endhighlight %} From fecf65deae16f147bd8defae598fce24e3cd697c Mon Sep 17 00:00:00 2001 From: harinath-2699 Date: Thu, 9 Jul 2026 16:05:06 +0530 Subject: [PATCH 08/36] 1039182 - Changes committed --- WindowsForms/Docking-Manager/Docking-Events.md | 4 ++-- WindowsForms/Ribbon/Customization-Support.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/WindowsForms/Docking-Manager/Docking-Events.md b/WindowsForms/Docking-Manager/Docking-Events.md index 86452bbcc..d9ba41db7 100644 --- a/WindowsForms/Docking-Manager/Docking-Events.md +++ b/WindowsForms/Docking-Manager/Docking-Events.md @@ -853,9 +853,9 @@ private void dockingManager1_ControlMaximized(object sender, Syncfusion.Windows. Console.WriteLine("Control Name : "+arg.Control.Name); - //Displays the docked control name + //Displays the dock host name - Console.WriteLine("Control Name : "+arg.Control.Name); + Console.WriteLine("DockHost Name : "+arg.DockHost.Name); } diff --git a/WindowsForms/Ribbon/Customization-Support.md b/WindowsForms/Ribbon/Customization-Support.md index 645a594fc..8055ab54c 100644 --- a/WindowsForms/Ribbon/Customization-Support.md +++ b/WindowsForms/Ribbon/Customization-Support.md @@ -13,7 +13,7 @@ RibbonControlAdv lets you customize the Ribbon and Quick Access Toolbar with the ## QAT customization -For customization of QAT, please refer to [Quick Access Toolbar](Quick-Access-Toolbar.md). +For customization of QAT, please refer to `Quick Access Toolbar`. ## Ribbon Customization From 2f08930a97230422865e1f7667eaa43257e54d1a Mon Sep 17 00:00:00 2001 From: ushasundarajan Date: Fri, 10 Jul 2026 10:06:54 +0530 Subject: [PATCH 09/36] Updated UG corrections related to DataGrid --- WindowsForms/DataGrid/ColumnTypes.md | 14 +++++----- WindowsForms/DataGrid/ConditionalStyling.md | 4 +-- WindowsForms/DataGrid/DataBinding.md | 4 +-- WindowsForms/DataGrid/DataManipulation.md | 4 +-- WindowsForms/DataGrid/DataValidation.md | 22 +++++++-------- WindowsForms/DataGrid/DragAndDrop.md | 2 +- WindowsForms/DataGrid/Editing.md | 2 +- WindowsForms/DataGrid/ExportToExcel.md | 2 +- WindowsForms/DataGrid/ExportToPDF.md | 8 +++--- WindowsForms/DataGrid/FilterRow.md | 8 +++--- WindowsForms/DataGrid/Filtering.md | 4 +-- WindowsForms/DataGrid/GettingStarted.md | 2 +- WindowsForms/DataGrid/Grouping.md | 2 +- WindowsForms/DataGrid/InteractiveFeatures.MD | 4 +-- WindowsForms/DataGrid/MasterDetailsView.md | 2 +- WindowsForms/DataGrid/Merging.md | 6 ++--- WindowsForms/DataGrid/Paging.md | 2 +- WindowsForms/DataGrid/Rows.md | 4 +-- WindowsForms/DataGrid/Selection.md | 7 +++-- WindowsForms/DataGrid/Sorting.md | 2 +- WindowsForms/DataGrid/Summaries.md | 28 ++++++++++---------- WindowsForms/DataGrid/UIAutomation.md | 4 +-- 22 files changed, 68 insertions(+), 69 deletions(-) diff --git a/WindowsForms/DataGrid/ColumnTypes.md b/WindowsForms/DataGrid/ColumnTypes.md index 25e6db72a..b3f689f35 100644 --- a/WindowsForms/DataGrid/ColumnTypes.md +++ b/WindowsForms/DataGrid/ColumnTypes.md @@ -235,7 +235,7 @@ Public Sub New() Dim data = New OrderInfoCollection() sfDataGrid.DataSource = data.OrdersListDetails - sfDataGrid.Columns("OrderDate").Format = "dd/mm/yyyy" + sfDataGrid.Columns("OrderDate").Format = "dd/MM/yyyy" sfDataGrid.Columns("OrderDate").FormatProvider = New CustomFormatter() End Sub @@ -1095,12 +1095,12 @@ comboBoxColumn.AutoSuggestDelay = 1000 {% highlight c# %} this.sfDataGrid1.Columns.Add(new GridButtonColumn() { - MappingName = "ProductName ", + MappingName = "ProductName", HeaderText = "Product Name" }); {% endhighlight %} {% highlight vb %} -Me.sfDataGrid1.Columns.Add(New GridButtonColumn() With {.MappingName = "ProductName ", .HeaderText = "Product Name"}) +Me.sfDataGrid1.Columns.Add(New GridButtonColumn() With {.MappingName = "ProductName", .HeaderText = "Product Name"}) {% endhighlight %} {% endtabs %} @@ -1197,7 +1197,7 @@ private void sfDataGrid1_CellButtonClick(object sender, CellButtonClickEventArgs } {% endhighlight %} {% highlight vb %} -AddHandler sfDataGrid1.CellButtonClick, AddressOf SfDataGrid1_ CellButtonClick +AddHandler sfDataGrid1.CellButtonClick, AddressOf SfDataGrid1_CellButtonClick Private Sub sfDataGrid1_CellButtonClick(ByVal sender As Object, ByVal e As CellButtonClickEventArgs) sfDataGrid1.DeleteSelectedRecords() @@ -1213,12 +1213,12 @@ End Sub {% highlight c# %} this.sfDataGrid1.Columns.Add(new GridHyperlinkColumn() { - MappingName = " OrderURI ", + MappingName = "OrderURI", HeaderText = "Order URI" }); {% endhighlight %} {% highlight vb %} -Me.sfDataGrid1.Columns.Add(New GridHyperlinkColumn() With {.MappingName = " OrderURI ", .HeaderText = "Order URI"}) +Me.sfDataGrid1.Columns.Add(New GridHyperlinkColumn() With {.MappingName = "OrderURI", .HeaderText = "Order URI"}) {% endhighlight %} {% endtabs %} @@ -2253,7 +2253,7 @@ Numeric {{'[GridDateTimeCellRenderer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Renderers.GridDateTimeCellRenderer.html#"")'| markdownify }} diff --git a/WindowsForms/DataGrid/ConditionalStyling.md b/WindowsForms/DataGrid/ConditionalStyling.md index 82581c0ed..26943a480 100644 --- a/WindowsForms/DataGrid/ConditionalStyling.md +++ b/WindowsForms/DataGrid/ConditionalStyling.md @@ -132,7 +132,7 @@ The following code shows how to apply conditional styling for the data table. {% tabs %} {% highlight c# %} -this.sfDataGrid.QueryCellStyle += SfDataGrid_QueryCellStyle; +this.sfDataGrid.QueryRowStyle += SfDataGrid_QueryRowStyle; private void SfDataGrid_QueryRowStyle(object sender, QueryRowStyleEventArgs e) { @@ -156,7 +156,7 @@ private void SfDataGrid_QueryRowStyle(object sender, QueryRowStyleEventArgs e) } {% endhighlight %} {% highlight vb %} -AddHandler sfDataGrid1.QueryCellStyle, AddressOf SfDataGrid1_QueryCellStyle +AddHandler sfDataGrid1.QueryRowStyle, AddressOf SfDataGrid_QueryRowStyle Private Sub SfDataGrid_QueryRowStyle(ByVal sender As Object, ByVal e As QueryRowStyleEventArgs) ' Get the "Country" column from the RowData If e.RowType = RowType.DefaultRow Then diff --git a/WindowsForms/DataGrid/DataBinding.md b/WindowsForms/DataGrid/DataBinding.md index 0f05c0824..f22810fd8 100644 --- a/WindowsForms/DataGrid/DataBinding.md +++ b/WindowsForms/DataGrid/DataBinding.md @@ -46,7 +46,7 @@ Below are the limitations when binding DataTable as `DataSource` to SfDataGrid. * Custom sorting is not supported. * [SfDataGrid.View.Filter](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Data.DataTableCollectionViewWrapper.html) is not supported. * Advanced Filtering does not support Case Sensitive filtering. -* [AddNewRow](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_AddNewRowPosition) is not support when filtering is enabled. +* [AddNewRow](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_AddNewRowPosition) is not supported when filtering is enabled. * [GridUnboundColumn.Expression](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridUnboundColumn.html#Syncfusion_WinForms_DataGrid_GridUnboundColumn_Expression) is not supported. This can be achieved by using the [DataColumn](https://learn.microsoft.com/en-us/dotnet/api/system.data.datacolumn?view=net-5.0) of DataTable by setting [DataColumn.Expression](https://learn.microsoft.com/en-us/dotnet/api/system.data.datacolumn.expression?view=net-5.0) property. * [SfDataGrid.LiveDataUpdateMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_LiveDataUpdateMode) is not supported. @@ -333,7 +333,7 @@ To create Data Model using Entity Framework in Windows Forms application, follow 1. Right click the project, select **Add** option and then click **New Item**. -2. The **Add New Item** wizard appears, select “**ADO.NET Entity Data Mode**” from the Data node. +2. The **Add New Item** wizard appears, select “**ADO.NET Entity Data Model**” from the Data node. 3. Name the file as **Model1.edmx** and then select **Add** button. ![Choose the the ADO.Net entity model application from visual studio](DataBinding_images/DataBinding_img3.jpeg) diff --git a/WindowsForms/DataGrid/DataManipulation.md b/WindowsForms/DataGrid/DataManipulation.md index 0825518b7..b6ed3620a 100644 --- a/WindowsForms/DataGrid/DataManipulation.md +++ b/WindowsForms/DataGrid/DataManipulation.md @@ -631,9 +631,9 @@ private void sfDataGrid1_AutoGeneratingRelations(object sender, Syncfusion.WinFo } {% endhighlight %} {% highlight vb %} -AddHandler sfDataGrid1. AutoGeneratingRelations, AddressOf SfDataGrid_AutoGeneratingRelations +AddHandler sfDataGrid1.AutoGeneratingRelations, AddressOf SfDataGrid_AutoGeneratingRelations Private Sub SfDataGrid_AutoGeneratingRelations(ByVal sender As Object, ByVal e As AutoGeneratingRelationsEventArgs) - e.GridViewDefinition.DataGrid.AddNewRowPosition = RowPosition.Top; + e.GridViewDefinition.DataGrid.AddNewRowPosition = RowPosition.Top End Sub {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/DataGrid/DataValidation.md b/WindowsForms/DataGrid/DataValidation.md index ba9586b2d..34c327074 100644 --- a/WindowsForms/DataGrid/DataValidation.md +++ b/WindowsForms/DataGrid/DataValidation.md @@ -11,12 +11,12 @@ documentation: ug [WinForms DataGrid](https://www.syncfusion.com/winforms-ui-controls/datagrid) (SfDataGrid) allows to validate the data and display hints in case of validation is not passed. In case of invalid data, error icon is displayed at the left corner of cell. When mouse hover the error icon, error information will be displayed in tooltip. ## Built-in Validations -Built-in validations through[IDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.idataerrorinfo?view=net-5.0), [INotifyDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.inotifydataerrorinfo?view=net-5.0) and Data annotation attributes, can be enabled by setting [SfDataGrid.GridValidationMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_ValidationMode) or [GridColumn.GridValidationMod](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_ValidationMode)e properties. +Built-in validations through[IDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.idataerrorinfo?view=net-5.0), [INotifyDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.inotifydataerrorinfo?view=net-5.0) and Data annotation attributes, can be enabled by setting [SfDataGrid.GridValidationMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_ValidationMode) or [GridColumn.GridValidationMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_ValidationMode)e properties. `GridColumn.GridValidationMode` takes priority than `SfDataGrid.GridValidationMode`. -* `GridValidation.InEdit` - display error icon & tips and also doesn’t allows the users to commit the invalid data without allowing users to edit other cells. -* `GridValidation.InView` - displays error icons and tips alone. -* `GridValidation.None` - disables built-in validation support. +* `GridValidationMode.InEdit` - display error icon & tips and also doesn’t allows the users to commit the invalid data without allowing users to edit other cells. +* `GridValidationMode.InView` - displays error icons and tips alone. +* `GridValidationMode.None` - disables built-in validation support. ### Using IDataErrorInfo @@ -101,7 +101,7 @@ this.sfDataGrid.ValidationMode = GridValidationMode.InEdit; // Set the validation mode only for the particular column. this.sfDataGrid.Columns["Quantity"].ValidationMode = GridValidationMode.InEdit; -{% endhighlight %}] +{% endhighlight %} {% highlight vb %} ' Set the validation mode for the grid. Me.sfDataGrid.ValidationMode = GridValidationMode.InEdit @@ -198,11 +198,11 @@ public class OrderInfo : INotifyDataErrorInfo public System.Collections.IEnumerable GetErrors(string propertyName) { - if (!propertyName.Equals("ShipCountry ")) + if (!propertyName.Equals("ShipCountry")) return null; - if (this.ShipCity.Contains("Mexico")) - errors.Add("Delivery not available for the city " + ShipCountry); + if (this.ShipCountry.Contains("Mexico")) + errors.Add("Delivery not available for the country " + ShipCountry); return errors; } @@ -237,12 +237,12 @@ Public Class OrderInfo End Property Public Function GetErrors(ByVal propertyName As String) As System.Collections.IEnumerable - If Not propertyName.Equals("ShipCountry ") Then + If Not propertyName.Equals("ShipCountry") Then Return Nothing End If - If Me.ShipCity.Contains("Mexico") Then - errors.Add("Delivery not available for the city " & ShipCountry) + If Me.ShipCountry.Contains("Mexico") Then + errors.Add("Delivery not available for the country " & ShipCountry) End If Return errors diff --git a/WindowsForms/DataGrid/DragAndDrop.md b/WindowsForms/DataGrid/DragAndDrop.md index 463a4742b..b599b3ff7 100644 --- a/WindowsForms/DataGrid/DragAndDrop.md +++ b/WindowsForms/DataGrid/DragAndDrop.md @@ -434,7 +434,7 @@ public class CustomizedRowDragDropController : RowDragDropController ### Row drag and drop between two DataGrids -You can able row drag-and-drop between two SfDataGrid controls and control the behavior when dropping into another grid using the [CrossGridDropAction](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_CrossGridDropAction) property: +You can perform row drag-and-drop between two SfDataGrid controls and control the behavior when dropping into another grid using the [CrossGridDropAction](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_CrossGridDropAction) property: - [CrossGridDropAction.Move](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Enums.CrossGridDropAction.html#fields) : The dragged records are removed from the source grid and inserted into the target grid. - [CrossGridDropAction.Copy](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Enums.CrossGridDropAction.html#fields) : The dragged records are copied to the target grid without removing them from the source grid. diff --git a/WindowsForms/DataGrid/Editing.md b/WindowsForms/DataGrid/Editing.md index 0acc68188..c543ff8bc 100644 --- a/WindowsForms/DataGrid/Editing.md +++ b/WindowsForms/DataGrid/Editing.md @@ -38,7 +38,7 @@ Me.sfDataGrid.Columns(0).AllowEditing = True ![Windows forms datagrid Editing](Editing_images/Editing_Image1.png) ## Entering into Edit Mode -The current cell can be enter into edit mode by pressing <kbd>F2</kbd> key or clicking (touch also supported) the cell. The edit mode of the cell can be changed to the single click or double click by setting the [EditMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_EditMode) property. +The current cell can be enter into edit mode by pressing F2 key or clicking (touch also supported) the cell. The edit mode of the cell can be changed to the single click or double click by setting the [EditMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_EditMode) property. {%tabs%} {% highlight c# %} diff --git a/WindowsForms/DataGrid/ExportToExcel.md b/WindowsForms/DataGrid/ExportToExcel.md index b1e341a03..15685f8e7 100644 --- a/WindowsForms/DataGrid/ExportToExcel.md +++ b/WindowsForms/DataGrid/ExportToExcel.md @@ -516,7 +516,7 @@ System.Diagnostics.Process.Start("Sample.png") {% endhighlight %} {% endtabs %} -## Import form Excel to SfDataGrid +## Import from Excel to SfDataGrid The DataSource of the SfDataGrid can be imported from the excel sheet by using the [IWorkSheet.ExportDataTable](https://help.syncfusion.com/cr/windowsforms/Syncfusion.XlsIO.IWorksheet.html#Syncfusion_XlsIO_IWorksheet_ExportDataTable_Syncfusion_XlsIO_IRange_Syncfusion_XlsIO_ExcelExportDataTableOptions_) method. This method will convert the excel data into the DataTable. {% tabs %} {% highlight c# %} diff --git a/WindowsForms/DataGrid/ExportToPDF.md b/WindowsForms/DataGrid/ExportToPDF.md index 866c78f8f..6f57c79f1 100644 --- a/WindowsForms/DataGrid/ExportToPDF.md +++ b/WindowsForms/DataGrid/ExportToPDF.md @@ -192,13 +192,13 @@ By default, table summaries in SfDataGrid will be exported to PDF. If you want t {% tabs %} {% highlight c# %} PdfExportingOptions options = new PdfExportingOptions(); -Options.ExportTableSummary = false; +options.ExportTableSummary = false; var document = sfDataGrid.ExportToPdf(options); document.Save("Sample.pdf"); {% endhighlight %} {% highlight vb %} Dim options As New PdfExportingOptions() -Options.ExportTableSummary = False +options.ExportTableSummary = False Dim document = sfDataGrid.ExportToPdf(options) document.Save("Sample.pdf") {% endhighlight %} @@ -552,7 +552,7 @@ document.Save("Sample.pdf"); void OnCellExporting(object sender, DataGridCellPdfExportingEventArgs e) { - // Based on the column mapping name and the cell type, we can change the cell values while exporting to excel. + // Based on the column mapping name and the cell type, we can change the cell values while exporting to PDF. if (e.CellType == ExportCellType.RecordCell && e.ColumnName == "OrderID") { //if the cell value is Odd, "Odd" will be displayed else "Even" will be displayed. @@ -570,7 +570,7 @@ Dim document = sfDataGrid1.ExportToPdf(options) document.Save("Sample.pdf") Private Sub OnCellExporting(ByVal sender As Object, ByVal e As DataGridCellPdfExportingEventArgs) - ' Based on the column mapping name and the cell type, we can change the cell values while exporting to excel. + ' Based on the column mapping name and the cell type, we can change the cell values while exporting to PDF. If e.CellType = ExportCellType.RecordCell AndAlso e.ColumnName = "OrderID" Then 'if the cell value is Odd, "Odd" will be displayed else "Even" will be displayed. If Convert.ToInt16(e.CellValue) Mod 2 = 0 Then diff --git a/WindowsForms/DataGrid/FilterRow.md b/WindowsForms/DataGrid/FilterRow.md index a6079a78d..ce2a51b63 100644 --- a/WindowsForms/DataGrid/FilterRow.md +++ b/WindowsForms/DataGrid/FilterRow.md @@ -129,7 +129,7 @@ Filters the Boolean values. DateTime
-DataTime +DateTime
-SfDataTimeEdit +SfDateTimeEdit FilterRowDateTimeCellRenderer @@ -280,7 +280,7 @@ Always Equals or Not Equal filter condition will be applied based on the selecte ![WindowsForms DataGrid showing filterrow with textbox editor options](filterrow_images/windowsforms-datagrid-filterrow-with-textbox-editor-options.png) ## Filtering null Values -The null values of the columns can be filtered by using the filter row options such as Null and Not Null. This options is enabled by default for all the filter row editors. To disable the null filter options from the filter options list, use the [AllowBlankFilters](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_AllowBlankFilters) property of the GridColumn. The default value of this property is `true`. +The null values of the columns can be filtered by using the filter row options such as Null and Not Null. These options are enabled by default for all the filter row editors. To disable the null filter options from the filter options list, use the [AllowBlankFilters](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_AllowBlankFilters) property of the GridColumn. The default value of this property is `true`. {% tabs %} {% highlight c# %} @@ -600,7 +600,7 @@ public class FilterRowMultiSelectComboBoxCellRendererExt : FilterRowMultiSelectC /// /// FilterPredicates for a column /// FilterValue for a column - /// Returns trow whether the column having the filter value other wise return false. + /// Returns true whether the column having the filter value; otherwise, returns false. private bool NeedToAdd(ObservableCollection filterPredicate, string filterValue) { bool needToAdd = false; @@ -778,7 +778,7 @@ Public Class FilterRowMultiSelectComboBoxCellRendererExt ''' ''' FilterPredicates for a column ''' FilterValue for a column - ''' Returns trow whether the column having the filter value other wise return false. + ''' Returns true whether the column having the filter value; otherwise, returns false. Private Function NeedToAdd(ByVal filterPredicate As ObservableCollection(Of FilterPredicate), ByVal filterValue As String) As Boolean 'INSTANT VB NOTE: The local variable needToAdd was renamed since Visual Basic will not allow local variables with the same name as their enclosing function or property: Dim needToAdd_Renamed As Boolean = False diff --git a/WindowsForms/DataGrid/Filtering.md b/WindowsForms/DataGrid/Filtering.md index b9b6d37f2..2e040911c 100644 --- a/WindowsForms/DataGrid/Filtering.md +++ b/WindowsForms/DataGrid/Filtering.md @@ -260,7 +260,7 @@ sfDataGrid1.Columns("OrderID").FilterPopupMode = FilterPopupMode.Both {% endtabs %} ### Changing Filter UI using Event -The column `FilterPopupMode` can also be changed by using the [FilterPopupShowing](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html) event. This even will be raised on opening the filter popup. +The column `FilterPopupMode` can also be changed by using the [FilterPopupShowing](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html) event. This event will be raised on opening the filter popup. {% tabs %} {% highlight c# %} @@ -362,7 +362,7 @@ After filtering, both records having the same OrderDate display value will be di ![Filtering Based on Display Text](Filtering_images/Filtering_img10.png) ## Advanced Filtering -Advanced filter UI provides multiple filter options to filter the data easily. Filter menu options are loaded based on advanced filter type by automatically detecting the underlying date type. +Advanced filter UI provides multiple filter options to filter the data easily. Filter menu options are loaded based on advanced filter type by automatically detecting the underlying data type. Below are the built-in filter types supported. * **Text Filters** – Loads various menu options to filter the display text effectively. diff --git a/WindowsForms/DataGrid/GettingStarted.md b/WindowsForms/DataGrid/GettingStarted.md index c4283b873..2aba9cdbb 100644 --- a/WindowsForms/DataGrid/GettingStarted.md +++ b/WindowsForms/DataGrid/GettingStarted.md @@ -380,7 +380,7 @@ Represents SfDataGrid column that hosts SfNumericTextBox controls in its cells
-GridDataTimeColumn +GridDateTimeColumn Represents SfDataGrid column that hosts SfDateTimeEdit controls in its cells which is used to display and format DateTime values. diff --git a/WindowsForms/DataGrid/Grouping.md b/WindowsForms/DataGrid/Grouping.md index de15bddd7..0713050a0 100644 --- a/WindowsForms/DataGrid/Grouping.md +++ b/WindowsForms/DataGrid/Grouping.md @@ -22,7 +22,7 @@ Me.sfDataGrid1.AllowGrouping = True {% endhighlight %} {% endtabs %} -Grouping for particular column can be enables or disabled by setting the [GridColumnBase.AllowGrouping](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_AllowGrouping) property. +Grouping for particular column can be enabled or disabled by setting the [GridColumnBase.AllowGrouping](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_AllowGrouping) property. {% tabs %} {% highlight c# %} this.sfDataGrid1.Columns["OrderID"].AllowGrouping = true; diff --git a/WindowsForms/DataGrid/InteractiveFeatures.MD b/WindowsForms/DataGrid/InteractiveFeatures.MD index 22a5f3d95..61bc65b64 100644 --- a/WindowsForms/DataGrid/InteractiveFeatures.MD +++ b/WindowsForms/DataGrid/InteractiveFeatures.MD @@ -535,7 +535,7 @@ public class ColumnChooserExt : ColumnChooser /// protected override void AddOKButton() { - // Do nothing to avod adding the OK button. + // Do nothing to avoid adding the OK button. } /// @@ -591,7 +591,7 @@ Public Class ColumnChooserExt ''' Overridden to cancel the adding of OK button. ''' Protected Overrides Sub AddOKButton() - ' Do nothing to avod adding the OK button. + ' Do nothing to avoid adding the OK button. End Sub ''' diff --git a/WindowsForms/DataGrid/MasterDetailsView.md b/WindowsForms/DataGrid/MasterDetailsView.md index bfb271695..6dc6e4fe6 100644 --- a/WindowsForms/DataGrid/MasterDetailsView.md +++ b/WindowsForms/DataGrid/MasterDetailsView.md @@ -1463,7 +1463,7 @@ End Function {% endhighlight %} {% endtabs %} -N> This event will be trigged only when the underlying data object contains relations otherwise, you must define a dummy relation to notify the DataGrid to fire this event. +N> This event will be triggered only when the underlying data object contains relations otherwise, you must define a dummy relation to notify the DataGrid to fire this event. ## Defining properties for DetailsViewDataGrid diff --git a/WindowsForms/DataGrid/Merging.md b/WindowsForms/DataGrid/Merging.md index 0e71cfb0f..69c9ec794 100644 --- a/WindowsForms/DataGrid/Merging.md +++ b/WindowsForms/DataGrid/Merging.md @@ -147,7 +147,7 @@ In the following code, the `GetRange` method returns the range of a cell based o {% tabs %} {% highlight c# %} /// -/// Holds the PropertyAccessProvider to git the cell value. +/// Holds the PropertyAccessProvider to get the cell value. /// IPropertyAccessProvider propertyAccessProvider = null; @@ -285,7 +285,7 @@ private CoveredCellInfo GetRange(GridColumn column, int rowIndex, int columnInde {% endhighlight %} {% highlight vb %} ''' -''' Holds the PropertyAccessProvider to git the cell value. +''' Holds the PropertyAccessProvider to get the cell value. ''' Private propertyAccessProvider As IPropertyAccessProvider = Nothing @@ -447,7 +447,7 @@ void FirstLevelNestedGrid_QueryCoveredRange(object sender, Syncfusion.WinForms.D {% endhighlight %} {% highlight vb %} Private FirstLevelNestedGrid As SfDataGrid = Me.sfDataGrid1.DetailsViewDefinitions(0).DataGrid -AddHandler FirstLevelNestedGrid.QueryCoveredRange, AddressOf sfDataGrid1_QueryCoveredRange +AddHandler FirstLevelNestedGrid.QueryCoveredRange, AddressOf FirstLevelNestedGrid_QueryCoveredRange Private Sub FirstLevelNestedGrid_QueryCoveredRange(ByVal sender As Object, ByVal e As Syncfusion.WinForms.DataGrid.Events.QueryCoveredRangeEventArgs) If e.ColumnIndex = 1 Then diff --git a/WindowsForms/DataGrid/Paging.md b/WindowsForms/DataGrid/Paging.md index 2aa116cf8..3aa1543df 100644 --- a/WindowsForms/DataGrid/Paging.md +++ b/WindowsForms/DataGrid/Paging.md @@ -797,7 +797,7 @@ The appearance of the button style can be customized using the [NavigationButton {% tabs %} {% highlight c# %} -this.sfDataPager1.Style.NavigationButtonStyle.BackColor = Color. SeaGreen; +this.sfDataPager1.Style.NavigationButtonStyle.BackColor = Color.SeaGreen; {% endhighlight %} {% highlight vb %} Me.sfDataPager1.Style.NavigationButtonStyle.BackColor = Color.SeaGreen diff --git a/WindowsForms/DataGrid/Rows.md b/WindowsForms/DataGrid/Rows.md index b228d74dd..e331c3a5d 100644 --- a/WindowsForms/DataGrid/Rows.md +++ b/WindowsForms/DataGrid/Rows.md @@ -517,12 +517,12 @@ private void SfDataGrid_DrawFreezePaneLine(object sender, DrawFreezePaneLineArgs { if (e.LineType == LineType.FrozenRow) { - e.Graphics.DrawLine(new Pen(Color. DeepSkyBlue, 2), e.Point1, e.Point2); + e.Graphics.DrawLine(new Pen(Color.DeepSkyBlue, 2), e.Point1, e.Point2); e.Handled = true; } if (e.LineType == LineType.FooterRow) { - e.Graphics.DrawLine(new Pen(Color. BlueViolet, 2), e.Point1, e.Point2); + e.Graphics.DrawLine(new Pen(Color.BlueViolet, 2), e.Point1, e.Point2); e.Handled = true; } if (e.LineType == LineType.FrozenColumn) diff --git a/WindowsForms/DataGrid/Selection.md b/WindowsForms/DataGrid/Selection.md index 416551bdf..e097f1b87 100644 --- a/WindowsForms/DataGrid/Selection.md +++ b/WindowsForms/DataGrid/Selection.md @@ -9,7 +9,7 @@ documentation: ug # Selection in Windows Forms DataGrid (SfDataGrid) -[Windows Forms DataGrid](https://www.syncfusion.com/winforms-ui-controls/datagrid) (SfDataGrid) allows you to select one or more rows or cells. For selecting a specific row or group of rows, set the [SelectionUnit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_SelectionUnit) as row. For selecting a specific cell or group of cells, set the SelectionUnit as cell or Any.In SelectionUnit.Any option. A row can be selected by clicking its row header. +[Windows Forms DataGrid](https://www.syncfusion.com/winforms-ui-controls/datagrid) (SfDataGrid) allows you to select one or more rows or cells. For selecting a specific row or group of rows, set the [SelectionUnit](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_SelectionUnit) as row. For selecting a specific cell or group of cells, set the SelectionUnit as cell or Any. In SelectionUnit.Any option, a row can be selected by clicking its row header. ## Current cell navigation @@ -415,7 +415,6 @@ Else End If MessageBox.Show(cellValue, "Value in cell (" & rowIndex & ", " & columnIndex & ")") -& ")") {% endhighlight %} {% endtabs %} @@ -783,7 +782,7 @@ private void SelectAll(Object sender, EventArgs e) {% endhighlight %} {% endtabs %} -By default, select all the rows (CaptionSummary, GroupSummary, UnboundRows, FilterRow, AddNewRow and DefaultRow) when press the Ctrl+A key in SfDataGrid. The following code shows how to select all the default row except other rows by overriding the [HandleKeyOperations](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Interactivity.RowSelectionController.html#Syncfusion_WinForms_DataGrid_Interactivity_RowSelectionController_HandleKeyOperations_System_Windows_Forms_KeyEventArgs_) method in [RowSelectionController](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Interactivity.RowSelectionController.html). +By default, select all the rows (CaptionSummary, GroupSummary, UnboundRows, FilterRow, AddNewRow and DefaultRow) when press the Ctrl+A key in SfDataGrid. The following code shows how to select all the default rows except other rows by overriding the [HandleKeyOperations](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Interactivity.RowSelectionController.html#Syncfusion_WinForms_DataGrid_Interactivity_RowSelectionController_HandleKeyOperations_System_Windows_Forms_KeyEventArgs_) method in [RowSelectionController](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Interactivity.RowSelectionController.html). {% tabs %} {% highlight c# %} //Using the Custom SelectionController. @@ -871,7 +870,7 @@ public class CustomSelectionController : RowSelectionController {% endtabs %} ### Tab key navigation -The current cell navigation can be disabled in `Tab` key using the [AllowStandardTab](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_AllowStandardTab) property. If `AllowStandardTab` is enabled, then the focus will be moved to next control in tab order;if else, the current cell will be moved to next cell in order in DataGrid. +The current cell navigation can be disabled in `Tab` key using the [AllowStandardTab](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_AllowStandardTab) property. If `AllowStandardTab` is enabled, then the focus will be moved to next control in tab order; otherwise, the current cell will be moved to next cell in order in DataGrid. {% tabs %} {% highlight c# %} diff --git a/WindowsForms/DataGrid/Sorting.md b/WindowsForms/DataGrid/Sorting.md index 88bc06919..1b700c875 100644 --- a/WindowsForms/DataGrid/Sorting.md +++ b/WindowsForms/DataGrid/Sorting.md @@ -9,7 +9,7 @@ documentation: ug # Sorting in Windows Forms DataGrid (SfDataGrid) [Windows Forms DataGrid](https://www.syncfusion.com/winforms-ui-controls/datagrid) (SfDataGrid) allows to sort the data against one or more columns either in ascending or descending order. When sorting is applied, the rows are rearranged based on sort criteria. -The data can be sorted by clicking on the column headers that needs to be sorted or it can be performed programmatically. Once sorting is applied, the grid will display a sort icon in the respected column headers showing the sort direction. +The data can be sorted by clicking on the column headers that needs to be sorted or it can be performed programmatically. Once sorting is applied, the grid will display a sort icon in the respective column headers showing the sort direction. The sorting can be performed by touching or clicking the column header. This can be enabled by setting [SfDataGrid.AllowSorting](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_AllowSorting) property to `true`. {% tabs %} diff --git a/WindowsForms/DataGrid/Summaries.md b/WindowsForms/DataGrid/Summaries.md index 1186ed239..fcaa3ac80 100644 --- a/WindowsForms/DataGrid/Summaries.md +++ b/WindowsForms/DataGrid/Summaries.md @@ -363,7 +363,7 @@ Me.sfDataGrid1.Style.TableSummaryRowStyle.Font = New GridFontInfo(New Font("Aria ![Table summary row appearance customization in windows form datagrid](SfDataGrid_Summaries_UG_images/summaries5.png) ### Overriding Table Summary Renderer -[GridTableSummaryCellRender](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Renderers.GridTableSummaryCellRenderer.html) is the cell renderer which renders the table summary row. The table summary row appearance and the summary value can be customized with the `GridTableSummaryCellRender`. +[GridTableSummaryCellRenderer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Renderers.GridTableSummaryCellRenderer.html) is the cell renderer which renders the table summary row. The table summary row appearance and the summary value can be customized with the `GridTableSummaryCellRenderer`. #### Creating Custom Renderer The number format for numeric values displayed on [GridTableSummaryRow](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridTableSummaryRow.html) can be applied by overriding the `OnRender` method in `GridTableSummaryCellRenderer` class. @@ -495,14 +495,14 @@ Summary information can be displayed in row by setting [GridSummaryRow.ShowSumma GridSummaryRow groupSummaryRow1 = new GridSummaryRow(); groupSummaryRow1.Name = "GroupSummary"; groupSummaryRow1.ShowSummaryInRow = true; -groupSummaryRow1.Title = "Total Price $: { UnitPrice }"; +groupSummaryRow1.Title = "Total Price $: {UnitPrice}"; // Creates the GridSummaryColumn. GridSummaryColumn summaryColumn1 = new GridSummaryColumn(); summaryColumn1.Name = "UnitPrice"; summaryColumn1.SummaryType = SummaryType.DoubleAggregate; summaryColumn1.Format = "{Sum:c}"; -summaryColumn1.MappingName = " UnitPrice "; +summaryColumn1.MappingName = "UnitPrice"; // Adds the GridSummaryColumn in SummaryColumns collection. groupSummaryRow1.SummaryColumns.Add(summaryColumn1); @@ -515,14 +515,14 @@ this.sfDataGrid1.GroupSummaryRows.Add(groupSummaryRow1); Dim groupSummaryRow1 As New GridSummaryRow() groupSummaryRow1.Name = "GroupSummary" groupSummaryRow1.ShowSummaryInRow = True -groupSummaryRow1.Title = "Total Price $: { UnitPrice }" +groupSummaryRow1.Title = "Total Price $: {UnitPrice}" ' Creates the GridSummaryColumn. Dim summaryColumn1 As New GridSummaryColumn() summaryColumn1.Name = "UnitPrice" summaryColumn1.SummaryType = SummaryType.DoubleAggregate summaryColumn1.Format = "{Sum:c}" -summaryColumn1.MappingName = " UnitPrice " +summaryColumn1.MappingName = "UnitPrice" ' Adds the GridSummaryColumn in SummaryColumns collection. groupSummaryRow1.SummaryColumns.Add(summaryColumn1) @@ -567,7 +567,7 @@ summaryColumn2.Format = "{Count:d}"; summaryColumn2.MappingName = "Quantity"; summaryColumn2.SummaryType = SummaryType.CountAggregate; -// Creates the GridSummaryColumn2. +// Creates the GridSummaryColumn3. GridSummaryColumn summaryColumn3 = new GridSummaryColumn(); summaryColumn3.Name = "PriceAmount"; summaryColumn3.Format = "{Sum:c}"; @@ -604,7 +604,7 @@ summaryColumn2.Format = "{Count:d}" summaryColumn2.MappingName = "Quantity" summaryColumn2.SummaryType = SummaryType.CountAggregate -' Creates the GridSummaryColumn2. +' Creates the GridSummaryColumn3. Dim summaryColumn3 As New GridSummaryColumn() summaryColumn3.Name = "PriceAmount" summaryColumn3.Format = "{Sum:c}" @@ -649,7 +649,7 @@ Me.sfDataGrid1.Style.GroupSummaryRowStyle.Font = New GridFontInfo(New Font("Aria ![Group summary row Appearance customization in windows forms datagrid](SfDataGrid_Summaries_UG_images/summaries9.png) ### Overriding Group Summary Renderer -[GridGroupSummaryCellRenderer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Renderers.GridGroupSummaryCellRenderer.html) is the cell renderer which renders the group summary row. The group summary row appearance and the summary value can be customized with the `GridGroupSummaryCellRender`. +[GridGroupSummaryCellRenderer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.Renderers.GridGroupSummaryCellRenderer.html) is the cell renderer which renders the group summary row. The group summary row appearance and the summary value can be customized with the `GridGroupSummaryCellRenderer`. #### Creating Custom Renderer The number format for numeric values displayed on group summary row can be applied by overriding the `OnRender` method in `GridGroupSummaryCellRenderer` class. @@ -1074,7 +1074,7 @@ GridSummaryColumn summaryColumn1 = new GridSummaryColumn(); summaryColumn1.Name = "UnitPrice"; summaryColumn1.SummaryType = SummaryType.DoubleAggregate; summaryColumn1.Format = "{Sum}"; -summaryColumn1.MappingName = " UnitPrice "; +summaryColumn1.MappingName = "UnitPrice"; // Adds the GridSummaryColumn in the SummaryColumns collection. tableSummaryRow1.SummaryColumns.Add(summaryColumn1); @@ -1094,7 +1094,7 @@ Dim summaryColumn1 As New GridSummaryColumn() summaryColumn1.Name = "UnitPrice" summaryColumn1.SummaryType = SummaryType.DoubleAggregate summaryColumn1.Format = "{Sum}" -summaryColumn1.MappingName = " UnitPrice " +summaryColumn1.MappingName = "UnitPrice" ' Adds the GridSummaryColumn in the SummaryColumns collection. tableSummaryRow1.SummaryColumns.Add(summaryColumn1) @@ -1117,7 +1117,7 @@ GridSummaryColumn summaryColumn1 = new GridSummaryColumn(); summaryColumn1.Name = "UnitPrice"; summaryColumn1.SummaryType = SummaryType.DoubleAggregate; summaryColumn1.Format = "{Sum:c}"; -summaryColumn1.MappingName = " UnitPrice "; +summaryColumn1.MappingName = "UnitPrice"; // Adds the GridSummaryColumn in the SummaryColumns collection. tableSummaryRow1.SummaryColumns.Add(summaryColumn1); @@ -1131,7 +1131,7 @@ Dim summaryColumn1 As New GridSummaryColumn() summaryColumn1.Name = "UnitPrice" summaryColumn1.SummaryType = SummaryType.DoubleAggregate summaryColumn1.Format = "{Sum:c}" -summaryColumn1.MappingName = " UnitPrice " +summaryColumn1.MappingName = "UnitPrice" ' Adds the GridSummaryColumn in the SummaryColumns collection. tableSummaryRow1.SummaryColumns.Add(summaryColumn1) @@ -1194,7 +1194,7 @@ GridSummaryColumn summaryColumn1 = new GridSummaryColumn(); summaryColumn1.Name = "TotalPrice"; summaryColumn1.SummaryType = SummaryType.DoubleAggregate; summaryColumn1.Format = "{Sum:c}"; -summaryColumn1.MappingName = " UnitPrice "; +summaryColumn1.MappingName = "UnitPrice"; // Adds the GridSummaryColumn in the SummaryColumns collection. tableSummaryRow1.SummaryColumns.Add(summaryColumn1); @@ -1215,7 +1215,7 @@ Dim summaryColumn1 As New GridSummaryColumn() summaryColumn1.Name = "TotalPrice" summaryColumn1.SummaryType = SummaryType.DoubleAggregate summaryColumn1.Format = "{Sum:c}" -summaryColumn1.MappingName = " UnitPrice " +summaryColumn1.MappingName = "UnitPrice" ' Adds the GridSummaryColumn in the SummaryColumns collection. tableSummaryRow1.SummaryColumns.Add(summaryColumn1) diff --git a/WindowsForms/DataGrid/UIAutomation.md b/WindowsForms/DataGrid/UIAutomation.md index 952c882fc..a853ac0fa 100644 --- a/WindowsForms/DataGrid/UIAutomation.md +++ b/WindowsForms/DataGrid/UIAutomation.md @@ -60,11 +60,11 @@ The Coded UI support for SfDataGrid can be enabled using the `AccessibilityEnabl {% tabs %} {% highlight c# %} //To enable the accessibility. - this. sfDataGrid1.AccessibilityEnabled = true; +this.sfDataGrid1.AccessibilityEnabled = true; {% endhighlight %} {% highlight vb %} 'To enable the accessibility. -Me. sfDataGrid1.AccessibilityEnabled = true +Me.sfDataGrid1.AccessibilityEnabled = True {% endhighlight %} {% endtabs %} From 461e0701e8465a8b24cec2e8b16463cf392b6b72 Mon Sep 17 00:00:00 2001 From: ushasundarajan Date: Fri, 10 Jul 2026 10:25:45 +0530 Subject: [PATCH 10/36] redundant changes removed --- WindowsForms/DataGrid/DataValidation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WindowsForms/DataGrid/DataValidation.md b/WindowsForms/DataGrid/DataValidation.md index 34c327074..6a9b843f1 100644 --- a/WindowsForms/DataGrid/DataValidation.md +++ b/WindowsForms/DataGrid/DataValidation.md @@ -11,7 +11,7 @@ documentation: ug [WinForms DataGrid](https://www.syncfusion.com/winforms-ui-controls/datagrid) (SfDataGrid) allows to validate the data and display hints in case of validation is not passed. In case of invalid data, error icon is displayed at the left corner of cell. When mouse hover the error icon, error information will be displayed in tooltip. ## Built-in Validations -Built-in validations through[IDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.idataerrorinfo?view=net-5.0), [INotifyDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.inotifydataerrorinfo?view=net-5.0) and Data annotation attributes, can be enabled by setting [SfDataGrid.GridValidationMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_ValidationMode) or [GridColumn.GridValidationMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_ValidationMode)e properties. +Built-in validations through[IDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.idataerrorinfo?view=net-5.0), [INotifyDataErrorInfo](https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.inotifydataerrorinfo?view=net-5.0) and Data annotation attributes, can be enabled by setting [SfDataGrid.GridValidationMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.SfDataGrid.html#Syncfusion_WinForms_DataGrid_SfDataGrid_ValidationMode) or [GridColumn.GridValidationMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.DataGrid.GridColumnBase.html#Syncfusion_WinForms_DataGrid_GridColumnBase_ValidationMode) properties. `GridColumn.GridValidationMode` takes priority than `SfDataGrid.GridValidationMode`. * `GridValidationMode.InEdit` - display error icon & tips and also doesn’t allows the users to commit the invalid data without allowing users to edit other cells. From b203bfede228b934ab2605eb28c8d18dd1d34e1a Mon Sep 17 00:00:00 2001 From: ushasundarajan Date: Fri, 10 Jul 2026 11:30:31 +0530 Subject: [PATCH 11/36] resolved cI issue --- WindowsForms/DataGrid/ExportToPDF.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WindowsForms/DataGrid/ExportToPDF.md b/WindowsForms/DataGrid/ExportToPDF.md index 6f57c79f1..4715a9b99 100644 --- a/WindowsForms/DataGrid/ExportToPDF.md +++ b/WindowsForms/DataGrid/ExportToPDF.md @@ -349,7 +349,7 @@ document.Save("Sample.pdf") {% endhighlight %} {% endtabs %} -Refer the [PDF documentation](https://help.syncfusion.com/#saving-a-pdf-document-to-file-system) for more information. +Refer the [PDF documentation](https://help.syncfusion.com/document-processing/pdf/pdf-library/net/working-with-document) for more information. ### Save as Stream After exporting to PDF, the exported PDF file can be saved to a stream by using [Save](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Pdf.PdfDocumentBase.html#Syncfusion_Pdf_PdfDocumentBase_Save_System_IO_Stream_) method. From eaece52e417da9a4db1f6cef3650c1777c9004d8 Mon Sep 17 00:00:00 2001 From: ushasundarajan Date: Fri, 10 Jul 2026 13:15:06 +0530 Subject: [PATCH 12/36] Updated UG corrections for Grid Control --- .../Grid-Control/Appearance-and-Formatting.md | 14 +++++----- WindowsForms/Grid-Control/Cell-Merging.md | 4 +-- WindowsForms/Grid-Control/Cell-Navigation.md | 2 +- WindowsForms/Grid-Control/Cell-Types.md | 26 +++++++++---------- WindowsForms/Grid-Control/CommentTip.md | 4 +-- WindowsForms/Grid-Control/Copy-and-Paste.md | 10 +++---- WindowsForms/Grid-Control/Covered-Ranges.md | 6 ++--- WindowsForms/Grid-Control/Data-Validation.md | 6 ++--- WindowsForms/Grid-Control/Drag-and-Drop.md | 4 +-- WindowsForms/Grid-Control/Exporting.md | 22 +++++++++------- WindowsForms/Grid-Control/Find-and-Replace.md | 4 +-- WindowsForms/Grid-Control/Getting-Started.md | 4 +-- ...nal-Control-using-GridGrouping-Controls.md | 2 +- WindowsForms/Grid-Control/Importing.md | 4 +-- .../Managing-the-Rows-and-Columns.md | 6 ++--- WindowsForms/Grid-Control/Performance.md | 8 +++--- WindowsForms/Grid-Control/Scrolling.md | 12 +++++---- WindowsForms/Grid-Control/Selection.md | 12 ++++----- WindowsForms/Grid-Control/Virtual-Grid.md | 10 +++---- 19 files changed, 82 insertions(+), 78 deletions(-) diff --git a/WindowsForms/Grid-Control/Appearance-and-Formatting.md b/WindowsForms/Grid-Control/Appearance-and-Formatting.md index f032d2a92..69ae0de71 100644 --- a/WindowsForms/Grid-Control/Appearance-and-Formatting.md +++ b/WindowsForms/Grid-Control/Appearance-and-Formatting.md @@ -54,12 +54,12 @@ Me.gridControl.DisplayVerticalLines = False ![Appearance-and-Formatting_img3](Appearance-and-Formatting_images/Appearance-and-Formatting_img3.jpeg) #### Hiding horizontalLines -To display the grid without the horizontal lines, set the [DisplayHorizontalLines](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_DisplayVerticalLines) property to `false`. +To display the grid without the horizontal lines, set the [DisplayHorizontalLines](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_DisplayHorizontalLines) property to `false`. {% tabs %} {% highlight c# %} //Remove the Horizontal Lines -this.gridControl. DisplayHorizontalLines = false; +this.gridControl.DisplayHorizontalLines = false; {% endhighlight %} {% highlight vb %} 'Remove the Horizontal Lines @@ -149,7 +149,7 @@ void gridControl_BackgroundImageChanged(object sender, EventArgs e) } {% endhighlight %} {% highlight vb %} -Private Me.gridControl.BackgroundImageChanged += AddressOf gridControl_BackgroundImageChanged +AddHandler Me.gridControl.BackgroundImageChanged, AddressOf gridControl_BackgroundImageChanged Private Sub gridControl_BackgroundImageChanged(ByVal sender As Object, ByVal e As EventArgs) 'Add the required code over here. @@ -296,11 +296,11 @@ The row header of the current cell can be highlighted by using [MarkRowHeader](h {% tabs %} {% highlight c# %} -//To highlight the Column header for the current cell. +//To highlight the Row header for the current cell. this.gridControl.Properties.MarkRowHeader = true; {% endhighlight %} {% highlight vb %} -'To highlight the Column header for the current cell. +'To highlight the Row header for the current cell. Me.gridControl.Properties.MarkRowHeader = True {% endhighlight %} {% endtabs %} @@ -339,7 +339,7 @@ Me.gridControl1.Properties.Printing = True The list of print properties available in GridControl can be viewed in the separate topic named Printing. Refer that topic for more detailed explanation on Printing functionality. ### Scroll bar properties -GridControl provides support to control functionalities and appearance of grid scroll bars. To enable or disable the scrolling make use of the [HScrollBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControlBase.html#Syncfusion_Windows_Forms_Grid_GridControlBase_HScrollBehavior) and [VScrollBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.Grouping.GridGroupDropArea.html#Syncfusion_Windows_Forms_Grid_Grouping_GridGroupDropArea_VScrollBehavior) properties. It specifies the behavior of the horizontal and vertical scroll bar respectively.[GridScrollbarMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridScrollbarMode.html) enumeration provides list of options to control the scroll bar behavior. +GridControl provides support to control functionalities and appearance of grid scroll bars. To enable or disable the scrolling make use of the [HScrollBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControlBase.html#Syncfusion_Windows_Forms_Grid_GridControlBase_HScrollBehavior) and [VScrollBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControlBase.html#Syncfusion_Windows_Forms_Grid_GridControlBase_VScrollBehavior) properties. It specifies the behavior of the horizontal and vertical scroll bar respectively.[GridScrollbarMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridScrollbarMode.html) enumeration provides list of options to control the scroll bar behavior. {% tabs %} {% highlight c# %} @@ -431,7 +431,7 @@ Custom Drawing denotes adding text and drawings such as lines, polygon etc., to {% highlight c# %} //DrawCell event is used to apply styles to the grid. -this.gridControl1.CellDrawn += new GridDrawCellEventHandler(gridControl1_CellDrawn); +this.gridControl1.DrawCell += new GridDrawCellEventHandler(gridControl1_DrawCell); private void gridControl1_DrawCell(object sender, GridDrawCellEventArgs e) { diff --git a/WindowsForms/Grid-Control/Cell-Merging.md b/WindowsForms/Grid-Control/Cell-Merging.md index 64767a480..2b170de6b 100644 --- a/WindowsForms/Grid-Control/Cell-Merging.md +++ b/WindowsForms/Grid-Control/Cell-Merging.md @@ -7,7 +7,7 @@ control: GridControl documentation: ug --- # Cell Merging in Windows Forms Grid Control -The cell merging is also one of the technique to merge the range of cells in the GridControl. The range of cells will be merged based on the data. The cells which has same data will be merged in row wise in same column or column wise in same row. To enable the merging support in grid, the [MergeCell](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridMergeCellsLayout.html), [MergeCellsMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridModelOptions.html#Syncfusion_Windows_Forms_Grid_GridModelOptions_MergeCellsMode) and [MergeCellsLayout](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridMergeCellsLayout.html) properties can be used. +The cell merging is also one of the technique to merge the range of cells in the GridControl. The range of cells will be merged based on the data. The cells which has same data will be merged in row wise in same column or column wise in same row. To enable the merging support in grid, the [MergeCell](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridStyleInfo.html#Syncfusion_Windows_Forms_Grid_GridStyleInfo_MergeCell), [MergeCellsMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridModelOptions.html#Syncfusion_Windows_Forms_Grid_GridModelOptions_MergeCellsMode) and [MergeCellsLayout](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridMergeCellsLayout.html) properties can be used. The following code snippet is used to enable the merging in GridControl, @@ -172,7 +172,7 @@ void gridControl1_QueryCanMergeCells(object sender, GridQueryCanMergeCellsEventA {% highlight vb %} 'Triggering the QueryCanMergeCells event. -Private Me.gridControl1.QueryCanMergeCells += New GridQueryCanMergeCellsEventHandler(AddressOf gridControl1_QueryCanMergeCells) +AddHandler Me.gridControl1.QueryCanMergeCells, New GridQueryCanMergeCellsEventHandler(AddressOf gridControl1_QueryCanMergeCells) Private Sub gridControl1_QueryCanMergeCells(ByVal sender As Object, ByVal e As GridQueryCanMergeCellsEventArgs) diff --git a/WindowsForms/Grid-Control/Cell-Navigation.md b/WindowsForms/Grid-Control/Cell-Navigation.md index 5422a8b80..c5300d24e 100644 --- a/WindowsForms/Grid-Control/Cell-Navigation.md +++ b/WindowsForms/Grid-Control/Cell-Navigation.md @@ -61,7 +61,7 @@ void gridControl1_CurrentCellActivating(object sender, Syncfusion.Windows.Forms. } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.CurrentCellActivating += New GridCurrentCellActivatingEventHandler(AddressOf gridControl1_CurrentCellActivating) +AddHandler Me.gridControl1.CurrentCellActivating, New GridCurrentCellActivatingEventHandler(AddressOf gridControl1_CurrentCellActivating) Private Sub gridControl1_CurrentCellActivating(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Grid.GridCurrentCellActivatingEventArgs) 'Cancel the activation of current cell. diff --git a/WindowsForms/Grid-Control/Cell-Types.md b/WindowsForms/Grid-Control/Cell-Types.md index c82766f93..1deb46507 100644 --- a/WindowsForms/Grid-Control/Cell-Types.md +++ b/WindowsForms/Grid-Control/Cell-Types.md @@ -41,7 +41,7 @@ TextBox cells are the default cell type of GridControl. TextBox cells displays t gridControl1[2, 2].Text = "TextBox"; gridControl1[2, 2].CellType = "TextBox"; gridControl1[2, 3].Text = "TextBox/Image"; -gridControl1[2, 2].CellType = "TextBox"; +gridControl1[2, 3].CellType = "TextBox"; gridControl1[2, 3].ImageIndex = 0; {% endhighlight %} {% highlight vb %} @@ -50,7 +50,7 @@ gridControl1(2, 2).CellType = "TextBox" 'Text box with image assumes ImageList set the same Static sample code. gridControl1(2, 3).Text = "TextBox/Image" -gridControl1(2, 2).CellType = "TextBox" +gridControl1(2, 3).CellType = "TextBox" gridControl1(2, 3).ImageIndex = 0 {% endhighlight %} {% endtabs %} @@ -67,7 +67,7 @@ gridControl1[2, 2].Text = "Static"; gridControl1[2, 2].CellType = "Static"; gridControl1[2, 3].Text = "Static/Image"; -gridControl1[2, 2].CellType = "Static"; +gridControl1[2, 3].CellType = "Static"; gridControl1[2, 3].ImageIndex = 2; {% endhighlight %} @@ -77,7 +77,7 @@ gridControl1(2, 2).Text = "Static" gridControl1(2, 2).CellType = "Static" gridControl1(2, 3).Text = "Static/Image" -gridControl1(2, 2).CellType = "Static" +gridControl1(2, 3).CellType = "Static" gridControl1(2, 3).ImageIndex = 2 {% endhighlight %} @@ -85,7 +85,7 @@ gridControl1(2, 3).ImageIndex = 2 ![Cell-Types_img3](Cell-Types_images/Cell-Types_img3.png) -N> Though static cells cannot be edited, it can be deleted by using the<kbd> DELETE</kbd> key. +N> Though static cells cannot be edited, it can be deleted by using the DELETE key. ## Header cell type Header cells are as same as that of static cells, in addition, this cell type has a button-like border that can have a depressed state. Header cell type is mainly used as header for rows and columns. If a particular cell needs to be of type header, then make use of this cell type. @@ -568,8 +568,8 @@ It is possible to add an arbitrary control in a grid cell through `Control` cell {% tabs %} {% highlight c# %} Panel panel1 = new Panel(); -panel.Controls.Add(new Button()); -panel.Controls.Add(new RadioButton()); +panel1.Controls.Add(new Button()); +panel1.Controls.Add(new RadioButton()); //Sets the control object. this.gridControl1[2, 2].Control = panel1; @@ -578,8 +578,8 @@ this.gridControl1[2, 2].CellType = "Control"; {% endhighlight %} {% highlight vb %} Dim panel1 As New Panel() -panel.Controls.Add(New Button()) -panel.Controls.Add(New RadioButton()) +panel1.Controls.Add(New Button()) +panel1.Controls.Add(New RadioButton()) 'Sets the control object. Me.gridControl1(2, 2).Control = panel1 @@ -605,9 +605,9 @@ this.gridControl1[3, 2].CellType = GridCellTypeName.Currency; this.gridControl1[4, 2].CellType = GridCellTypeName.Currency; {% endhighlight %} {% highlight vb %} -Me.gridControl1(2, 2).CellType = GridCellTypeName.ColorEdit -Me.gridControl1[3, 2].CellType = GridCellTypeName.Currency -Me.gridControl1[4, 2].CellType = GridCellTypeName.Currency +Me.gridControl1(2, 2).CellType = GridCellTypeName.Currency +Me.gridControl1(3, 2).CellType = GridCellTypeName.Currency +Me.gridControl1(4, 2).CellType = GridCellTypeName.Currency {% endhighlight %} {% endtabs %} @@ -1151,7 +1151,7 @@ AddHandler GridControl1.CellButtonClicked, AddressOf gridControl1_CellButtonClic {% endtabs %} ## RichTextBox cell type -The `RichTextBox` control will allow to display and edit rich text in grid cells. To make use of this control set the cell type as `GridCellTypeName.RichTextBox`. +The `RichTextBox` control will allow to display and edit rich text in grid cells. To make use of this control set the cell type as `GridCellTypeName.RichText`. {% tabs %} {% highlight c# %} GridStyleInfo style = gridControl1.Model[2, 2]; diff --git a/WindowsForms/Grid-Control/CommentTip.md b/WindowsForms/Grid-Control/CommentTip.md index 891ecdd42..e945da56c 100644 --- a/WindowsForms/Grid-Control/CommentTip.md +++ b/WindowsForms/Grid-Control/CommentTip.md @@ -270,7 +270,7 @@ void gridControl1_DrawCommentIndicator(object sender, DrawCommentIndicatorEventA } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.DrawCommentIndicator += New DrawCommentIndicatorEventHandler(AddressOf gridControl1_DrawCommentIndicator) +AddHandler Me.gridControl1.DrawCommentIndicator, New DrawCommentIndicatorEventHandler(AddressOf gridControl1_DrawCommentIndicator) Private Sub gridControl1_DrawCommentIndicator(ByVal sender As Object, ByVal e As DrawCommentIndicatorEventArgs) Console.WriteLine("CommentRow {0} CommentColumn {1}", e.RowIndex, e.ColIndex) End Sub @@ -288,7 +288,7 @@ void gridControl1_CommentTipShowing(object sender, CommentTipShowingEventArgs e) } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.CommentTipShowing += New CommentTipShowingEventHandler(AddressOf gridControl1_CommentTipShowing) +AddHandler Me.gridControl1.CommentTipShowing, New CommentTipShowingEventHandler(AddressOf gridControl1_CommentTipShowing) Private Sub gridControl1_CommentTipShowing(ByVal sender As Object, ByVal e As CommentTipShowingEventArgs) Console.WriteLine("CommentRow {0} CommentColumn {1}", e.RowIndex, e.ColIndex) End Sub diff --git a/WindowsForms/Grid-Control/Copy-and-Paste.md b/WindowsForms/Grid-Control/Copy-and-Paste.md index a4b4c5c43..43978187e 100644 --- a/WindowsForms/Grid-Control/Copy-and-Paste.md +++ b/WindowsForms/Grid-Control/Copy-and-Paste.md @@ -90,7 +90,7 @@ void gridControl1_ClipboardCopy(object sender, GridCutPasteEventArgs e) } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.ClipboardCopy += AddressOf gridControl1_ClipboardCopy +AddHandler Me.gridControl1.ClipboardCopy, AddressOf gridControl1_ClipboardCopy Private Sub gridControl1_ClipboardCopy(ByVal sender As Object, ByVal e As GridCutPasteEventArgs) 'To restrict the Clipboard copy. e.Handled = True @@ -122,7 +122,7 @@ void gridControl1_ClipboardPaste(object sender, GridCutPasteEventArgs e) } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.ClipboardPaste += AddressOf gridControl1_ClipboardPaste +AddHandler Me.gridControl1.ClipboardPaste, AddressOf gridControl1_ClipboardPaste Private Sub gridControl1_ClipboardPaste(ByVal sender As Object, ByVal e As GridCutPasteEventArgs) 'To restrict the paste operation. e.Handled = True @@ -201,7 +201,7 @@ void gridControl1_ClipboardPaste(object sender, GridCutPasteEventArgs e) } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.ClipboardPaste += AddressOf gridControl1_ClipboardPaste +AddHandler Me.gridControl1.ClipboardPaste, AddressOf gridControl1_ClipboardPaste Private Sub gridControl1_ClipboardPaste(ByVal sender As Object, ByVal e As GridCutPasteEventArgs) Dim data As DataObject = CType(Clipboard.GetDataObject(), DataObject) @@ -416,7 +416,7 @@ End Sub {% endtabs %} ### Preventing Paste for a particular Cell -The pasting operation can be prevented for particular cells by handling the [PasteCellText](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_PasteCellText) event. This event will fire when the cell is not in edit mode at the time of pasting. This can be achieved by setting the [ActivateCurrentCellBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.Grouping.GridGroupingControl.html#Syncfusion_Windows_Forms_Grid_Grouping_GridGroupingControl_ActivateCurrentCellBehavior) property to `DoubleClickOnCell`. +The pasting operation can be prevented for particular cells by handling the [PasteCellText](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_PasteCellText) event. This event will fire when the cell is not in edit mode at the time of pasting. This can be achieved by setting the [ActivateCurrentCellBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_ActivateCurrentCellBehavior) property to `DoubleClickOnCell`. {% tabs %} {% highlight c# %} this.gridControl1.PasteCellText += new GridPasteCellTextEventHandler(gridControl1_PasteCellText); @@ -431,7 +431,7 @@ void gridControl1_PasteCellText(object sender, GridPasteCellTextEventArgs e) } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.PasteCellText += New GridPasteCellTextEventHandler(AddressOf gridControl1_PasteCellText) +AddHandler Me.gridControl1.PasteCellText, New GridPasteCellTextEventHandler(AddressOf gridControl1_PasteCellText) Private Sub gridControl1_PasteCellText(ByVal sender As Object, ByVal e As GridPasteCellTextEventArgs) diff --git a/WindowsForms/Grid-Control/Covered-Ranges.md b/WindowsForms/Grid-Control/Covered-Ranges.md index 97c2e16f7..bd33a19c2 100644 --- a/WindowsForms/Grid-Control/Covered-Ranges.md +++ b/WindowsForms/Grid-Control/Covered-Ranges.md @@ -51,7 +51,7 @@ void gridControl1_QueryCoveredRange(object sender, GridQueryCoveredRangeEventArg {% endhighlight %} {% highlight vb %} 'Triggering the QueryCoveredRange event. -Private Me.gridControl1.QueryCoveredRange += New GridQueryCoveredRangeEventHandler(AddressOf gridControl1_QueryCoveredRange) +AddHandler Me.gridControl1.QueryCoveredRange, New GridQueryCoveredRangeEventHandler(AddressOf gridControl1_QueryCoveredRange) Private Sub gridControl1_QueryCoveredRange(ByVal sender As Object, ByVal e As GridQueryCoveredRangeEventArgs) @@ -124,7 +124,7 @@ The `CoveredRanges` from the GridControl can be cleared by using the [Clear](htt this.gridControl1.CoveredRanges.Clear(); {% endhighlight %} {% highlight vb %} -'Clearing CoveredRange from GridControl. -this.gridControl1.CoveredRanges.Clear(); +'Clearing CoveredRange from GridControl. +Me.gridControl1.CoveredRanges.Clear() {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/Grid-Control/Data-Validation.md b/WindowsForms/Grid-Control/Data-Validation.md index 1a28fd790..7906a1710 100644 --- a/WindowsForms/Grid-Control/Data-Validation.md +++ b/WindowsForms/Grid-Control/Data-Validation.md @@ -67,7 +67,7 @@ N> While the error is occurred, the current cell will not leave from the edit mo ## Programmatic validation -While setting the cell value through the code, it will not trigger the [CurrentCellStartEditing](https://help.syncfusion.com/cr/windowsforms/Syncfusion.GridHelperClasses.GridCardView.html) and [CurrentCellValidating](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControlBase.html) events. Therefore the validation will not work at this type of editing. To validate this type of editing, call [CurrentCell.Validate](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridCurrentCell.html#Syncfusion_Windows_Forms_Grid_GridCurrentCell_Validate) method after editing the value of the current cell. It will raise the `CurrentCellValidating` event to manually validate the cell value. +While setting the cell value through the code, it will not trigger the [CurrentCellStartEditing](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControlBase.html#Syncfusion_Windows_Forms_Grid_GridControlBase_CurrentCellStartEditing) and [CurrentCellValidating](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControlBase.html) events. Therefore the validation will not work at this type of editing. To validate this type of editing, call [CurrentCell.Validate](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridCurrentCell.html#Syncfusion_Windows_Forms_Grid_GridCurrentCell_Validate) method after editing the value of the current cell. It will raise the `CurrentCellValidating` event to manually validate the cell value. {% tabs %} {% highlight c# %} @@ -175,7 +175,7 @@ void gridControl1_CurrentCellValidating(object sender, CancelEventArgs e) {% highlight vb %} 'Invoke this event for validate the conditions. -Private Me.gridControl1.CurrentCellValidating += AddressOf gridControl1_CurrentCellValidating +AddHandler Me.gridControl1.CurrentCellValidating, AddressOf gridControl1_CurrentCellValidating Private Sub gridControl1_CurrentCellValidating(ByVal sender As Object, ByVal e As CancelEventArgs) @@ -215,7 +215,7 @@ e.Cancel = true; {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.CurrentCellErrorMessage += AddressOf gridControl1_CurrentCellErrorMessage +AddHandler Me.gridControl1.CurrentCellErrorMessage, AddressOf gridControl1_CurrentCellErrorMessage Private Sub gridControl1_CurrentCellErrorMessage(ByVal sender As Object, ByVal e As GridCurrentCellErrorMessageEventArgs) diff --git a/WindowsForms/Grid-Control/Drag-and-Drop.md b/WindowsForms/Grid-Control/Drag-and-Drop.md index 4c7419b52..cb14291e3 100644 --- a/WindowsForms/Grid-Control/Drag-and-Drop.md +++ b/WindowsForms/Grid-Control/Drag-and-Drop.md @@ -110,7 +110,7 @@ e.AllowDrag = false; {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.QueryAllowDragColumnHeader += New GridQueryDragColumnHeaderEventHandler(AddressOf gridControl1_QueryAllowDragColumnHeader) +AddHandler Me.gridControl1.QueryAllowDragColumnHeader, New GridQueryDragColumnHeaderEventHandler(AddressOf gridControl1_QueryAllowDragColumnHeader) Private Sub gridControl1_QueryAllowDragColumnHeader(ByVal sender As Object, ByVal e As GridQueryDragColumnHeaderEventArgs) 'Prevents dragging in 2nd column. @@ -232,7 +232,7 @@ void gridControl1_QueryCanOleDragRange(object sender, GridQueryCanOleDragRangeEv {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.QueryCanOleDragRange += New GridQueryCanOleDragRangeEventHandler(AddressOf gridControl1_QueryCanOleDragRange) +AddHandler Me.gridControl1.QueryCanOleDragRange, New GridQueryCanOleDragRangeEventHandler(AddressOf gridControl1_QueryCanOleDragRange) Private Sub gridControl1_QueryCanOleDragRange(ByVal sender As Object, ByVal e As GridQueryCanOleDragRangeEventArgs) 'Drag Drop process will be canceled. diff --git a/WindowsForms/Grid-Control/Exporting.md b/WindowsForms/Grid-Control/Exporting.md index cc66e2d09..67fcc7cf9 100644 --- a/WindowsForms/Grid-Control/Exporting.md +++ b/WindowsForms/Grid-Control/Exporting.md @@ -365,10 +365,10 @@ void excelConverter _QueryImportExportCellInfo(object sender, GridImportExportCe Private excelConverter As New Syncfusion.GridExcelConverter.GridExcelConverterControl() ' Triggering the event. -Private excelConverter.QueryImportExportCellInfo += New GridImportExportCellInfoEventHandler(excelConverter AddressOf _QueryImportExportCellInfo) +AddHandler excelConverter.QueryImportExportCellInfo, New GridImportExportCellInfoEventHandler(AddressOf excelConverter_QueryImportExportCellInfo) excelConverter.GridToExcel(Me.gridControl1.Model, "Sample.xlsx") -void excelConverter _QueryImportExportCellInfo(Object sender, GridImportExportCellInfoEventArgs e) +Private Sub excelConverter_QueryImportExportCellInfo(ByVal sender As Object, ByVal e As GridImportExportCellInfoEventArgs) ' Checking whether it is Exporting action. If e.Action = GridConverterAction.Export Then @@ -541,8 +541,8 @@ private void pdfConverter_Exported(object sender, PDFExportedEventArgs e) 'Create PDF converter Private pdfConverter As New GridPDFConverter() 'Used to perform the action while exporting the Grid. -Private pdfConverter.Exporting += New GridPDFConverter.PDFExportingEventHandler(AddressOf pdfConverter_Exporting) -Private pdfConverter.Exported += New GridPDFConverter.PDFExportedEventHandler(AddressOf pdfConverter_Exported) +AddHandler pdfConverter.Exporting, New GridPDFConverter.PDFExportingEventHandler(AddressOf pdfConverter_Exporting) +AddHandler pdfConverter.Exported, New GridPDFConverter.PDFExportedEventHandler(AddressOf pdfConverter_Exported) Private Sub pdfConverter_Exporting(ByVal sender As Object, ByVal e As PDFExportingEventArgs) '  Getting the pdf document. @@ -606,9 +606,9 @@ void pdfConverter_DrawPDFFooter(object sender, PDFHeaderFooterEventArgs e) {% endhighlight %} {% highlight vb %} -Private pdfConvertor.DrawPDFHeader += New GridPDFConverter.DrawPDFHeaderFooterEventHandler(AddressOf pdfConvertor_DrawPDFHeader) +AddHandler pdfConvertor.DrawPDFHeader, New GridPDFConverter.DrawPDFHeaderFooterEventHandler(AddressOf pdfConvertor_DrawPDFHeader) -Private pdfConvertor.DrawPDFFooter += New GridPDFConverter.DrawPDFHeaderFooterEventHandler(AddressOf pdfConvertor_DrawPDFFooter) +AddHandler pdfConvertor.DrawPDFFooter, New GridPDFConverter.DrawPDFHeaderFooterEventHandler(AddressOf pdfConvertor_DrawPDFFooter) Private Sub pdfConverter_DrawPDFHeader(ByVal sender As Object, ByVal e As PDFHeaderFooterEventArgs) Dim header As PdfPageTemplateElement = e.HeaderFooterTemplate Dim brush As New PdfSolidBrush(Color.FromArgb(44, 71, 120)) @@ -700,13 +700,15 @@ void converter_DrawHeader(object sender, DocHeaderFooterEventArgs e) Private converter As New GridWordConverter(True,True) 'To Set the Header and Footer for the Exported word document. -Private wordConverter.DrawHeader += New GridWordConverterBase.DrawDocHeaderFooterEventHandler(AddressOf converter_DrawHeader) -Private wordConverter.DrawFooter += New GridWordConverterBase.DrawDocHeaderFooterEventHandler(AddressOf converter_DrawFooter) +AddHandler wordConverter.DrawHeader, New GridWordConverterBase.DrawDocHeaderFooterEventHandler(AddressOf converter_DrawHeader) +AddHandler wordConverter.DrawFooter, New GridWordConverterBase.DrawDocHeaderFooterEventHandler(AddressOf converter_DrawFooter) converter.GridToWord("Sample.doc", gridControl1) -void converter_DrawFooter(Object sender, DocHeaderFooterEventArgs e) +Private Sub converter_DrawFooter(ByVal sender As Object, ByVal e As DocHeaderFooterEventArgs) e.Footer.AddParagraph().AppendText("Copyright 2001-2015") -void converter_DrawHeader(Object sender, DocHeaderFooterEventArgs e) +End Sub +Private Sub converter_DrawHeader(ByVal sender As Object, ByVal e As DocHeaderFooterEventArgs) e.Header.AddParagraph().AppendText("Syncfusion Inc.") +End Sub {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/Grid-Control/Find-and-Replace.md b/WindowsForms/Grid-Control/Find-and-Replace.md index 26b39fadc..8685b18c4 100644 --- a/WindowsForms/Grid-Control/Find-and-Replace.md +++ b/WindowsForms/Grid-Control/Find-and-Replace.md @@ -110,7 +110,7 @@ void gridControl1_CurrentCellKeyDown(object sender, KeyEventArgs e) {% endhighlight %} {% highlight vb %} 'Triggering the CurrentCellKeyDown event. -Private Me.gridControl1.CurrentCellKeyDown += New KeyEventHandler(AddressOf gridControl1_CurrentCellKeyDown) +AddHandler Me.gridControl1.CurrentCellKeyDown, New KeyEventHandler(AddressOf gridControl1_CurrentCellKeyDown) Private Sub gridControl1_CurrentCellKeyDown(ByVal sender As Object, ByVal e As KeyEventArgs) If e.Control AndAlso e.KeyCode = Keys.F Then @@ -134,7 +134,7 @@ End Sub The `Find and Replace` of the text in GridControl can be customized or can be used other than the `GridFindReplaceDialog`. The [GridFindReplaceEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridFindReplaceEventArgs.html) class provides the options to the `GridFindReplaceDialogSink` to perform the `Find and Replace` programmatically without having dialog. ### Find and Find All -To find first possible match at the earliest based on the search options, use the [Find](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.Grouping.GridGroupTypedListRecordsCollection.html) method. The below code is used to find the text in GridControl +To find first possible match at the earliest based on the search options, use the [Find](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridFindReplaceDialogSink.html) method. The below code is used to find the text in GridControl {% tabs %} {% highlight c# %} diff --git a/WindowsForms/Grid-Control/Getting-Started.md b/WindowsForms/Grid-Control/Getting-Started.md index 6e255d21a..e059bc452 100644 --- a/WindowsForms/Grid-Control/Getting-Started.md +++ b/WindowsForms/Grid-Control/Getting-Started.md @@ -355,7 +355,7 @@ Me.gridControl1.ChangeCells(GridRangeInfo.Cells(2, 2, 4, 2), style) Windows Forms GridControl provides two types of selection namely Range selection and Record selection. Range selection also known as cell based selection is used to select a range of cells, rows and columns in grid. Record selection which is also known as record based selection is used to select a single record or a range of records at a time in a grid. -For selecting single row or multiple range of rows in GridControl, set the [ListBoxSelectionMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.Grouping.GridTableOptionsStyleInfo.html#Syncfusion_Windows_Forms_Grid_Grouping_GridTableOptionsStyleInfo_ListBoxSelectionMode) property value as `Single`, `MultiSimple` or `MultiExtended` respectively. By default the value is `None`. +For selecting single row or multiple range of rows in GridControl, set the [ListBoxSelectionMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_ListBoxSelectionMode) property value as `Single`, `MultiSimple` or `MultiExtended` respectively. By default the value is `None`. {% tabs %} {% highlight c# %} @@ -366,7 +366,7 @@ Me.gridControl1.ListBoxSelectionMode = SelectionMode.None {% endhighlight %} {% endtabs %} -For selecting the range of cells in GridControl, set the [AllowSelection](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.Grouping.GridTableOptionsStyleInfo.html#Syncfusion_Windows_Forms_Grid_Grouping_GridTableOptionsStyleInfo_AllowSelection) property to the appropriate value from the [GridSelectionFlags](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridSelectionFlags.html) enumeration. +For selecting the range of cells in GridControl, set the [AllowSelection](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_AllowSelection) property to the appropriate value from the [GridSelectionFlags](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridSelectionFlags.html) enumeration. {% tabs %} {% highlight c# %} diff --git a/WindowsForms/Grid-Control/How-To/Common/CommonDocmentnot/How-to-Make-Use-of-the-Journal-Control-using-GridGrouping-Controls.md b/WindowsForms/Grid-Control/How-To/Common/CommonDocmentnot/How-to-Make-Use-of-the-Journal-Control-using-GridGrouping-Controls.md index 5f442670c..f20344b17 100644 --- a/WindowsForms/Grid-Control/How-To/Common/CommonDocmentnot/How-to-Make-Use-of-the-Journal-Control-using-GridGrouping-Controls.md +++ b/WindowsForms/Grid-Control/How-To/Common/CommonDocmentnot/How-to-Make-Use-of-the-Journal-Control-using-GridGrouping-Controls.md @@ -92,7 +92,7 @@ Me.gridGroupingControl1.TableOptions.ShowRecordPreviewRow = Not Me.gridGroupingC -Private Me.gridGroupingControl1.QueryCellStyleInfo += New Syncfusion.Windows.Forms.Grid.Grouping.GridTableCellStyleInfoEventHandler(AddressOf gridGroupingControl1_QueryCellStyleInfo) +AddHandler Me.gridGroupingControl1.QueryCellStyleInfo, New Syncfusion.Windows.Forms.Grid.Grouping.GridTableCellStyleInfoEventHandler(AddressOf gridGroupingControl1_QueryCellStyleInfo) diff --git a/WindowsForms/Grid-Control/Importing.md b/WindowsForms/Grid-Control/Importing.md index 0b85a3580..564a9c64a 100644 --- a/WindowsForms/Grid-Control/Importing.md +++ b/WindowsForms/Grid-Control/Importing.md @@ -86,12 +86,12 @@ void excelConverter_QueryImportExportCellInfo(object sender, GridImportExportCel {% endhighlight %} {% highlight vb %} Private excelConverter As New GridExcelConverterControl() -Private excelConverter.QueryImportExportCellInfo += New GridImportExportCellInfoEventHandler(AddressOf excelConverter_QueryImportExportCellInfo) +AddHandler excelConverter.QueryImportExportCellInfo, New GridImportExportCellInfoEventHandler(AddressOf excelConverter_QueryImportExportCellInfo) 'Import the content of Excel to the Grid excelConverter.ExcelToGrid("Sample.xls", Me.gridControl1.Model) -void excelConverter_QueryImportExportCellInfo(Object sender, GridImportExportCellInfoEventArgs e) +Private Sub excelConverter_QueryImportExportCellInfo(ByVal sender As Object, ByVal e As GridImportExportCellInfoEventArgs) ' Checking whether it is Importing action If e.Action = GridConverterAction.Import Then diff --git a/WindowsForms/Grid-Control/Managing-the-Rows-and-Columns.md b/WindowsForms/Grid-Control/Managing-the-Rows-and-Columns.md index e0895f5de..427f2400b 100644 --- a/WindowsForms/Grid-Control/Managing-the-Rows-and-Columns.md +++ b/WindowsForms/Grid-Control/Managing-the-Rows-and-Columns.md @@ -191,12 +191,12 @@ A frozen row is one that cannot be scrolled. The column headers and row headers {% tabs %} {% highlight c# %} -//Has 3 non-scrollable rows at the top. +//Has 2 non-scrollable rows at the top. this.gridControl.Rows.FrozenCount = 2; this.gridControl1.Cols.FrozenCount = 3; {% endhighlight %} {% highlight vb %} -'Has 3 non-scrollable rows at the top. +'Has 2 non-scrollable rows at the top. Me.gridControl.Rows.FrozenCount = 2 Me.gridControl1.Cols.FrozenCount = 3 {% endhighlight %} @@ -258,7 +258,7 @@ void gridControl1_RowsMoved(object sender, Syncfusion.Windows.Forms.Grid.GridRan } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.RowsMoved += New Syncfusion.Windows.Forms.Grid.GridRangeMovedEventHandler(AddressOf gridControl1_RowsMoved) +AddHandler Me.gridControl1.RowsMoved, New Syncfusion.Windows.Forms.Grid.GridRangeMovedEventHandler(AddressOf gridControl1_RowsMoved) Private Sub gridControl1_RowsMoved(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Grid.GridRangeMovedEventArgs) Dim index As Integer = e.Count End Sub diff --git a/WindowsForms/Grid-Control/Performance.md b/WindowsForms/Grid-Control/Performance.md index ab7c28648..7cf294249 100644 --- a/WindowsForms/Grid-Control/Performance.md +++ b/WindowsForms/Grid-Control/Performance.md @@ -99,21 +99,21 @@ private void GridQueryCellInfo(object sender, GridQueryCellInfoEventArgs e) {% highlight vb %} 'Determines number of rows. -Private Me.gridControl1.QueryRowCount += New GridRowColCountEventHandler(AddressOf GridQueryRowCount) +AddHandler Me.gridControl1.QueryRowCount, New GridRowColCountEventHandler(AddressOf GridQueryRowCount) Private Sub GridQueryRowCount(ByVal sender As Object, ByVal e As GridRowColCountEventArgs) e.Count = Me.numberOfArrayRows e.Handled = True End Sub 'Determines the number of columns. -Private Me.gridControl1.QueryColCount += New GridRowColCountEventHandler(AddressOf GridQueryColCount) +AddHandler Me.gridControl1.QueryColCount, New GridRowColCountEventHandler(AddressOf GridQueryColCount) Private Sub GridQueryColCount(ByVal sender As Object, ByVal e As GridRowColCountEventArgs) e.Count = Me.numberOfArrayCols e.Handled = True End Sub 'Passes value to a cell from a given data source. -Private Me.gridControl1.QueryCellInfo += New GridQueryCellInfoEventHandler(AddressOf QueryCellInfoHandler) +AddHandler Me.gridControl1.QueryCellInfo, New GridQueryCellInfoEventHandler(AddressOf QueryCellInfoHandler) Private Sub GridQueryCellInfo(ByVal sender As Object, ByVal e As GridQueryCellInfoEventArgs) If e.ColIndex > 0 AndAlso e.RowIndex > 0 Then @@ -269,7 +269,7 @@ converter.ExportStyle = false; {% endhighlight %} {% highlight vb %} 'Indicates to stop exporting the styles in GridControl -converter.ExportStyle = True +converter.ExportStyle = False {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/Grid-Control/Scrolling.md b/WindowsForms/Grid-Control/Scrolling.md index 37d8b2529..b35d61e14 100644 --- a/WindowsForms/Grid-Control/Scrolling.md +++ b/WindowsForms/Grid-Control/Scrolling.md @@ -219,7 +219,7 @@ Me.gridControl1.ScrollCellInView(rowIndex, colIndex) Me.gridControl1.ScrollCellInView(rowIndex, colIndex, GridScrollCurrentCellReason.MoveTo) {% endhighlight %} {% endtabs %} -It can be used to scrolling the grid to the top of the given range as of follows, +It can be used to scroll the grid to the top of the given range as follows, {% tabs %} {% highlight c# %} GridRangeInfo range = GridRangeInfo.Row(14); @@ -438,7 +438,8 @@ this.gridControl1.VScrollBehavior = GridScrollbarMode.Shared; //Enable the Shared Scrollbars this.gridControl1.UseSharedScrollBars = true; -//Set the inner scrollbar which is shared to the grid this.gridControl1.HScrollBar.InnerScrollBar = hScrollBar1; +//Set the inner scrollbar which is shared to the grid +this.gridControl1.HScrollBar.InnerScrollBar = hScrollBar1; this.gridControl1.VScrollBar.InnerScrollBar = vScrollBar1; {% endhighlight %} {% highlight vb %} @@ -449,7 +450,8 @@ Me.gridControl1.VScrollBehavior = GridScrollbarMode.Shared 'Enable the Shared Scrollbars Me.gridControl1.UseSharedScrollBars = True -'Set the inner scrollbar which is shared to the grid this.gridControl1.HScrollBar.InnerScrollBar = hScrollBar1; +'Set the inner scrollbar which is shared to the grid +Me.gridControl1.HScrollBar.InnerScrollBar = hScrollBar1 Me.gridControl1.VScrollBar.InnerScrollBar = vScrollBar1 {% endhighlight %} @@ -476,7 +478,7 @@ void VScrollBar_Scroll(object sender, ScrollEventArgs e) {% endhighlight %} {% highlight vb %} 'Used to get the scroll index -Private Me.gridControl1.VScrollBar.Scroll += AddressOf VScrollBar_Scroll +AddHandler Me.gridControl1.VScrollBar.Scroll, AddressOf VScrollBar_Scroll Private lastValue As Integer = -1 Private Sub VScrollBar_Scroll(ByVal sender As Object, ByVal e As ScrollEventArgs) @@ -574,7 +576,7 @@ void gridControl1_HorizontalScroll(object sender, ScrollEventArgs e) } {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.HorizontalScroll += New ScrollEventHandler(AddressOf gridControl1_HorizontalScroll) +AddHandler Me.gridControl1.HorizontalScroll, New ScrollEventHandler(AddressOf gridControl1_HorizontalScroll) Private Sub gridControl1_HorizontalScroll(ByVal sender As Object, ByVal e As ScrollEventArgs) If e.NewValue > 230 Then diff --git a/WindowsForms/Grid-Control/Selection.md b/WindowsForms/Grid-Control/Selection.md index ec8b9d6f2..79d35035c 100644 --- a/WindowsForms/Grid-Control/Selection.md +++ b/WindowsForms/Grid-Control/Selection.md @@ -50,7 +50,7 @@ Me.gridControl1.ListBoxSelectionMode = SelectionMode.MultiSimple ## Adding Selection -In the GridControl the selections are maintained in the [SelectedRanges](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.Grouping.GridTableModel.html#Syncfusion_Windows_Forms_Grid_Grouping_GridTableModel_SelectedRanges) collection. To add the selection for particular range of cells, add the range into the `SelectedRanges` collection. +In the GridControl the selections are maintained in the [SelectedRanges](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridModel.html#Syncfusion_Windows_Forms_Grid_GridModel_SelectedRanges) collection. To add the selection for particular range of cells, add the range into the `SelectedRanges` collection. {% tabs %} {% highlight c# %} @@ -176,7 +176,7 @@ void gridControl1_SelectionChanging(object sender, GridSelectionChangingEventArg {% highlight vb %} 'To prevent the selection from particular range of cells -Private Me.gridControl1.SelectionChanging += AddressOf gridControl1_SelectionChanging +AddHandler Me.gridControl1.SelectionChanging, AddressOf gridControl1_SelectionChanging Private Sub gridControl1_SelectionChanging(ByVal sender As Object, ByVal e As GridSelectionChangingEventArgs) @@ -222,7 +222,7 @@ The selection color of the grid can be reset by using the [ResetAlphaBlendSelect {% tabs %} {% highlight c# %} //To reset the color of selection in grid control -gridControl.ResetAlphaBlendSelectionColor(); +this.gridControl1.ResetAlphaBlendSelectionColor(); {% endhighlight %} {% highlight vb %} @@ -233,7 +233,7 @@ gridControl.ResetAlphaBlendSelectionColor() ### Setting the CurrentCell Back Color Similar to the Back Color of the Remaining Selected Cells -When the cell is entered into the edit mode, it will not display the selection color. To display the selection color for the editing cell, set the selection color as the back color for the current cell in the [CellDrawn](https://help.syncfusion.com/cr/windowsforms/Syncfusion.GridHelperClasses.GridCardView.html) event. +When the cell is entered into the edit mode, it will not display the selection color. To display the selection color for the editing cell, set the selection color as the back color for the current cell in the [CellDrawn](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControlBase.html#Syncfusion_Windows_Forms_Grid_GridControlBase_CellDrawn) event. {% tabs %} {% highlight c# %} @@ -257,7 +257,7 @@ void gridControl1_CellDrawn(object sender, GridDrawCellEventArgs e) {% highlight vb %} 'To Draw the selection color for Current Cell -Private Me.gridControl1.CellDrawn += AddressOf gridControl1_CellDrawn +AddHandler Me.gridControl1.CellDrawn, AddressOf gridControl1_CellDrawn Private Sub gridControl1_CellDrawn(ByVal sender As Object, ByVal e As GridDrawCellEventArgs) @@ -327,7 +327,7 @@ The selected values are printed in the output screen as of follows, ## Cell Text Selection -The current cell activation behavior is controlled by the grid’s [ActivateCurrentCellBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.Grouping.GridGroupingControl.html#Syncfusion_Windows_Forms_Grid_Grouping_GridGroupingControl_ActivateCurrentCellBehavior) property. When the property is set to [SelectAll](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridCellActivateAction.html)**,** it will selects all the text in the cell when the cell is activated. +The current cell activation behavior is controlled by the grid's [ActivateCurrentCellBehavior](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridControl.html#Syncfusion_Windows_Forms_Grid_GridControl_ActivateCurrentCellBehavior) property. When the property is set to [SelectAll](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Grid.GridCellActivateAction.html), it will select all the text in the cell when the cell is activated. {% tabs %} {% highlight c# %} diff --git a/WindowsForms/Grid-Control/Virtual-Grid.md b/WindowsForms/Grid-Control/Virtual-Grid.md index 45a8cbd62..a961e2721 100644 --- a/WindowsForms/Grid-Control/Virtual-Grid.md +++ b/WindowsForms/Grid-Control/Virtual-Grid.md @@ -193,7 +193,7 @@ e.Handled = true; {% endhighlight %} {% highlight vb %} -Private gridControl1.QueryRowCount += AddressOf gridControl1_QueryRowCount +AddHandler gridControl1.QueryRowCount, AddressOf gridControl1_QueryRowCount Private Sub gridControl1_QueryRowCount(ByVal sender As Object, ByVal e As GridRowColCountEventArgs) @@ -202,7 +202,7 @@ e.Count = 100 e.Handled = True End Sub -Private gridControl1.QueryColCount += AddressOf gridControl1_QueryColCount +AddHandler gridControl1.QueryColCount, AddressOf gridControl1_QueryColCount Private Sub gridControl1_QueryColCount(ByVal sender As Object, ByVal e As GridRowColCountEventArgs) @@ -304,7 +304,7 @@ void gridControl1_QueryRowHeight(object sender, GridRowColSizeEventArgs e) {% endhighlight %} {% highlight vb %} -Me.gridControl1.QueryRowHeight += gridControl1_QueryRowHeight +AddHandler Me.gridControl1.QueryRowHeight, AddressOf gridControl1_QueryRowHeight Private Sub gridControl1_QueryRowHeight(ByVal sender As Object, ByVal e As GridRowColSizeEventArgs) @@ -345,7 +345,7 @@ e.Handled = true; {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.QueryColWidth += AddressOf gridControl1_QueryColWidth +AddHandler Me.gridControl1.QueryColWidth, AddressOf gridControl1_QueryColWidth Private Sub gridControl1_QueryColWidth(ByVal sender As Object, ByVal e As GridRowColSizeEventArgs) @@ -384,7 +384,7 @@ e.Handled = true; {% endhighlight %} {% highlight vb %} -Private Me.gridControl1.QueryCoveredRange += AddressOf gridControl1_QueryCoveredRange +AddHandler Me.gridControl1.QueryCoveredRange, AddressOf gridControl1_QueryCoveredRange Private Sub gridControl1_QueryCoveredRange(ByVal sender As Object, ByVal e As GridQueryCoveredRangeEventArgs) From 94d4e1e4670d60b99b8c4314245283e37026c792 Mon Sep 17 00:00:00 2001 From: Satheesh Tharma Prabbu Theivaraja Date: Tue, 14 Jul 2026 11:32:21 +0530 Subject: [PATCH 13/36] Update AIAssistView Documentation --- WindowsForms/AI-AssistView/Customization.md | 37 ++- WindowsForms/AI-AssistView/Events.md | 45 +++- WindowsForms/AI-AssistView/Getting-Started.md | 20 +- WindowsForms/AI-AssistView/Open-AI.md | 61 +++-- WindowsForms/AI-AssistView/Overview.md | 28 +- .../AI-AssistView/Response-ToolBar.md | 252 ++++++++++-------- WindowsForms/AI-AssistView/Stop-Responding.md | 79 ------ WindowsForms/AI-AssistView/Suggestions.md | 103 ++++--- .../AI-AssistView/Typing-Indicator.md | 38 ++- 9 files changed, 384 insertions(+), 279 deletions(-) delete mode 100644 WindowsForms/AI-AssistView/Stop-Responding.md diff --git a/WindowsForms/AI-AssistView/Customization.md b/WindowsForms/AI-AssistView/Customization.md index 3f9abdd7a..e2405458e 100644 --- a/WindowsForms/AI-AssistView/Customization.md +++ b/WindowsForms/AI-AssistView/Customization.md @@ -1,15 +1,38 @@ --- layout: post -title: Customization in Windows Forms AI AssistView control | Syncfusion +title: Customization in Windows Forms AI AssistView Control | Syncfusion description: Learn about customizing the BannerView and creating custom BotView and UserView in the Syncfusion AI AssistView control here. platform: windowsforms control: SfAIAssistView documentation: ug --- -# Customization in AIAssistView +# Customization in AIAssistView -This section explains how to customize the BannerView, and how to create a custom BotView and UserView for the Windows Forms [SfAIAssistView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control +This section explains how to customize the BannerView, and how to create a custom BotView and UserView for the Windows Forms [SfAIAssistView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control. + +N> You can also explore our [sample](https://github.com/SyncfusionExamples/How-to-Customize-BannerView-and-Create-a-Custom-BotView-and-UserView-in-AIAssistView) on GitHub, which demonstrates complete customization of the BannerView, the creation of a custom BotView, and a custom UserView within an AssistView. + +## Prerequisites + +Before proceeding, ensure the following are in place: + +- A `ViewModel` class with a `Chats` collection, `ShowTypingIndicator`, `Suggestion`, and `CurrentUser` properties exists. Refer to the [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) page for setup details. +- A banner image is added to the project at the path referenced in code (for example, `Asset\AI_Assist.png`). +- The following `using` directives are included in your file: + +{% tabs %} +{% highlight c# %} + +using System; +using System.Collections.Specialized; +using System.ComponentModel; +using System.Drawing; +using System.Windows.Forms; +using Syncfusion.WinForms.AIAssistView; + +{% endhighlight %} +{% endtabs %} ## Customizing BannerView @@ -71,7 +94,7 @@ public partial class Form1 : Form ![WindowsForms AI AssistView Control Customized BannerView](aiassistview_images/windowsforms_aiassistview_customize_bannerview.png) -## Creating a Custom BotView +## Creating a Custom BotView You can create and set a custom BotView and apply it to the AssistView by using the [SetBotView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_SetBotView_System_Object_System_Windows_Forms_Control_) method. @@ -190,11 +213,11 @@ public partial class Form1 : Form ![WindowsForms AI AssistView Control Custom BotView](aiassistview_images/windowsforms_aiassistview_custom_botview.png) -## Creating a Custom UserView +## Creating a Custom UserView You can create and set a custom UserView and apply it to the AssistView by calling the [SetUserView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_SetUserView_System_Object_System_Windows_Forms_Control_) method. -The following example demonstrates how to create and set a custom UserView in AssistView. +The following example demonstrates how to create and set a custom UserView in the AssistView. {% tabs %} @@ -248,5 +271,3 @@ public partial class Form1 : Form ![WindowsForms AI AssistView Control Custom UserView](aiassistview_images/windowsforms_aiassistview_custom_userview.png) ![WindowsForms AI AssistView control Customization](aiassistview_images/windowsforms_aiassistview_customization.gif) - -N> You can also explore our [sample](https://github.com/SyncfusionExamples/How-to-Customize-BannerView-and-Create-a-Custom-BotView-and-UserView-in-AIAssistView) on GitHub, which demonstrates complete customization of the BannerView, the creation of a custom BotView, and a custom UserView within an AssistView. diff --git a/WindowsForms/AI-AssistView/Events.md b/WindowsForms/AI-AssistView/Events.md index 43d2d806c..1e42244d7 100644 --- a/WindowsForms/AI-AssistView/Events.md +++ b/WindowsForms/AI-AssistView/Events.md @@ -7,14 +7,38 @@ control: SfAIAssistView documentation: ug --- -# Event in Windows Forms AI AssistView (SfAIAssistView) +# Events in Windows Forms AI AssistView (SfAIAssistView) + +The following events are supported by the [SfAIAssistView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control: + +| Event | Description | +|-------|-------------| +| [PromptRequest](#promptrequest-event) | Notifies when a prompt is submitted in the control. | + +## Prerequisites + +Before proceeding, ensure the following are in place: + +- A `ViewModel` class with a `Chats` collection, `ShowTypingIndicator`, `Suggestion`, and `CurrentUser` properties exists. Refer to the [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) page for setup details. +- A bot avatar image is added to the project at the path referenced in code (for example, `Asset\AI_Assist.png`). +- The following `using` directives are included in your file: + +{% tabs %} +{% highlight c# %} + +using System; +using System.Windows.Forms; +using Syncfusion.WinForms.AIAssistView; + +{% endhighlight %} +{% endtabs %} ## PromptRequest event [PromptRequest](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_PromptRequest) event notifies users when a prompt is submitted in the control. It can be used to validate user input before processing or trigger custom actions based on the prompt content. The input message and its details are passed through the [PromptRequestEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.PromptRequestEventArgs.html). This argument provides the following details: -InputMessage : Represents the input message value of the AIAssistView. -Handled : Boolean value indicating whether the input message in the Messages collection has been handled by the event. +- `Message`: Represents the input message value of the AIAssistView (typically a `TextMessage`). +- `Handled`: Boolean value indicating whether the input message in the Messages collection has been handled by the event. Set this to `true` to prevent the default handling of the message. {% tabs %} @@ -32,7 +56,7 @@ public partial class Form1 : Form SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); sfAIAssistView1.Location = new System.Drawing.Point(41, 40); sfAIAssistView1.Size = new System.Drawing.Size(818, 457); - sfAIAssistView1.Dock= DockStyle.Fill; + sfAIAssistView1.Dock = DockStyle.Fill; this.Controls.Add(sfAIAssistView1); sfAIAssistView1.PromptRequest += AIAssistView_PromptRequest; @@ -49,10 +73,19 @@ public partial class Form1 : Form { var message = e.Message as TextMessage; if (message == null) return; - bool result = e.Handled; + + // Example: Mark the prompt as handled so the default processing is skipped + e.Handled = true; } } {% endhighlight %} -{% endtabs %} \ No newline at end of file +{% endtabs %} + +## Troubleshooting + +| Issue | Possible Cause | Resolution | +|-------|----------------|------------| +| `e.Message` is null at runtime | The bound `Messages` collection contains an item of an unexpected type. | Verify that the `Chats` collection is initialized with `TextMessage` (or other supported) items. | +| `Handled = true` does not prevent default behavior | The event is raised after the message has already been added to `Messages`. | Subscribe to `PromptRequest` before the user submits a prompt, and set `Handled` inside the handler. | \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Getting-Started.md b/WindowsForms/AI-AssistView/Getting-Started.md index a8ef82355..902c52e39 100644 --- a/WindowsForms/AI-AssistView/Getting-Started.md +++ b/WindowsForms/AI-AssistView/Getting-Started.md @@ -13,15 +13,15 @@ This section explains the steps required to add the Windows Forms [SfAIAssistVie ## Assembly Deployment -Refer [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sfaiassistview) section to get the list of assemblies or [NuGet package](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) needs to be added as reference to use the SfAIAssistView control in any application. +Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sfaiassistview) section to get the list of assemblies or [NuGet package](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) that needs to be added as a reference to use the SfAIAssistView control in any application. ## Creating Application with SfAIAssistView -In this walk through, users will create WinForms application that contains SfAIAssistView control. +In this walkthrough, users will create a WinForms application that contains the SfAIAssistView control. ### Creating the Project -Create new Windows Forms Project in Visual Studio to display SfAIAssistView. +Create a new Windows Forms Project in Visual Studio to display SfAIAssistView. ### Adding Control via Designer @@ -30,7 +30,7 @@ Windows Forms AI AssistView (SfAIAssistView) control can be added to the applica ### Adding Control in Code -In order to add control manually, do the below steps, +In order to add the control manually, do the following steps, 1. Add the required [assembly references](https://help.syncfusion.com/windowsforms/control-dependencies#sfaiassistview) to the project. @@ -68,6 +68,12 @@ Create a simple chat collection as shown in the following code example in a new {% tabs %} {% highlight c# %} +using System; +using System.Collections.ObjectModel; +using System.ComponentModel; +using System.Threading.Tasks; +using Syncfusion.WinForms.AIAssistView; + public class ViewModel : INotifyPropertyChanged { private ObservableCollection chats; @@ -81,9 +87,9 @@ public class ViewModel : INotifyPropertyChanged private async void GenerateMessages() { - this.Chats.Add( new TextMessage { Author = CurrentUser, Text = "What is Windows Forms?" } ); + this.Chats.Add( new TextMessage { Author = CurrentUser, Text = "What is Windows Forms?" }); await Task.Delay(1000); - this.Chats.Add( new TextMessage { Author = new Author { Name = "Bot" }, Text = " Windows Forms (also known as WinForms) is a graphical user interface (GUI) framework developed by Microsoft for building desktop applications for the Windows operating system " }); + this.Chats.Add( new TextMessage { Author = new Author { Name = "Bot" }, Text = "Windows Forms (also known as WinForms) is a graphical user interface (GUI) framework developed by Microsoft for building desktop applications for the Windows operating system." }); } public ObservableCollection Chats @@ -146,7 +152,7 @@ public partial class Form1 : Form SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); sfAIAssistView1.Location = new System.Drawing.Point(41, 40); sfAIAssistView1.Size = new System.Drawing.Size(818, 457); - sfAIAssistView1.Dock= DockStyle.Fill; + sfAIAssistView1.Dock = DockStyle.Fill; this.Controls.Add(sfAIAssistView1); sfAIAssistView1.DataBindings.Add("Messages", viewModel, "Chats", true, DataSourceUpdateMode.OnPropertyChanged); diff --git a/WindowsForms/AI-AssistView/Open-AI.md b/WindowsForms/AI-AssistView/Open-AI.md index 44ea10ade..a83f8580c 100644 --- a/WindowsForms/AI-AssistView/Open-AI.md +++ b/WindowsForms/AI-AssistView/Open-AI.md @@ -7,29 +7,43 @@ control: SfAIAssistView documentation: ug --- -# OpenAI connection for AI AssistView +# OpenAI Connection for AI AssistView -This section explains about how to connect the AI AssistView with OpenAI. +This section explains how to connect the AI AssistView with OpenAI. -## Creating an application with NuGet reference. + +## Creating an Application with NuGet Reference 1. Create a [Windows Forms app](https://learn.microsoft.com/en-us/visualstudio/ide/create-csharp-winform-visual-studio?view=visualstudio). -2. Add reference to [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet. +2. Add a reference to the [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet package. 3. Import the control namespace `Syncfusion.WinForms.AIAssistView` in C# code. 4. Initialize the [SfAIAssistView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control. -5. Add reference to [Microsoft Semantic NuGet](https://www.nuget.org/packages/Microsoft.SemanticKernel) NuGet. +5. Add a reference to the [Microsoft.SemanticKernel](https://www.nuget.org/packages/Microsoft.SemanticKernel) NuGet package. + +## Creating the OpenAI View Model Class -## Creating the OpenAI view model class. +The following configuration values are required to connect with OpenAI or Azure OpenAI: -To connect with OpenAI, we need the following details. -* OPENAI_KEY: A string variable where we should add our valid OpenAI API key. -* OPENAI_MODEL: A string variable representing the OpenAI language model we want to use. -* API_ENDPOINT: A string variable representing the URL endpoint of the OpenAI API. +- **OpenAIApiKey**: A string variable where you should add your valid OpenAI API key. +- **OpenAIModel**: A string variable representing the OpenAI language model you want to use. +- **ApiEndpoint**: A string variable representing the URL endpoint of the OpenAI API. For Azure OpenAI, this is the endpoint of your Azure OpenAI resource (the default value `https://openai.azure.com` is the Azure OpenAI endpoint, not the public OpenAI endpoint). + +> **Security Note:** Avoid storing API keys in source code in production. Use environment variables, `secrets.json`, or a secure key vault. {% tabs %} {% highlight c# %} +using System; +using System.Collections.ObjectModel; +using System.Collections.Specialized; +using System.ComponentModel; +using System.Drawing; +using System.Threading.Tasks; +using Microsoft.SemanticKernel; +using Microsoft.SemanticKernel.ChatCompletion; +using Syncfusion.WinForms.AIAssistView; + public class ViewModel : INotifyPropertyChanged { AIAssistChatService service; @@ -111,7 +125,7 @@ public class ViewModel : INotifyPropertyChanged service.Initialize(); } - private async void Chats_CollectionChanged(object sender, System.Collections.Specialized.NotifyCollectionChangedEventArgs e) + private async void Chats_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e) { var item = e.NewItems?[0] as TextMessage; if (item == null) return; @@ -137,9 +151,10 @@ public class ViewModel : INotifyPropertyChanged IChatCompletionService gpt; Kernel kernel; - private string OPENAI_KEY = "";// Add a valid OpenAI key here. - private string OPENAI_MODEL = "gpt-4o-mini"; - private string API_ENDPOINT = "https://openai.azure.com"; + // Add a valid OpenAI key here. Avoid committing this to source control. + private const string OpenAIApiKey = ""; + private const string OpenAIModel = "gpt-4o-mini"; + private const string ApiEndpoint = "https://openai.azure.com"; public string Response { get; set; } @@ -147,14 +162,13 @@ public class ViewModel : INotifyPropertyChanged { var builder = Kernel.CreateBuilder(); builder.AddAzureOpenAIChatCompletion( - deploymentName: OPENAI_MODEL, - apiKey: OPENAI_KEY, - endpoint: API_ENDPOINT + deploymentName: OpenAIModel, + apiKey: OpenAIApiKey, + endpoint: ApiEndpoint ); kernel = builder.Build(); gpt = kernel.GetRequiredService(); - } public async Task NonStreamingChat(string line) @@ -208,5 +222,14 @@ public partial class Form1 : Form ![WindowsForms AI AssistView control open ai](aiassistview_images/windowsforms_aiassistview_openai.gif) -N> You can also explore our [WinForms AIAssistView example demos](https://github.com/syncfusion/winforms-demos/tree/master/assistview) +N> You can also explore our [WinForms AIAssistView example demos](https://github.com/syncfusion/winforms-demos/tree/master/assistview). + +## Troubleshooting + +| Issue | Possible Cause | Resolution | +|-------|----------------|------------| +| `401 Unauthorized` from OpenAI | The API key is empty or invalid. | Verify `OpenAIApiKey` is set to a valid key from the OpenAI/Azure portal. | +| `Kernel` cannot be created | Missing `Microsoft.SemanticKernel` package reference. | Install the [Microsoft.SemanticKernel](https://www.nuget.org/packages/Microsoft.SemanticKernel) NuGet package. | +| No bot response is added to `Chats` | The submitted message's `Author.Name` does not match `CurrentUser.Name`. | Ensure the user is bound via `viewModel.CurrentUser = sfAIAssistView1.User;` so the comparison succeeds. | +| `Image.FromFile` throws `FileNotFoundException` | The bot avatar image is missing at the referenced path. | Add `AI_Assist.png` to the project's `Asset` folder. | diff --git a/WindowsForms/AI-AssistView/Overview.md b/WindowsForms/AI-AssistView/Overview.md index 57ed4f18c..c16261efc 100644 --- a/WindowsForms/AI-AssistView/Overview.md +++ b/WindowsForms/AI-AssistView/Overview.md @@ -9,11 +9,27 @@ documentation: ug # Overview of Windows Forms AI AssistView (SfAIAssistView) -The Syncfusion [Windows Forms AI AssistView](https://www.syncfusion.com/winforms-ui-controls/aiassistview) (SfAIAssistView) control is used to enhance interaction between users and AI services. It offers a user-friendly interface for creating intelligent and responsive applications with AI services, allowing users to customize the appearance easily. +The Syncfusion [Windows Forms AI AssistView](https://www.syncfusion.com/winforms-ui-controls/aiassistview) ([SfAIAssistView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html)) control is used to enhance interaction between users and AI services. It offers a user-friendly interface for creating intelligent and responsive applications with AI services. Users can easily customize its appearance. -## Key features +## Prerequisites -* **Suggestions**: Offers selectable response suggestions to expedite the flow of conversation. -* **Typing indicator** : Displays a loading indicator to represent asynchronous communication with AI services. -* **Banner customization**: The AI AssistView supports a customizable banner at the top, which allows users to display additional information, such as a welcome note, an introduction to integrated AI services, and more. -* **Theme**: AI AssistView supports both light and dark themes, allowing it to automatically adjust based on the system’s theme settings. This ensures a consistent and visually appealing experience for users in any environment. \ No newline at end of file +- **Required package:** [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet package (or the equivalent Syncfusion WinForms assemblies). See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for installation details. + +## Use Cases + +SfAIAssistView is well suited for: + +- AI chat assistants integrated into desktop applications. +- Customer support or help-desk conversational UIs. +- Productivity tools that require natural-language input and suggestions. + +## Key Features + +- **Suggestions**: Offers selectable response suggestions to expedite the flow of conversation. See [Suggestions](https://help.syncfusion.com/windowsforms/ai-assistview/suggestions). +- **Typing indicator**: Displays a loading indicator to represent asynchronous communication with AI services. See [Typing Indicator](https://help.syncfusion.com/windowsforms/ai-assistview/typing-indicator). +- **Banner customization**: The AI AssistView supports a customizable banner at the top, which allows users to display additional information such as a welcome note or an introduction to integrated AI services. See [Customization](https://help.syncfusion.com/windowsforms/ai-assistview/customization). +- **Theme**: AI AssistView supports both light and dark themes, allowing it to automatically adjust based on the system’s theme settings. This ensures a consistent and visually appealing experience for users in any environment. +- **Response toolbar**: Provides Copy, Regenerate, Like, Dislike, and custom action buttons for each bot response. See [Response Toolbar](https://help.syncfusion.com/windowsforms/ai-assistview/response-toolbar). +- **Stop responding**: Allows users to cancel an in-flight AI response. See [Stop Responding](https://help.syncfusion.com/windowsforms/ai-assistview/stop-responding). +- **OpenAI integration**: Connect to OpenAI or Azure OpenAI to power responses. See [OpenAI Integration](https://help.syncfusion.com/windowsforms/ai-assistview/open-ai). +- **Events**: Hook into `PromptRequest`, `ResponseToolBarItemClicked`, and `StopRespondingButtonClicked`. See [Events](https://help.syncfusion.com/windowsforms/ai-assistview/events). \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Response-ToolBar.md b/WindowsForms/AI-AssistView/Response-ToolBar.md index db9980557..7715c2b99 100644 --- a/WindowsForms/AI-AssistView/Response-ToolBar.md +++ b/WindowsForms/AI-AssistView/Response-ToolBar.md @@ -7,38 +7,68 @@ control: SfAIAssistView documentation: ug --- -# Response ToolBar in WinForms AI AssistView +# Response Toolbar in Windows Forms AI AssistView -The **SfAIAssistView** control includes a **Response Toolbar** feature that allows users to perform actions on bot responses by clicking action buttons. This feature provides an interactive way for users to engage with AI responses through copy, regenerate, like, and other custom actions. +The [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control includes a **Response Toolbar** feature that allows users to perform actions on bot responses by clicking action buttons. This feature provides an interactive way for users to engage with AI responses through copy, regenerate, like, and other custom actions. -By default, the **Response Toolbar** is not displayed. To enable it, set the **IsResponseToolBarVisible** property to `true`. +## Prerequisites + +- An `SfAIAssistView` instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. +- A `ViewModel` with a `Chats` collection bound to the control's `Messages` property. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started#bind-messages). +- A `TextMessage`-based message exists in the bound collection so that toolbar items can be retrieved or hidden. +- The following `using` directives are included in your file: + +{% tabs %} +{% highlight c# %} + +using System.Collections; +using System.Collections.ObjectModel; +using System.Linq; +using System.Windows.Forms; +using Syncfusion.WinForms.AIAssistView; + +{% endhighlight %} +{% endtabs %} + +## Enabling the Response Toolbar + +By default, the Response Toolbar is not displayed. To enable it, set the `IsResponseToolBarVisible` property to `true`. {% tabs %} {% highlight c# %} - SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); - sfAIAssistView1.IsResponseToolBarVisible = true; +SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); +sfAIAssistView1.IsResponseToolBarVisible = true; {% endhighlight %} {% endtabs %} -![WindowsForms AI AssistView control Response ToolBar](aiassistview_images/windowsforms_aiassistview_responsetoolbar.png) +![WindowsForms AI AssistView control Response Toolbar](aiassistview_images/windowsforms_aiassistview_responsetoolbar.png) ## Response Toolbar Items -The **Response Toolbar** supports the following action buttons: +The Response Toolbar supports the following action buttons: -- **Copy** - Copies the bot response text to clipboard -- **Regenerate** - Regenerates the response for the same prompt -- **Like** - Marks the response as helpful/liked -- **Dislike** - Marks the response as not helpful -- **Custom** - User-defined custom actions +| Item Type | Default Behavior | +|-----------|------------------| +| `Copy` | Copies the bot response text to the clipboard. | +| `Regenerate` | Regenerates the response for the same prompt. | +| `Like` | Marks the response as helpful/liked. | +| `Dislike` | Marks the response as not helpful. | +| `Custom` | User-defined custom actions. | ## Response Toolbar Item Click Event -The **SfAIAssistView** control provides the **ResponseToolBarItemClicked** event. This is triggered when a user clicks any toolbar action button. You can handle these actions to perform specific operations based on the toolbar item clicked. +The `SfAIAssistView` control provides the `ResponseToolBarItemClicked` event. This is triggered when a user clicks any toolbar action button. You can handle these actions to perform specific operations based on the toolbar item clicked. + +### Event Args + +`ResponseToolBarItemClickedEventArgs` exposes: + +- `ChatItem` — the `TextMessage` (or other `IChatItem`) being acted upon. +- `ToolBarItem` — the clicked `ResponseToolBarItem` with `ItemType`, `Name`, etc. ### Event Handler Code Example @@ -46,155 +76,145 @@ The **SfAIAssistView** control provides the **ResponseToolBarItemClicked** event {% highlight c# %} - sfAIAssistView1.ResponseToolBarItemClicked += sfAIAssistView1_ResponseToolBarItemClicked; +sfAIAssistView1.ResponseToolBarItemClicked += sfAIAssistView1_ResponseToolBarItemClicked; - private void sfAIAssistView1_ResponseToolBarItemClicked( - object sender, - ResponseToolBarItemClickedEventArgs e) +private void sfAIAssistView1_ResponseToolBarItemClicked( + object sender, + ResponseToolBarItemClickedEventArgs e) +{ + if (e.ToolBarItem?.ItemType == ResponseToolBarItemType.Copy) { - // Handle the toolbar item click - if (e.ToolBarItem.ItemType == ResponseToolBarItemType.Copy) - { - Clipboard.SetText(e.ChatItem.Text); - MessageBox.Show("Message copied to clipboard!"); - } - else if (e.ToolBarItem.ItemType == ResponseToolBarItemType.Regenerate) - { - MessageBox.Show("Regenerating response..."); - // Handle regeneration logic - } - else if (e.ToolBarItem.ItemType == ResponseToolBarItemType.Like) - { - MessageBox.Show("Response marked as helpful!"); - } + Clipboard.SetText(e.ChatItem?.Text); + MessageBox.Show("Message copied to clipboard."); } - + else if (e.ToolBarItem?.ItemType == ResponseToolBarItemType.Regenerate) + { + MessageBox.Show("Regenerating response."); + // Handle regeneration logic + } + else if (e.ToolBarItem?.ItemType == ResponseToolBarItemType.Like) + { + MessageBox.Show("Response marked as helpful."); + } +} {% endhighlight %} {% endtabs %} -The **ResponseToolBarItemClickedEventArgs** provides access to the **ChatItem** (the message being acted upon) and the **ToolBarItem** (the action button clicked). - ## Customization +The following sections describe how to customize toolbar visibility, retrieve toolbar items, configure the default set, and selectively hide buttons on older messages. + ### Controlling Toolbar Visibility -You can control the visibility of the entire toolbar or individual toolbar items: +You can control the visibility of the entire toolbar or individual toolbar items on a per-message basis: {% tabs %} {% highlight c# %} - - var messagesList = sfAIAssistView1.Messages as IList; - if(messagesList != null && messagesList.Count>0 ) - { - var message = messagesList[1] as TextMessage; - // Hide the entire toolbar for a specific message - sfAIAssistView1.SetToolBarVisibility(message, false); - - // Show the toolbar for a specific message - sfAIAssistView1.SetToolBarVisibility(message, true); - - // Hide a specific toolbar item for a message - sfAIAssistView1.SetToolBarItemVisibility( - message, - ResponseToolBarItemType.Regenerate.ToString(), - false); - - // Hide toolbar item by name - sfAIAssistView1.SetToolBarItemVisibility(message, "Copy", false); - } - +var messagesList = sfAIAssistView1.Messages as IList; +if (messagesList != null && messagesList.Count > 0) +{ + // The Response Toolbar is typically rendered on bot messages; + // adjust the index to target the specific message you need. + var message = messagesList[1] as TextMessage; + // Hide the entire toolbar for a specific message + sfAIAssistView1.SetToolBarVisibility(message, false); + + // Show the toolbar for a specific message + sfAIAssistView1.SetToolBarVisibility(message, true); + + // Hide a specific toolbar item for a message (by enum) + sfAIAssistView1.SetToolBarItemVisibility( + message, + ResponseToolBarItemType.Regenerate.ToString(), + false); + + // Hide toolbar item by name + sfAIAssistView1.SetToolBarItemVisibility(message, "Copy", false); +} {% endhighlight %} {% endtabs %} ### Getting Toolbar Items -Retrieve toolbar items from a message: +Retrieve toolbar items from a specific message: {% tabs %} {% highlight c# %} - - // Get a specific toolbar item - ResponseToolBarItem copyButton = sfAIAssistView1.GetToolBarItem( - message, - ResponseToolBarItemType.Copy.ToString()); - - if (copyButton != null) - { - // Use toolbar item properties - string itemName = copyButton.Name; - } - +ResponseToolBarItem copyButton = sfAIAssistView1.GetToolBarItem( + message, + ResponseToolBarItemType.Copy.ToString()); + +if (copyButton != null) +{ + string itemName = copyButton.Name; + // Use other properties on copyButton as needed +} {% endhighlight %} {% endtabs %} -### Configuring Toolbar Items +`GetToolBarItem` returns `null` when no matching item exists for the given message. -Set custom toolbar items in the control: +### Configuring Toolbar Items +Set custom toolbar items on the control. This replaces the default toolbar items with the specified collection. {% tabs %} {% highlight c# %} - - // Configure toolbar items - sfAIAssistView1.ResponseToolBarItems = new ObservableCollection - { - new ResponseToolBarItem - { - ItemType = ResponseToolBarItemType.Copy, - Name = "Copy" - }, - new ResponseToolBarItem - { - ItemType = ResponseToolBarItemType.Regenerate, - Name = "Regenerate" - }, - new ResponseToolBarItem - { - ItemType = ResponseToolBarItemType.Like, - Name = "Like" - } - }; - +sfAIAssistView1.ResponseToolBarItems = new ObservableCollection +{ + new ResponseToolBarItem { ItemType = ResponseToolBarItemType.Copy, Name = "Copy" }, + new ResponseToolBarItem { ItemType = ResponseToolBarItemType.Regenerate, Name = "Regenerate" }, + new ResponseToolBarItem { ItemType = ResponseToolBarItemType.Like, Name = "Like" } +}; {% endhighlight %} {% endtabs %} +### How to Hide the Regenerate Button for Old Messages -### How to hide Regenerate Button for Old Messages. +The following example hides the `Regenerate` toolbar item on every bot message except the most recent one: {% tabs %} {% highlight c# %} +private void UpdateToolbarForLatestMessage() +{ + var messages = (sfAIAssistView1.Messages as IList)? + .Cast().ToList(); + + if (messages == null) return; - private void UpdateToolbarForLatestMessage() + var botMessages = messages + .Where(m => m.Author?.Name == "Bot") + .ToList(); + + var latestMessage = botMessages.LastOrDefault(); + if (latestMessage == null) return; + + // Hide Regenerate on all old bot messages + foreach (var oldMessage in botMessages.Where(m => m != latestMessage)) { - var messages = (sfAIAssistView1.Messages as IList) - ?.Cast().ToList(); - - if (messages == null) return; - - var botMessages = messages - .Where(m => m.Author.Name == "Bot") - .ToList(); - - var latestMessage = botMessages.LastOrDefault(); - - // Hide Regenerate button on all old bot messages - foreach (var oldMessage in botMessages - .Where(m => m != latestMessage)) - { - sfAIAssistView1.SetToolBarItemVisibility( - oldMessage, - ResponseToolBarItemType.Regenerate.ToString(), - false); - } + sfAIAssistView1.SetToolBarItemVisibility( + oldMessage, + ResponseToolBarItemType.Regenerate.ToString(), + false); } - +} {% endhighlight %} {% endtabs %} + +Call `UpdateToolbarForLatestMessage` whenever a new bot response is added (for example, in the `Chats_CollectionChanged` handler used in the OpenAI integration). + +## Troubleshooting + +| Issue | Possible Cause | Resolution | +|-------|----------------|------------| +| `e.ToolBarItem` is `null` | The clicked item is not a known toolbar item, or the default items have been replaced. | Null-check `e.ToolBarItem` and ensure the item is registered in `ResponseToolBarItems`. | +| `GetToolBarItem` returns `null` | The message has no toolbar (e.g., user message) or the item name does not match. | Ensure the message is a bot response with the toolbar visible, and verify the item name. | +| `messagesList[1]` throws `ArgumentOutOfRangeException` | The `Messages` collection has fewer than 2 items. | Guard the index with a length check, as shown in the example. | \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Stop-Responding.md b/WindowsForms/AI-AssistView/Stop-Responding.md deleted file mode 100644 index 5f42b7c53..000000000 --- a/WindowsForms/AI-AssistView/Stop-Responding.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -layout: post -title: Stop Responding in Windows Forms AI AssistView control | Syncfusion -description: Learn about the Stop Responding feature in the AI AssistView control that allows users to cancel an ongoing AI response by clicking the Stop Responding button. -platform: windowsforms -control: SfAIAssistView -documentation: ug ---- - -# Stop Responding in WinForms AI AssistView - -The **SfAIAssistView** control includes a **Stop Responding** feature that allows users to cancel an ongoing AI response by clicking the **Stop Responding** button. This feature ensures that users can interrupt the response if it is no longer needed. - -By default, the **Stop Responding** button is not displayed. To enable it, set the EnableStopResponding property to `true`. - -{% tabs %} - -{% highlight c# %} - - SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); - sfAIAssistView1.EnableStopResponding = true; - -{% endhighlight %} - -{% endtabs %} -![WindowsForms AI AssistView control StopResponding](aiassistview_images/windowsforms_aiassistview_stopresponding.png) - -The button displays when EnableStopResponding is true. - -## Stop Responding Event - -The **SfAIAssistView** control provides the **StopRespondingButtonClicked** event. This is triggered when the **Stop Responding** button is clicked. You can handle this action to stop an ongoing AI response by subscribing to the **StopRespondingButtonClicked** event: - -{% tabs %} - -{% highlight c# %} - - sfAIAssistView1.StopRespondingButtonClicked += SfaiAssistView1_StopResponding; - - private void SfaiAssistView1_StopResponding(object sender, EventArgs e) - { - // Handle the Stop Responding action - CancelAIRequest(); - } - - private System.Threading.CancellationTokenSource cts; - public void CancelAIRequest() - { - if (cts != null && !cts.IsCancellationRequested) - cts.Cancel(); - } - -{% endhighlight %} - -{% endtabs %} -![WindowsForms AI AssistView control Cancel StopResponding](aiassistview_images/windowsforms_aiassistview_canceling.png) - -## Customization - -The button text and hold duration in **SfAIAssistView** can be customized using the **StopRespondingButtonText**, **StopRespondingButtonCancelingText**, and **StopRespondingHoldSeconds** properties. This allows you to set the button text, canceling text, and hold time for the **Stop Responding** button. - -{% tabs %} - -{% highlight c# %} - - // Set button text - sfAIAssistView1.StopRespondingButtonText = "⏹ Stop"; - - // Set canceling text (shown while canceling) - sfAIAssistView1.StopRespondingButtonCancelingText = "Stopping..."; - - // Set hold time (seconds button stays disabled after click) - sfAIAssistView1.StopRespondingHoldSeconds = 2; - -{% endhighlight %} - -{% endtabs %} -![WindowsForms AI AssistView control StopRespondingButtonText](aiassistview_images/windowsforms_aiassistview_stoprespondingtext.png) - diff --git a/WindowsForms/AI-AssistView/Suggestions.md b/WindowsForms/AI-AssistView/Suggestions.md index 0ebec21a3..991807706 100644 --- a/WindowsForms/AI-AssistView/Suggestions.md +++ b/WindowsForms/AI-AssistView/Suggestions.md @@ -9,99 +9,109 @@ documentation: ug # Suggestions in Windows Forms AI AssistView -By using the [Suggestions](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_Suggestions) property, the AssistView displays AI-driven suggestions in the bottom right corner, making it easy for users to quickly respond or choose from relevant options. +Use the [`Suggestions`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_Suggestions) property to display AI-driven suggestions in the bottom-right corner of the AssistView, so users can quickly respond or select from relevant options. + +## Prerequisites + +- **Required package:** [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet package. +- A `ViewModel` with `Chats`, `CurrentUser`, and `Suggestion` properties exists. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started#creating-viewmodel-for-ai-assistview) for setup details. +- The `Suggestion` collection is bound to the control's `Suggestions` property. The collection should be of a type that implements `INotifyCollectionChanged` (for example, `ObservableCollection`) so updates are reflected automatically. +- A bot avatar image is added to the project at `Asset\AI_Assist.png` (if the example is extended with one). + +## ViewModel + +The following `ViewModel` populates `Chats` with a sample conversation and updates the `Suggestion` collection once the bot response is added. The collection is mutated in place (via `Add`) so the bound `ObservableCollection` notifies the UI of the change: {% tabs %} {% highlight c# %} +using System; +using System.Collections.ObjectModel; +using System.ComponentModel; +using System.Threading.Tasks; +using Syncfusion.WinForms.AIAssistView; public class ViewModel : INotifyPropertyChanged { private ObservableCollection chats; private Author currentUser; - private IEnumerable suggestion; + private ObservableCollection suggestion; public ViewModel() { this.Chats = new ObservableCollection(); this.CurrentUser = new Author { Name = "John" }; - Suggestion = new ObservableCollection(); + this.Suggestion = new ObservableCollection(); this.GenerateMessages(); } - private async void GenerateMessages() + private async Task GenerateMessages() { this.Chats.Add(new TextMessage { Author = CurrentUser, Text = "What is Windows Forms?" }); await Task.Delay(1000); - this.Chats.Add(new TextMessage { Author = new Author { Name = "Bot"}, Text = "Windows Forms (also known as WinForms) is a graphical user interface (GUI) framework developed by Microsoft for building desktop applications for the Windows operating system." }); - Suggestion = new ObservableCollection { "What is the future of WinForms?", "How does WinForms handle UI rendering?" }; + this.Chats.Add(new TextMessage + { + Author = new Author { Name = "Bot" }, + Text = "Windows Forms (also known as WinForms) is a graphical user interface (GUI) framework developed by Microsoft for building desktop applications for the Windows operating system." + }); + + // Mutate the existing collection so the bound UI updates automatically + this.Suggestion.Add("What is the future of WinForms?"); + this.Suggestion.Add("How does WinForms handle UI rendering?"); } - public IEnumerable Suggestion + public ObservableCollection Suggestion { - get - { - return this.suggestion; - } + get { return this.suggestion; } set { this.suggestion = value; - RaisePropertyChanged("Suggestion"); + RaisePropertyChanged(nameof(Suggestion)); } } public ObservableCollection Chats { - get - { - return this.chats; - } + get { return this.chats; } set { this.chats = value; - RaisePropertyChanged("Chats"); + RaisePropertyChanged(nameof(Chats)); } } public Author CurrentUser { - get - { - return this.currentUser; - } + get { return this.currentUser; } set { this.currentUser = value; - RaisePropertyChanged("CurrentUser"); + RaisePropertyChanged(nameof(CurrentUser)); } } public void RaisePropertyChanged(string propName) { - if (PropertyChanged != null) - { - PropertyChanged(this, new PropertyChangedEventArgs(propName)); - } + PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propName)); } public event PropertyChangedEventHandler PropertyChanged; } - {% endhighlight %} {% endtabs %} -## Binding Suggestions +## Binding the Suggestions Property -The following code snippet shows how to bind the suggestion to your ViewModel. +Bind the control's `Suggestions` property to the `ViewModel.Suggestion` collection: {% tabs %} {% highlight c# %} - public partial class Form1 : Form { ViewModel viewModel; + public Form1() { InitializeComponent(); @@ -109,17 +119,44 @@ public partial class Form1 : Form SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); sfAIAssistView1.Location = new System.Drawing.Point(41, 40); - sfAIAssistView1.Size = new System.Drawing.Size(818, 457); - sfAIAssistView1.Dock= DockStyle.Fill; + sfAIAssistView1.Size = new System.Drawing.Size(818, 457); + sfAIAssistView1.Dock = DockStyle.Fill; this.Controls.Add(sfAIAssistView1); sfAIAssistView1.DataBindings.Add("Messages", viewModel, "Chats", true, DataSourceUpdateMode.OnPropertyChanged); sfAIAssistView1.DataBindings.Add("Suggestions", viewModel, "Suggestion", true, DataSourceUpdateMode.OnPropertyChanged); } } +{% endhighlight %} + +{% endtabs %} + +![WindowsForms AI AssistView control Suggestions](aiassistview_images/windowsforms_aiassistview_suggestions.png) + +## Handling Suggestion Clicks + +When a user clicks a suggestion, the text is sent as a new prompt. Handle the `PromptRequest` event (or `Chats_CollectionChanged`) to react to the selection: + +{% tabs %} + +{% highlight c# %} + +sfAIAssistView1.PromptRequest += (sender, e) => +{ + // e.Message contains the selected suggestion + var message = e.Message as TextMessage; + if (message == null) return; + // Process the prompt here, e.g., forward to your AI service +}; {% endhighlight %} {% endtabs %} -![WindowsForms AI AssistView control Suggestions](aiassistview_images/windowsforms_aiassistview_suggestions.png) \ No newline at end of file +## Troubleshooting + +| Issue | Possible Cause | Resolution | +|-------|----------------|------------| +| Suggestions are not displayed | `Suggestion` is reassigned to a new instance after the binding is created, breaking the binding. | Mutate the existing `ObservableCollection` (e.g., `Suggestion.Add(...)`) instead of replacing it. | +| Suggestions appear only once and then disappear | The collection is reassigned to a new empty instance. | Clear and refill the existing collection rather than reassigning. | +| `NullReferenceException` when iterating suggestions | The bound `Suggestion` is `null` at the time of binding. | Initialize the collection in the `ViewModel` constructor before binding. | \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Typing-Indicator.md b/WindowsForms/AI-AssistView/Typing-Indicator.md index b77bc2b45..886d5830b 100644 --- a/WindowsForms/AI-AssistView/Typing-Indicator.md +++ b/WindowsForms/AI-AssistView/Typing-Indicator.md @@ -9,14 +9,36 @@ documentation: ug # Typing Indicator in Windows Forms AI AssistView -By using the [TypingIndicator](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_TypingIndicator) property, a typing indicator is shown while the AI is processing or generating a response, giving users real-time feedback and enhancing conversational flow. +Use the [`TypingIndicator`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_TypingIndicator) property to show a typing indicator while the AI is processing or generating a response, giving users real-time feedback and enhancing conversational flow. -When the application runs, the TypingIndicator will show an animation representing the AI or user typing a message. This indicator is shown when the [ShowTypingIndicator](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_ShowTypingIndicator) property value as true. +The `TypingIndicator` shows an animation representing the AI or user typing a message. The indicator is shown when the [`ShowTypingIndicator`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_ShowTypingIndicator) property is set to `true`. + +## Prerequisites + +- **Required package:** [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet package. +- A `ViewModel` with `Chats`, `ShowTypingIndicator`, and `CurrentUser` properties exists. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. +- A bot avatar image is added to the project at `Asset\AI_Assist.png`. +- The following `using` directives are included in your file: {% tabs %} {% highlight c# %} +using System.ComponentModel; +using System.Drawing; +using System.Windows.Forms; +using Syncfusion.WinForms.AIAssistView; + +{% endhighlight %} + +{% endtabs %} + +## Configuring the Typing Indicator +The following example configures the typing indicator's avatar and display text, and binds the `ShowTypingIndicator` property to the `ViewModel`: + +{% tabs %} + +{% highlight c# %} public partial class Form1 : Form { ViewModel viewModel; @@ -28,8 +50,8 @@ public partial class Form1 : Form SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); sfAIAssistView1.Location = new System.Drawing.Point(41, 40); - sfAIAssistView1.Size = new System.Drawing.Size(818, 457); - sfAIAssistView1.Dock= DockStyle.Fill; + sfAIAssistView1.Size = new System.Drawing.Size(818, 457); + sfAIAssistView1.Dock = DockStyle.Fill; this.Controls.Add(sfAIAssistView1); sfAIAssistView1.DataBindings.Add("Messages", viewModel, "Chats", true, DataSourceUpdateMode.OnPropertyChanged); @@ -41,10 +63,16 @@ public partial class Form1 : Form sfAIAssistView1.TypingIndicator.DisplayText = "Typing"; } } - {% endhighlight %} {% endtabs %} ![WindowsForms AI AssistView control typing indicator](aiassistview_images/windowsforms_aiassistview_typing_indicator.gif) +## Troubleshooting + +| Issue | Possible Cause | Resolution | +|-------|----------------|------------| +| The indicator never appears | `ShowTypingIndicator` is not bound, or the bound property is not set to `true`. | Ensure `ShowTypingIndicator = true` is set in the `ViewModel` and the property is bound. | +| `FileNotFoundException` for `AI_Assist.png` | The bot avatar image is missing from the project. | Add `AI_Assist.png` to the project's `Asset` folder, or update the path. | +| The indicator shows the wrong avatar/name | `TypingIndicator.Author` is not set. | Assign an `Author` to `TypingIndicator.Author` before the control is shown. | \ No newline at end of file From 703227ece50196a58023b7645a404e368e0918fe Mon Sep 17 00:00:00 2001 From: Satheesh Tharma Prabbu Theivaraja Date: Tue, 14 Jul 2026 11:37:41 +0530 Subject: [PATCH 14/36] Update the missing file --- WindowsForms/AI-AssistView/Stop-Responding.md | 156 ++++++++++++++++++ 1 file changed, 156 insertions(+) create mode 100644 WindowsForms/AI-AssistView/Stop-Responding.md diff --git a/WindowsForms/AI-AssistView/Stop-Responding.md b/WindowsForms/AI-AssistView/Stop-Responding.md new file mode 100644 index 000000000..93cf67762 --- /dev/null +++ b/WindowsForms/AI-AssistView/Stop-Responding.md @@ -0,0 +1,156 @@ +--- +layout: post +title: Stop Responding in Windows Forms AI AssistView control | Syncfusion +description: Learn about the Stop Responding feature in the AI AssistView control that allows users to cancel an ongoing AI response by clicking the Stop Responding button. +platform: windowsforms +control: SfAIAssistView +documentation: ug +--- + +# Stop Responding in Windows Forms AI AssistView + +The [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control includes a **Stop Responding** feature that allows users to cancel an ongoing AI response by clicking the **Stop Responding** button. This feature ensures that users can interrupt the response if it is no longer needed. + +## Prerequisites + +- An `SfAIAssistView` instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. +- A `ViewModel` is bound to the control via the `Messages` property. See [OpenAI Integration](https://help.syncfusion.com/windowsforms/ai-assistview/open-ai) for a working example of an in-flight bot response that can be canceled. +- The following `using` directives are included in your file: + +{% tabs %} + +{% highlight c# %} +using System; +using System.Threading; +using System.Threading.Tasks; +using Syncfusion.WinForms.AIAssistView; +{% endhighlight %} + +{% endtabs %} + +## Enabling the Stop Responding Button + +By default, the Stop Responding button is not displayed. To enable it, set the `EnableStopResponding` property to `true`. + +{% tabs %} + +{% highlight c# %} + +SfAIAssistView sfAIAssistView1 = new SfAIAssistView(); +sfAIAssistView1.EnableStopResponding = true; +{% endhighlight %} + +{% endtabs %} + +![WindowsForms AI AssistView control StopResponding](aiassistview_images/windowsforms_aiassistview_stopresponding.png) + +The button is displayed when `EnableStopResponding` is set to `true`. + +## Stop Responding Event + +The `SfAIAssistView` control provides the `StopRespondingButtonClicked` event. This is triggered when the Stop Responding button is clicked. Use it to cancel any in-flight AI request: + +{% tabs %} + +{% highlight c# %} +sfAIAssistView1.StopRespondingButtonClicked += SfaiAssistView1_StopResponding; + +private void SfaiAssistView1_StopResponding(object sender, EventArgs e) +{ + CancelAIRequest(); +} + +private CancellationTokenSource cts; + +private void CancelAIRequest() +{ + if (cts != null && !cts.IsCancellationRequested) + { + cts.Cancel(); + cts.Dispose(); + cts = null; + } +} +{% endhighlight %} + +{% endtabs %} + +`CancellationTokenSource` is created and assigned to `cs` when an AI request is started, and the resulting token is passed into the AI service call. The event handler cancels that token when the user clicks Stop. + +### Wiring Cancellation into an AI Request + +{% tabs %} + +{% highlight c# %} + +private async void Chats_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e) +{ + if (e.NewItems == null || e.NewItems.Count == 0) return; + var item = e.NewItems[0] as TextMessage; + if (item == null) return; + if (item.Author?.Name != viewModel.CurrentUser?.Name) return; + + viewModel.ShowTypingIndicator = true; + cts = new CancellationTokenSource(); + + try + { + string response = await aiService.NonStreamingChatAsync(item.Text, cts.Token); + viewModel.Chats.Add(new TextMessage + { + Author = new Author { Name = "Bot" }, + Text = response + }); + } + catch (OperationCanceledException) + { + // User clicked Stop Responding; no response is added. + } + finally + { + viewModel.ShowTypingIndicator = false; + } +} +{% endhighlight %} + +{% endtabs %} + +![WindowsForms AI AssistView control Cancel StopResponding](aiassistview_images/windowsforms_aiassistview_canceling.png) + +## Customization + +The button text and the hold duration can be customized using the properties below. The Stop Responding button remains disabled for the configured hold time after it is clicked, preventing repeated cancellation requests. + +| Property | Description | Default | +|----------|-------------|---------| +| `StopRespondingButtonText` | Text shown on the button before cancellation. | `"Stop"` | +| `StopRespondingButtonCancelingText` | Text shown on the button while cancellation is in progress. | `"Canceling..."` | +| `StopRespondingHoldSeconds` | Number of seconds the button stays disabled after being clicked. | `0` | + +{% tabs %} + +{% highlight c# %} + +// Set button text +sfAIAssistView1.StopRespondingButtonText = "\u23F9 Stop"; + +// Set canceling text (shown while canceling) +sfAIAssistView1.StopRespondingButtonCancelingText = "Stopping..."; + +// Set hold time (seconds the button stays disabled after click) +sfAIAssistView1.StopRespondingHoldSeconds = 2; + +{% endhighlight %} + +{% endtabs %} + +![WindowsForms AI AssistView control StopRespondingButtonText](aiassistview_images/windowsforms_aiassistview_stoprespondingtext.png) + +## Troubleshooting + +| Issue | Possible Cause | Resolution | +|-------|----------------|------------| +| Clicking Stop does not cancel the request | The AI service call does not accept a `CancellationToken`. | Update the AI service to accept and observe a `CancellationToken` from `CancellationTokenSource`. | +| `NullReferenceException` when clicking Stop | `cs` was never assigned because the request was never started. | Guard the cancel call with a null check on `cs`, as shown in the example. | +| The button never appears | `EnableStopResponding` is `false` (default). | Set `sfAIAssistView1.EnableStopResponding = true;` before showing the form. | + From 1c4ace3fac999befa83c9af5b7d7ecce61464216 Mon Sep 17 00:00:00 2001 From: Deepak Raj Sundar Date: Mon, 13 Jul 2026 23:13:30 +0530 Subject: [PATCH 15/36] Added the release notes MD file and corresponding node entry in the TOC.html file --- WindowsForms-toc.html | 6 +- WindowsForms/Release-notes/v34.1.31.md | 91 ++++++++++++++++++++++++++ 2 files changed, 93 insertions(+), 4 deletions(-) create mode 100644 WindowsForms/Release-notes/v34.1.31.md diff --git a/WindowsForms-toc.html b/WindowsForms-toc.html index 8113852b9..1d335b587 100644 --- a/WindowsForms-toc.html +++ b/WindowsForms-toc.html @@ -1,8 +1,6 @@
    -
  • - API Reference -
    • +
  • Overview
    • @@ -6161,7 +6159,7 @@
  • Release Notes -
    • 2026 Volume 2 - v34.*
      • +
      • 2026 Volume 2 - v34.*
      • 2026 Volume 1 - v33.*
        • Weekly Nuget Release diff --git a/WindowsForms/Release-notes/v34.1.31.md b/WindowsForms/Release-notes/v34.1.31.md new file mode 100644 index 000000000..2c24f5e74 --- /dev/null +++ b/WindowsForms/Release-notes/v34.1.31.md @@ -0,0 +1,91 @@ +--- +title: Essential Studio® for Windows Forms Release Notes - v34.1.31 +description: Learn here about the controls in the Essential Studio® for Windows Forms Weekly Nuget Release - Release Notes - v34.1.31 +platform: windowsforms +documentation: ug +--- + +# Essential Studio® for Windows Forms - v34.1.31 Release Notes + +{% include release-info.html date="July 14, 2026" version="v34.1.31" passed="9683" failed="0" %} + +{% directory path: _includes/release-notes/v34.1.31 %} + +{% include {{file.url}} %} + +{% enddirectory %} + +## Test Results + +| Component Name | Test Cases | Passed | Failed | Remarks | +|----------------|------------|--------|--------|---------| +| AutoComplete | 59 | 59 | 0 | All Passed | +| AutoLabel | 3 | 3 | 0 | All Passed | +| Breadcrumb | 1 | 1 | 0 | All Passed | +| Button | 4 | 4 | 0 | All Passed | +| ButtonAdv | 3 | 3 | 0 | All Passed | +| Calendar | 1 | 1 | 0 | All Passed | +| Carousel | 7 | 7 | 0 | All Passed | +| Chart | 906 | 906 | 0 | All Passed | +| CheckBox | 134 | 134 | 0 | All Passed | +| Color Picker | 28 | 28 | 0 | All Passed | +| Color Picker DropDown | 3 | 3 | 0 | All Passed | +| ComboBox | 70 | 70 | 0 | All Passed | +| ComboBoxAdv | 339 | 339 | 0 | All Passed | +| ComboDropDown | 2 | 2 | 0 | All Passed | +| CommandBarController | 1 | 1 | 0 | All Passed | +| CurrencyEdit | 1 | 1 | 0 | All Passed | +| DataGrid | 943 | 943 | 0 | All Passed | +| DateTimePicker | 104 | 104 | 0 | All Passed | +| DateTimePickerAdv | 44 | 44 | 0 | All Passed | +| Digital Gauge | 7 | 7 | 0 | All Passed | +| Docking Manager | 1971 | 1971 | 0 | All Passed | +| DomainUpDownExt | 4 | 4 | 0 | All Passed | +| DoubleTextBox | 3 | 3 | 0 | All Passed | +| FontListBox | 2 | 2 | 0 | All Passed | +| Form | 23 | 23 | 0 | All Passed | +| Gradient Panel | 4 | 4 | 0 | All Passed | +| GroupView | 2 | 2 | 0 | All Passed | +| HTML Viewer | 53 | 53 | 0 | All Passed | +| Image Streamer | 1 | 1 | 0 | All Passed | +| Linear Gauge | 58 | 58 | 0 | All Passed | +| ListView | 65 | 65 | 0 | All Passed | +| Menu | 3 | 3 | 0 | All Passed | +| MessageBox | 2 | 2 | 0 | All Passed | +| Metro Form | 26 | 26 | 0 | All Passed | +| MonthCalendarAdv | 25 | 25 | 0 | All Passed | +| Multicolumn ComboBox | 8 | 8 | 0 | All Passed | +| Multicolumn TreeView | 104 | 104 | 0 | All Passed | +| Navigation Drawer | 52 | 52 | 0 | All Passed | +| Navigation Pane | 37 | 37 | 0 | All Passed | +| Numeric TextBox | 5 | 5 | 0 | All Passed | +| NumericUpdown | 6 | 6 | 0 | All Passed | +| Office 2007 Form | 61 | 61 | 0 | All Passed | +| PercentTextBox | 2 | 2 | 0 | All Passed | +| Pivot Chart | 124 | 124 | 0 | All Passed | +| Pivot Grid | 216 | 216 | 0 | All Passed | +| Popup | 4 | 4 | 0 | All Passed | +| Progress Bar | 4 | 4 | 0 | All Passed | +| Radial Gauge | 85 | 85 | 0 | All Passed | +| Radial Menu | 2 | 2 | 0 | All Passed | +| Radial Slider | 12 | 12 | 0 | All Passed | +| Range Slider | 7 | 7 | 0 | All Passed | +| Rating Control | 1 | 1 | 0 | All Passed | +| Ribbon | 1492 | 1492 | 0 | All Passed | +| Scroll Frame | 1 | 1 | 0 | All Passed | +| SfDataPager | 95 | 95 | 0 | All Passed | +| Spell Checker | 51 | 51 | 0 | All Passed | +| Splash Screen | 2 | 2 | 0 | All Passed | +| Split Button | 15 | 15 | 0 | All Passed | +| StatusStrip | 21 | 21 | 0 | All Passed | +| SuperToolTip | 1 | 1 | 0 | All Passed | +| Syntax Editor | 534 | 534 | 0 | All Passed | +| Tabbed Form | 25 | 25 | 0 | All Passed | +| TabbedMdiManager | 481 | 481 | 0 | All Passed | +| TabControl | 729 | 729 | 0 | All Passed | +| TextBox | 13 | 13 | 0 | All Passed | +| ToolBar | 5 | 5 | 0 | All Passed | +| TrackBar | 1 | 1 | 0 | All Passed | +| Tree Navigator | 17 | 17 | 0 | All Passed | +| TreeView | 474 | 474 | 0 | All Passed | +| XpTaskbar | 94 | 94 | 0 | All Passed | \ No newline at end of file From 022414f5a059350c46f047eb64ff063268ceade0 Mon Sep 17 00:00:00 2001 From: SrikanthSF4944 Date: Tue, 14 Jul 2026 16:40:04 +0530 Subject: [PATCH 16/36] Task 1040793: Update Class and Property Hyperlinks in Vol 2 2026 Release Documents. --- .../AI-AssistView/Response-ToolBar.md | 40 +++++++++---------- WindowsForms/AI-AssistView/Stop-Responding.md | 14 +++---- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/WindowsForms/AI-AssistView/Response-ToolBar.md b/WindowsForms/AI-AssistView/Response-ToolBar.md index 7715c2b99..95e8a3401 100644 --- a/WindowsForms/AI-AssistView/Response-ToolBar.md +++ b/WindowsForms/AI-AssistView/Response-ToolBar.md @@ -9,13 +9,13 @@ documentation: ug # Response Toolbar in Windows Forms AI AssistView -The [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control includes a **Response Toolbar** feature that allows users to perform actions on bot responses by clicking action buttons. This feature provides an interactive way for users to engage with AI responses through copy, regenerate, like, and other custom actions. +The [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control includes a **Response Toolbar** feature that allows users to perform actions on bot responses by clicking action buttons. This feature provides an interactive way for users to engage with AI responses through **copy**, **regenerate**, **like**, and other **custom** actions. ## Prerequisites -- An `SfAIAssistView` instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. -- A `ViewModel` with a `Chats` collection bound to the control's `Messages` property. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started#bind-messages). -- A `TextMessage`-based message exists in the bound collection so that toolbar items can be retrieved or hidden. +- An [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. +- A **ViewModel** with a **Chats** collection bound to the control's [`Messages`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_Messages) property. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started#bind-messages). +- A [`TextMessage`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.TextMessage.html)-based message exists in the bound collection so that toolbar items can be retrieved or hidden. - The following `using` directives are included in your file: {% tabs %} @@ -32,7 +32,7 @@ using Syncfusion.WinForms.AIAssistView; ## Enabling the Response Toolbar -By default, the Response Toolbar is not displayed. To enable it, set the `IsResponseToolBarVisible` property to `true`. +By default, the Response Toolbar is not displayed. To enable it, set the [`IsResponseToolBarVisible`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_IsResponseToolBarVisible) property to **`true`**. {% tabs %} @@ -49,26 +49,26 @@ sfAIAssistView1.IsResponseToolBarVisible = true; ## Response Toolbar Items -The Response Toolbar supports the following action buttons: +The Response Toolbar supports the following action buttons, each represented by a value of the [`ResponseToolBarItemType`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.ResponseToolBarItemType.html) enumeration: | Item Type | Default Behavior | |-----------|------------------| -| `Copy` | Copies the bot response text to the clipboard. | -| `Regenerate` | Regenerates the response for the same prompt. | -| `Like` | Marks the response as helpful/liked. | -| `Dislike` | Marks the response as not helpful. | -| `Custom` | User-defined custom actions. | +| **`Copy`** | Copies the bot response text to the clipboard. | +| **`Regenerate`** | Regenerates the response for the same prompt. | +| **`Like`** | Marks the response as helpful/liked. | +| **`Dislike`** | Marks the response as not helpful. | +| **`Custom`** | User-defined custom actions. | ## Response Toolbar Item Click Event -The `SfAIAssistView` control provides the `ResponseToolBarItemClicked` event. This is triggered when a user clicks any toolbar action button. You can handle these actions to perform specific operations based on the toolbar item clicked. +The [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control provides the [`ResponseToolBarItemClicked`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_ResponseToolBarItemClicked) event. This is triggered when a user clicks any toolbar action button. You can handle these actions to perform specific operations based on the toolbar item clicked. ### Event Args -`ResponseToolBarItemClickedEventArgs` exposes: +[`ResponseToolBarItemClickedEventArgs`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.ResponseToolBarItemClickedEventArgs.html) exposes: -- `ChatItem` — the `TextMessage` (or other `IChatItem`) being acted upon. -- `ToolBarItem` — the clicked `ResponseToolBarItem` with `ItemType`, `Name`, etc. +- **`ChatItem`** — the [`TextMessage`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.TextMessage.html) (or other `IChatItem`) being acted upon. +- **`ToolBarItem`** — the clicked [`ResponseToolBarItem`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.ResponseToolBarItem.html) with **`ItemType`**, **`Name`**, etc. ### Event Handler Code Example @@ -139,7 +139,7 @@ if (messagesList != null && messagesList.Count > 0) ### Getting Toolbar Items -Retrieve toolbar items from a specific message: +Retrieve toolbar items from a specific message using the [`GetToolBarItem`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_GetToolBarItem_Syncfusion_WinForms_AIAssistView_TextMessage_System_String_) method: {% tabs %} @@ -157,11 +157,11 @@ if (copyButton != null) {% endtabs %} -`GetToolBarItem` returns `null` when no matching item exists for the given message. +[`GetToolBarItem`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_GetToolBarItem_Syncfusion_WinForms_AIAssistView_TextMessage_System_String_) returns **`null`** when no matching item exists for the given message. ### Configuring Toolbar Items -Set custom toolbar items on the control. This replaces the default toolbar items with the specified collection. +Set custom toolbar items on the control using the [`ResponseToolBarItems`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_ResponseToolBarItems) property. This replaces the default toolbar items with the specified collection of [`ResponseToolBarItem`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.ResponseToolBarItem.html) objects. {% tabs %} {% highlight c# %} @@ -177,7 +177,7 @@ sfAIAssistView1.ResponseToolBarItems = new ObservableCollection Date: Wed, 15 Jul 2026 11:20:27 +0530 Subject: [PATCH 17/36] 1039182 - Addressed review concerns for winforms-docs --- WindowsForms/Docking-Manager/Dock-Window.md | 4 ++-- WindowsForms/Docking-Manager/MDI-Window.md | 4 ++-- WindowsForms/Ribbon/Ribbon-Form.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/WindowsForms/Docking-Manager/Dock-Window.md b/WindowsForms/Docking-Manager/Dock-Window.md index 5ebff8c50..9c94347de 100644 --- a/WindowsForms/Docking-Manager/Dock-Window.md +++ b/WindowsForms/Docking-Manager/Dock-Window.md @@ -228,7 +228,7 @@ This overloaded function returns the index of image associated with the docking {% highlight C# %} -System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(@"..\\..\\\$this.Icon.ico")); +System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(GetIconFile(@"..\\..\\\$this.Icon.ico"))); private string GetIconFile(string bitmapName) { @@ -252,7 +252,7 @@ this.dockingManager1.SetDockIcon(this.panel1, icon); {% highlight VB %} -Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile("..\\..\\\$this.Icon.ico")) +Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile(GetIconFile("..\\..\\\$this.Icon.ico"))) Private Function GetIconFile(ByVal bitmapName As String) As String diff --git a/WindowsForms/Docking-Manager/MDI-Window.md b/WindowsForms/Docking-Manager/MDI-Window.md index df3db82cf..30f9bc7cc 100644 --- a/WindowsForms/Docking-Manager/MDI-Window.md +++ b/WindowsForms/Docking-Manager/MDI-Window.md @@ -115,7 +115,7 @@ C:\Users\<User>\AppData\Local\Syncfusion\EssentialStudio\Version Number\Wi {% highlight C# %} -System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(@"..\\..\\\$this.Icon.ico")); +System.Drawing.Icon icon = new System.Drawing.Icon(GetIconFile(GetIconFile(@"..\\..\\\$this.Icon.ico"))); //To set icon in MDI Child window this.dockingManager1.SetMDIChildIcon(panel2, icon); @@ -141,7 +141,7 @@ private string GetIconFile(string bitmapName) {% highlight VB %} -Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile("..\\..\\\$this.Icon.ico")) +Dim icon As System.Drawing.Icon = New System.Drawing.Icon(GetIconFile(GetIconFile("..\\..\\\$this.Icon.ico"))) 'To set icon in MDI Child window Me.dockingManager1.SetMDIChildIcon(panel2, icon) diff --git a/WindowsForms/Ribbon/Ribbon-Form.md b/WindowsForms/Ribbon/Ribbon-Form.md index ab4efbd85..8b647120f 100644 --- a/WindowsForms/Ribbon/Ribbon-Form.md +++ b/WindowsForms/Ribbon/Ribbon-Form.md @@ -9,7 +9,7 @@ documentation: ug # Ribbon Form in Windows Forms Ribbon (RibbonControlAdv) -`RibbonForm` is an extension that replaces the default form to enable different Visual styles to the ribbon. It gives its controls a look and feel similar to Microsoft Office. +`RibbonForm` is an extension of the standard form that enables different visual styles for the ribbon and gives its controls a look and feel similar to Microsoft Office. ## Appearance Settings From 9ee80f64b7207554bb43183992a3e3fdf34e7387 Mon Sep 17 00:00:00 2001 From: Usha4947 Date: Wed, 15 Jul 2026 12:44:45 +0530 Subject: [PATCH 18/36] Addressed the review concerns --- WindowsForms/Form/Localization.md | 4 ++-- WindowsForms/treeview/Overview.md | 26 +++++++++++--------------- 2 files changed, 13 insertions(+), 17 deletions(-) diff --git a/WindowsForms/Form/Localization.md b/WindowsForms/Form/Localization.md index 4cdaf6ecb..19eadb352 100644 --- a/WindowsForms/Form/Localization.md +++ b/WindowsForms/Form/Localization.md @@ -15,7 +15,7 @@ To localize the SfForm based on `CurrentUICulture` using resource files, follow 1. Create a new folder and name it **Resources** in your application. -2. Add the default resource file of SfForm into the **Resources** folder. You can download the `Syncfusion.Shared.Base.resx` from the [Syncfusion localization repository](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). +2. Add the default resource file of SfForm into the **Resources** folder. You can download the `Syncfusion.Shared.Base.resx` from the [GitHub](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). ![Added default resource file of winforms sfform shown in solution explorer](Localization_images/Localization_img1.png) @@ -60,7 +60,7 @@ End Sub ![Winforms sfform localized with modified resources](Localization_images/Localization_img5.png) ## Editing Default Resource File -The default resource file can be edited by adding it to the **Resources** folder of the application, which is where SfForm reads the static texts from. The default resource file can be downloaded from the [Syncfusion localization repository](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). +The default resource file can be edited by adding it to the **Resources** folder of the application, which is where SfForm reads the static texts from. The default resource file can be downloaded from the [GitHub](https://github.com/syncfusion/winforms-controls-localization-resx-files/blob/master/Syncfusion.Shared.Base/Syncfusion.Shared.Base.resx). ![Added default resource file of winforms sfform shown in solution explorer](Localization_images/Localization_img6.png) diff --git a/WindowsForms/treeview/Overview.md b/WindowsForms/treeview/Overview.md index f8b9c454b..bdb829fcb 100644 --- a/WindowsForms/treeview/Overview.md +++ b/WindowsForms/treeview/Overview.md @@ -9,34 +9,30 @@ documentation: ug # Windows Forms TreeView Overview -[WinForms TreeView control](https://www.syncfusion.com/winforms-ui-controls/treeview) displays a collection of data in a hierarchical tree structure, and the data in the TreeViewAdv can be expanded and collapsed. The TreeViewAdv offers many advanced features like drag-and-drop, load on demand, context menus, and data binding that can make the control unique and extraordinary. While the [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) exposes some global styles that are to be applied for all the nodes, the [TreeNodeAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html) lets the users specify styles for a specific node. The control comes with complete design-time support. +[WinForms TreeView control](https://www.syncfusion.com/winforms-ui-controls/treeview) displays a collection of data in hierarchical tree structure and the data in tree view can be expanded and collapsed. [TreeViewAdv](https://help.syncfusion.com/windowsforms/treeview/overview) offers many advanced features like drag-and-drop, load on demand, context menus and data binding that can make the control unique and extraordinary. While the [TreeViewAdv](https://help.syncfusion.com/windowsforms/treeview/overview) exposes some global styles that are to be applied for all the nodes, the [TreeNodeAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html) lets the users to specify styles for a specific node. The control comes with complete design time support. ![Overview of Syncfusion TreeViewAdv](Overview_images/Overview_img1.jpg) ## Key Features -* [Enabling enhanced performance by Virtualization support](performance) +* Enabling enhanced performance by Virtualization support -* [Data binding support](data-binding). +* Data binding support. -* [Select multiple items using the CTRL + SHIFT keys](runtime-features#scrolling). +* Select multiple items using the CTRL+ SHIFT keys. -* Provides support for [advanced drag and drop of the nodes](drag-and-drop). +* Provides support for advanced drag and drop of the nodes. -* [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) can associate the [context menus](runtime-features#context-menu) with the option to show and hide wherever necessary. +* [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) can associate the context menus with the option to show and hide wherever necessary -* Provides [automatic scrolling support](scrollbar-customization) for the TreeViewAdv. +* Provides automatic scrolling support for the TreeViewAdv -* [Customize the complete look and feel of the control](treeview-appearance). +* Customize the complete look and feel of the control. -* [Sort TreeViewAdv items at run time](sorting). +* Sort [TreeViewAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeViewAdv.html) items at run time. -* [Add images to expanded and collapsed states of TreeViewAdv](treenode-features#expand-and-collapse-image). +* Add images to expanded and collapsed states of TreeViewAdv. -* [Add images as left, right, and state image sources to the TreeNodeAdv](treenode-features#node-images). +* Add images as left, right and state image sources to the [TreeNodeAdv](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdv.html). N> You can also explore our [WinForms TreeView example](https://github.com/syncfusion/winforms-demos/tree/master/treeview) that shows you how to render and configure the TreeView. - -## Compatibility - -The WinForms TreeViewAdv control is compatible with applications targeting .NET Framework 4.5 and above as well as .NET (Core) 3.1 / 6.0 / 7.0 / 8.0+ and is shipped as part of the Syncfusion Essential Studio WinForms suite. From 7e181c4a4d5c55008acb8d070feddb7b42941380 Mon Sep 17 00:00:00 2001 From: Usha4947 Date: Wed, 15 Jul 2026 13:11:01 +0530 Subject: [PATCH 19/36] Addressed the review concerns --- WindowsForms/treeview/TreeNodeAdvCustomization.md | 6 +++--- WindowsForms/treeview/TreeView-Appearance.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/WindowsForms/treeview/TreeNodeAdvCustomization.md b/WindowsForms/treeview/TreeNodeAdvCustomization.md index eb102fd98..2b2135fee 100644 --- a/WindowsForms/treeview/TreeNodeAdvCustomization.md +++ b/WindowsForms/treeview/TreeNodeAdvCustomization.md @@ -189,15 +189,15 @@ Property
 Description
-OptionButtonHoverBackColor +{{'[OptionButtonHoverBackColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdvStyleInfo_OptionButtonHoverBackColor)'|markdownify }} Used to customize the hover background of the option button.
-OptionButtonHoverBorderColor +{{'[OptionButtonHoverBorderColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdvStyleInfo_OptionButtonHoverBorderColor)'|markdownify }} Used to customize the hover border of the option button.
-OptionButtonHoverColor +{{'[OptionButtonHoverColor](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo.html#Syncfusion_Windows_Forms_Tools_TreeNodeAdvStyleInfo_OptionButtonHoverColor)'|markdownify }} Used to customize the checked hover of the option button.
diff --git a/WindowsForms/treeview/TreeView-Appearance.md b/WindowsForms/treeview/TreeView-Appearance.md index db17a31d4..18caf918d 100644 --- a/WindowsForms/treeview/TreeView-Appearance.md +++ b/WindowsForms/treeview/TreeView-Appearance.md @@ -258,12 +258,12 @@ ForeColor		 Specifies the text color of the nodes.
-TreeNodeAdv Property Table +TreeViewAdv Property Table +Sets the border style for the Treeview control.{{ '_FixedSingle_' | markdownify }} - a normal border,{{ '_Fixed3D_' | markdownify }} - 3D appearance.
-TreeNodeAdv Properties +Properties Description
@@ -411,7 +411,7 @@ Description
BorderStyle -Sets the border style for the TreeView control. Options are: FixedSingle (a normal border) or Fixed3D (3D appearance).
Border3DStyle @@ -424,7 +424,7 @@ Indicates the style of the 3D border when BorderStyle is set to Fixed3D. Options
  • Raised
  • Etched
  • Bump
    • -
  • Sunken (Default)
    • +
  • Sunken
  • Adjust
  • Flat
    • From 4bdfd66eecb4a8ca460996b61ea2eeb27e80157f Mon Sep 17 00:00:00 2001 From: Satheesh Tharma Prabbu Theivaraja Date: Wed, 15 Jul 2026 16:17:22 +0530 Subject: [PATCH 20/36] Remove Prerequisites and Troubleshooting --- WindowsForms/AI-AssistView/Customization.md | 10 ++--- WindowsForms/AI-AssistView/Events.md | 19 ++------ WindowsForms/AI-AssistView/Open-AI.md | 14 +----- WindowsForms/AI-AssistView/Overview.md | 4 -- .../AI-AssistView/Response-ToolBar.md | 19 ++------ WindowsForms/AI-AssistView/Stop-Responding.md | 41 +++++++---------- WindowsForms/AI-AssistView/Suggestions.md | 44 +++++++++---------- .../AI-AssistView/Typing-Indicator.md | 19 ++------ 8 files changed, 53 insertions(+), 117 deletions(-) diff --git a/WindowsForms/AI-AssistView/Customization.md b/WindowsForms/AI-AssistView/Customization.md index e2405458e..ec70c8c43 100644 --- a/WindowsForms/AI-AssistView/Customization.md +++ b/WindowsForms/AI-AssistView/Customization.md @@ -13,13 +13,7 @@ This section explains how to customize the BannerView, and how to create a custo N> You can also explore our [sample](https://github.com/SyncfusionExamples/How-to-Customize-BannerView-and-Create-a-Custom-BotView-and-UserView-in-AIAssistView) on GitHub, which demonstrates complete customization of the BannerView, the creation of a custom BotView, and a custom UserView within an AssistView. -## Prerequisites - -Before proceeding, ensure the following are in place: - -- A `ViewModel` class with a `Chats` collection, `ShowTypingIndicator`, `Suggestion`, and `CurrentUser` properties exists. Refer to the [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) page for setup details. -- A banner image is added to the project at the path referenced in code (for example, `Asset\AI_Assist.png`). -- The following `using` directives are included in your file: +The following `using` directives are included in your file: {% tabs %} {% highlight c# %} @@ -34,6 +28,8 @@ using Syncfusion.WinForms.AIAssistView; {% endhighlight %} {% endtabs %} +N> A `ViewModel` class with a `Chats` collection and `CurrentUser` properties exists. Refer to the [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) page for setup details. + ## Customizing BannerView You can customize the BannerView and apply it to the AssistView by using the [SetBannerView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_SetBannerView_System_String_System_String_System_Drawing_Image_Syncfusion_WinForms_AIAssistView_BannerStyle_) method. diff --git a/WindowsForms/AI-AssistView/Events.md b/WindowsForms/AI-AssistView/Events.md index 1e42244d7..e20fb10cb 100644 --- a/WindowsForms/AI-AssistView/Events.md +++ b/WindowsForms/AI-AssistView/Events.md @@ -15,13 +15,7 @@ The following events are supported by the [SfAIAssistView](https://help.syncfusi |-------|-------------| | [PromptRequest](#promptrequest-event) | Notifies when a prompt is submitted in the control. | -## Prerequisites - -Before proceeding, ensure the following are in place: - -- A `ViewModel` class with a `Chats` collection, `ShowTypingIndicator`, `Suggestion`, and `CurrentUser` properties exists. Refer to the [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) page for setup details. -- A bot avatar image is added to the project at the path referenced in code (for example, `Asset\AI_Assist.png`). -- The following `using` directives are included in your file: +The following `using` directives are included in your file: {% tabs %} {% highlight c# %} @@ -33,6 +27,8 @@ using Syncfusion.WinForms.AIAssistView; {% endhighlight %} {% endtabs %} +N> A `ViewModel` class with a `Chats` collection and `CurrentUser` properties exists. Refer to the [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) page for setup details. + ## PromptRequest event [PromptRequest](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_PromptRequest) event notifies users when a prompt is submitted in the control. It can be used to validate user input before processing or trigger custom actions based on the prompt content. The input message and its details are passed through the [PromptRequestEventArgs](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.PromptRequestEventArgs.html). This argument provides the following details: @@ -81,11 +77,4 @@ public partial class Form1 : Form {% endhighlight %} -{% endtabs %} - -## Troubleshooting - -| Issue | Possible Cause | Resolution | -|-------|----------------|------------| -| `e.Message` is null at runtime | The bound `Messages` collection contains an item of an unexpected type. | Verify that the `Chats` collection is initialized with `TextMessage` (or other supported) items. | -| `Handled = true` does not prevent default behavior | The event is raised after the message has already been added to `Messages`. | Subscribe to `PromptRequest` before the user submits a prompt, and set `Handled` inside the handler. | \ No newline at end of file +{% endtabs %} \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Open-AI.md b/WindowsForms/AI-AssistView/Open-AI.md index a83f8580c..8b917b9e2 100644 --- a/WindowsForms/AI-AssistView/Open-AI.md +++ b/WindowsForms/AI-AssistView/Open-AI.md @@ -28,8 +28,6 @@ The following configuration values are required to connect with OpenAI or Azure - **OpenAIModel**: A string variable representing the OpenAI language model you want to use. - **ApiEndpoint**: A string variable representing the URL endpoint of the OpenAI API. For Azure OpenAI, this is the endpoint of your Azure OpenAI resource (the default value `https://openai.azure.com` is the Azure OpenAI endpoint, not the public OpenAI endpoint). -> **Security Note:** Avoid storing API keys in source code in production. Use environment variables, `secrets.json`, or a secure key vault. - {% tabs %} {% highlight c# %} @@ -222,14 +220,4 @@ public partial class Form1 : Form ![WindowsForms AI AssistView control open ai](aiassistview_images/windowsforms_aiassistview_openai.gif) -N> You can also explore our [WinForms AIAssistView example demos](https://github.com/syncfusion/winforms-demos/tree/master/assistview). - -## Troubleshooting - -| Issue | Possible Cause | Resolution | -|-------|----------------|------------| -| `401 Unauthorized` from OpenAI | The API key is empty or invalid. | Verify `OpenAIApiKey` is set to a valid key from the OpenAI/Azure portal. | -| `Kernel` cannot be created | Missing `Microsoft.SemanticKernel` package reference. | Install the [Microsoft.SemanticKernel](https://www.nuget.org/packages/Microsoft.SemanticKernel) NuGet package. | -| No bot response is added to `Chats` | The submitted message's `Author.Name` does not match `CurrentUser.Name`. | Ensure the user is bound via `viewModel.CurrentUser = sfAIAssistView1.User;` so the comparison succeeds. | -| `Image.FromFile` throws `FileNotFoundException` | The bot avatar image is missing at the referenced path. | Add `AI_Assist.png` to the project's `Asset` folder. | - +N> You can also explore our [WinForms AIAssistView example demos](https://github.com/syncfusion/winforms-demos/tree/master/assistview). \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Overview.md b/WindowsForms/AI-AssistView/Overview.md index c16261efc..6695f8893 100644 --- a/WindowsForms/AI-AssistView/Overview.md +++ b/WindowsForms/AI-AssistView/Overview.md @@ -11,10 +11,6 @@ documentation: ug The Syncfusion [Windows Forms AI AssistView](https://www.syncfusion.com/winforms-ui-controls/aiassistview) ([SfAIAssistView](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html)) control is used to enhance interaction between users and AI services. It offers a user-friendly interface for creating intelligent and responsive applications with AI services. Users can easily customize its appearance. -## Prerequisites - -- **Required package:** [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet package (or the equivalent Syncfusion WinForms assemblies). See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for installation details. - ## Use Cases SfAIAssistView is well suited for: diff --git a/WindowsForms/AI-AssistView/Response-ToolBar.md b/WindowsForms/AI-AssistView/Response-ToolBar.md index 7715c2b99..3b8c1d9a2 100644 --- a/WindowsForms/AI-AssistView/Response-ToolBar.md +++ b/WindowsForms/AI-AssistView/Response-ToolBar.md @@ -11,12 +11,7 @@ documentation: ug The [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control includes a **Response Toolbar** feature that allows users to perform actions on bot responses by clicking action buttons. This feature provides an interactive way for users to engage with AI responses through copy, regenerate, like, and other custom actions. -## Prerequisites - -- An `SfAIAssistView` instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. -- A `ViewModel` with a `Chats` collection bound to the control's `Messages` property. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started#bind-messages). -- A `TextMessage`-based message exists in the bound collection so that toolbar items can be retrieved or hidden. -- The following `using` directives are included in your file: +The following `using` directives are included in your file: {% tabs %} {% highlight c# %} @@ -30,6 +25,8 @@ using Syncfusion.WinForms.AIAssistView; {% endhighlight %} {% endtabs %} +N> An `SfAIAssistView` instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. + ## Enabling the Response Toolbar By default, the Response Toolbar is not displayed. To enable it, set the `IsResponseToolBarVisible` property to `true`. @@ -209,12 +206,4 @@ private void UpdateToolbarForLatestMessage() {% endtabs %} -Call `UpdateToolbarForLatestMessage` whenever a new bot response is added (for example, in the `Chats_CollectionChanged` handler used in the OpenAI integration). - -## Troubleshooting - -| Issue | Possible Cause | Resolution | -|-------|----------------|------------| -| `e.ToolBarItem` is `null` | The clicked item is not a known toolbar item, or the default items have been replaced. | Null-check `e.ToolBarItem` and ensure the item is registered in `ResponseToolBarItems`. | -| `GetToolBarItem` returns `null` | The message has no toolbar (e.g., user message) or the item name does not match. | Ensure the message is a bot response with the toolbar visible, and verify the item name. | -| `messagesList[1]` throws `ArgumentOutOfRangeException` | The `Messages` collection has fewer than 2 items. | Guard the index with a length check, as shown in the example. | \ No newline at end of file +Call `UpdateToolbarForLatestMessage` whenever a new bot response is added (for example, in the `Chats_CollectionChanged` handler used in the OpenAI integration). \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Stop-Responding.md b/WindowsForms/AI-AssistView/Stop-Responding.md index 93cf67762..e2d8bbf28 100644 --- a/WindowsForms/AI-AssistView/Stop-Responding.md +++ b/WindowsForms/AI-AssistView/Stop-Responding.md @@ -11,11 +11,7 @@ documentation: ug The [`SfAIAssistView`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html) control includes a **Stop Responding** feature that allows users to cancel an ongoing AI response by clicking the **Stop Responding** button. This feature ensures that users can interrupt the response if it is no longer needed. -## Prerequisites - -- An `SfAIAssistView` instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. -- A `ViewModel` is bound to the control via the `Messages` property. See [OpenAI Integration](https://help.syncfusion.com/windowsforms/ai-assistview/open-ai) for a working example of an in-flight bot response that can be canceled. -- The following `using` directives are included in your file: +The following `using` directives are included in your file: {% tabs %} @@ -28,6 +24,8 @@ using Syncfusion.WinForms.AIAssistView; {% endtabs %} +N> An `SfAIAssistView` instance has been created and added to the form. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. + ## Enabling the Stop Responding Button By default, the Stop Responding button is not displayed. To enable it, set the `EnableStopResponding` property to `true`. @@ -60,22 +58,22 @@ private void SfaiAssistView1_StopResponding(object sender, EventArgs e) CancelAIRequest(); } -private CancellationTokenSource cts; +private CancellationTokenSource ct; private void CancelAIRequest() { - if (cts != null && !cts.IsCancellationRequested) + if (ct != null && !ct.IsCancellationRequested) { - cts.Cancel(); - cts.Dispose(); - cts = null; + ct.Cancel(); + ct.Dispose(); + ct = null; } } {% endhighlight %} {% endtabs %} -`CancellationTokenSource` is created and assigned to `cs` when an AI request is started, and the resulting token is passed into the AI service call. The event handler cancels that token when the user clicks Stop. +`CancellationTokenSource` is created and assigned to `ct` when an AI request is started, and the resulting token is passed into the AI service call. The event handler cancels that token when the user clicks Stop. ### Wiring Cancellation into an AI Request @@ -91,11 +89,11 @@ private async void Chats_CollectionChanged(object sender, NotifyCollectionChange if (item.Author?.Name != viewModel.CurrentUser?.Name) return; viewModel.ShowTypingIndicator = true; - cts = new CancellationTokenSource(); + ct = new CancellationTokenSource(); try { - string response = await aiService.NonStreamingChatAsync(item.Text, cts.Token); + string response = await aiService.NonStreamingChatAsync(item.Text, ct.Token); viewModel.Chats.Add(new TextMessage { Author = new Author { Name = "Bot" }, @@ -123,9 +121,9 @@ The button text and the hold duration can be customized using the properties bel | Property | Description | Default | |----------|-------------|---------| -| `StopRespondingButtonText` | Text shown on the button before cancellation. | `"Stop"` | -| `StopRespondingButtonCancelingText` | Text shown on the button while cancellation is in progress. | `"Canceling..."` | -| `StopRespondingHoldSeconds` | Number of seconds the button stays disabled after being clicked. | `0` | +| `StopRespondingButtonText` | Text shown on the button before cancellation. | `"\u25A0 Stop Responding"` | +| `StopRespondingButtonCancelingText` | Text shown on the button while cancellation is in progress. | `"Cancelling..."` | +| `StopRespondingHoldSeconds` | Number of seconds the button stays disabled after being clicked. | `1` | {% tabs %} @@ -144,13 +142,4 @@ sfAIAssistView1.StopRespondingHoldSeconds = 2; {% endtabs %} -![WindowsForms AI AssistView control StopRespondingButtonText](aiassistview_images/windowsforms_aiassistview_stoprespondingtext.png) - -## Troubleshooting - -| Issue | Possible Cause | Resolution | -|-------|----------------|------------| -| Clicking Stop does not cancel the request | The AI service call does not accept a `CancellationToken`. | Update the AI service to accept and observe a `CancellationToken` from `CancellationTokenSource`. | -| `NullReferenceException` when clicking Stop | `cs` was never assigned because the request was never started. | Guard the cancel call with a null check on `cs`, as shown in the example. | -| The button never appears | `EnableStopResponding` is `false` (default). | Set `sfAIAssistView1.EnableStopResponding = true;` before showing the form. | - +![WindowsForms AI AssistView control StopRespondingButtonText](aiassistview_images/windowsforms_aiassistview_stoprespondingtext.png) \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Suggestions.md b/WindowsForms/AI-AssistView/Suggestions.md index 991807706..0b44bc5dc 100644 --- a/WindowsForms/AI-AssistView/Suggestions.md +++ b/WindowsForms/AI-AssistView/Suggestions.md @@ -11,13 +11,6 @@ documentation: ug Use the [`Suggestions`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_Suggestions) property to display AI-driven suggestions in the bottom-right corner of the AssistView, so users can quickly respond or select from relevant options. -## Prerequisites - -- **Required package:** [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet package. -- A `ViewModel` with `Chats`, `CurrentUser`, and `Suggestion` properties exists. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started#creating-viewmodel-for-ai-assistview) for setup details. -- The `Suggestion` collection is bound to the control's `Suggestions` property. The collection should be of a type that implements `INotifyCollectionChanged` (for example, `ObservableCollection`) so updates are reflected automatically. -- A bot avatar image is added to the project at `Asset\AI_Assist.png` (if the example is extended with one). - ## ViewModel The following `ViewModel` populates `Chats` with a sample conversation and updates the `Suggestion` collection once the bot response is added. The collection is mutated in place (via `Add`) so the bound `ObservableCollection` notifies the UI of the change: @@ -135,28 +128,35 @@ public partial class Form1 : Form ## Handling Suggestion Clicks -When a user clicks a suggestion, the text is sent as a new prompt. Handle the `PromptRequest` event (or `Chats_CollectionChanged`) to react to the selection: +The `SuggestionSelected` event occurs when a user clicks a suggestion displayed in the AI AssistView. Use this event to retrieve the selected suggestion text and perform custom actions, such as sending the suggestion as a new prompt, generating a response, or updating the conversation. + +The selected item is available through the `Item` property of the `SuggestionSelectedEventArgs`. {% tabs %} {% highlight c# %} -sfAIAssistView1.PromptRequest += (sender, e) => +sfAIAssistView1.SuggestionSelected += AiAssistView_SuggestionSelected; + +private void AiAssistView_SuggestionSelected( + object sender, + SuggestionSelectedEventArgs e) { - // e.Message contains the selected suggestion - var message = e.Message as TextMessage; - if (message == null) return; - // Process the prompt here, e.g., forward to your AI service -}; + string suggestionText = e.Item?.ToString(); -{% endhighlight %} + if (string.IsNullOrWhiteSpace(suggestionText)) + return; -{% endtabs %} + // Handle the selected suggestion. + // For example, add it as a user message or forward it to an AI service. -## Troubleshooting + viewModel.Chats.Add(new TextMessage + { + Author = viewModel.CurrentUser, + Text = suggestionText + }); +} + +{% endhighlight %} -| Issue | Possible Cause | Resolution | -|-------|----------------|------------| -| Suggestions are not displayed | `Suggestion` is reassigned to a new instance after the binding is created, breaking the binding. | Mutate the existing `ObservableCollection` (e.g., `Suggestion.Add(...)`) instead of replacing it. | -| Suggestions appear only once and then disappear | The collection is reassigned to a new empty instance. | Clear and refill the existing collection rather than reassigning. | -| `NullReferenceException` when iterating suggestions | The bound `Suggestion` is `null` at the time of binding. | Initialize the collection in the `ViewModel` constructor before binding. | \ No newline at end of file +{% endtabs %} \ No newline at end of file diff --git a/WindowsForms/AI-AssistView/Typing-Indicator.md b/WindowsForms/AI-AssistView/Typing-Indicator.md index 886d5830b..a5391b0ca 100644 --- a/WindowsForms/AI-AssistView/Typing-Indicator.md +++ b/WindowsForms/AI-AssistView/Typing-Indicator.md @@ -13,12 +13,7 @@ Use the [`TypingIndicator`](https://help.syncfusion.com/cr/windowsforms/Syncfusi The `TypingIndicator` shows an animation representing the AI or user typing a message. The indicator is shown when the [`ShowTypingIndicator`](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.AIAssistView.SfAIAssistView.html#Syncfusion_WinForms_AIAssistView_SfAIAssistView_ShowTypingIndicator) property is set to `true`. -## Prerequisites - -- **Required package:** [Syncfusion.SfAIAssistView.WinForms](https://www.nuget.org/packages/Syncfusion.SfAIAssistView.WinForms) NuGet package. -- A `ViewModel` with `Chats`, `ShowTypingIndicator`, and `CurrentUser` properties exists. See [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) for setup details. -- A bot avatar image is added to the project at `Asset\AI_Assist.png`. -- The following `using` directives are included in your file: + following `using` directives are included in your file: {% tabs %} @@ -32,6 +27,8 @@ using Syncfusion.WinForms.AIAssistView; {% endtabs %} +N> A `ViewModel` class with a `Chats` collection, `ShowTypingIndicator`, `Suggestion`, and `CurrentUser` properties exists. Refer to the [Getting Started](https://help.syncfusion.com/windowsforms/ai-assistview/getting-started) page for setup details. + ## Configuring the Typing Indicator The following example configures the typing indicator's avatar and display text, and binds the `ShowTypingIndicator` property to the `ViewModel`: @@ -67,12 +64,4 @@ public partial class Form1 : Form {% endtabs %} -![WindowsForms AI AssistView control typing indicator](aiassistview_images/windowsforms_aiassistview_typing_indicator.gif) - -## Troubleshooting - -| Issue | Possible Cause | Resolution | -|-------|----------------|------------| -| The indicator never appears | `ShowTypingIndicator` is not bound, or the bound property is not set to `true`. | Ensure `ShowTypingIndicator = true` is set in the `ViewModel` and the property is bound. | -| `FileNotFoundException` for `AI_Assist.png` | The bot avatar image is missing from the project. | Add `AI_Assist.png` to the project's `Asset` folder, or update the path. | -| The indicator shows the wrong avatar/name | `TypingIndicator.Author` is not set. | Assign an `Author` to `TypingIndicator.Author` before the control is shown. | \ No newline at end of file +![WindowsForms AI AssistView control typing indicator](aiassistview_images/windowsforms_aiassistview_typing_indicator.gif) \ No newline at end of file From 09380be8ee7d1275a506c784a6c2b0a55120ae81 Mon Sep 17 00:00:00 2001 From: "124353880+ArunKumarSF4054@users.noreply.github.com" <124353880+ArunKumarSF4054@users.noreply.github.com> Date: Thu, 16 Jul 2026 16:57:17 +0530 Subject: [PATCH 21/36] Getting Started File updated --- WindowsForms/Diagram/Getting-Started.md | 94 ++++++++++++------------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/WindowsForms/Diagram/Getting-Started.md b/WindowsForms/Diagram/Getting-Started.md index cfdb6b2bf..801027021 100644 --- a/WindowsForms/Diagram/Getting-Started.md +++ b/WindowsForms/Diagram/Getting-Started.md @@ -13,11 +13,11 @@ This section helps you understand and quickly get started using [WinForms Diagr ## Assembly deployment -Refer to [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#diagram) section to get the list of assemblies or NuGet package needs to be added as reference to use the Diagram control in any application. +Refer to [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#diagram) section to get the list of assemblies or NuGet packages needs to be added as references to use the Diagram control in any application. -## Structure of React Diagram +## Structure of Windows Forms Diagram -The React Diagram package is comprised of the following controls: +The Windows Forms Diagram package is comprised of the following controls: * Diagram * Overview @@ -28,11 +28,11 @@ The React Diagram package is comprised of the following controls: ### Diagram -The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control is an interactive two-dimensional graphics control for diagramming, technical drawing, visualization, and simulation applications. It provides a surface for rendering and manipulating 2-D shapes, text, images, and Windows Form controls. The UI supports drag-and-drop, scaling, zooming, rotation, grouping, ungrouping, connection points, layouts, and many other features. +The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control is an interactive two-dimensional graphics control for diagramming, technical drawing, visualization, and simulation applications. It provides a surface for rendering and manipulating 2-D shapes, text, images, and Windows Form controls. The UI supports drag and drop, scaling, zooming, rotation, grouping, ungrouping, connection points, layouts, and many other features. The Diagram control’s architecture is composed of three objects, namely Model, View, and Controller and it provides a clear separation between data, visualization, and user interface. One advantage of model-view-controller architecture is that the parts are interchangeable. The model, view, and controller can be swapped in and out independently. -The model contains the data (node/connector) portion of a diagram. The view is responsible for rendering the diagram, and the controller handles user interaction. The Diagram control supports both horizontal and vertical rulers. +The model contains the data (nodes and connectors) portion of a diagram. The view is responsible for rendering the diagram, and the controller handles user interaction. The Diagram control supports both horizontal and vertical rulers. @@ -52,7 +52,7 @@ The Overview control provides a perspective view of a diagram model and allows u ### PaletteGroupBar -The PaletteGroupBar control provides a way for users to drag symbols onto a diagram. It is based on the GroupBar control of Essential® Tools. Each symbol palette loaded in the PaletteGroupBar control occupies a panel that can be selected by a bar button. The bar button is labeled with the name of the symbol palette. Each symbol palette is a list of symbols that have an icon and a label. The symbols in the palette are shown as icons that can be dragged onto the diagram. This control allows users to add symbols to a palette, and save or load the palette whenever necessary. It provides a way to classify and maintain symbols. It also provides preview of symbol during drag-and-drop operation. +The PaletteGroupBar control provides a way for users to drag symbols onto a diagram. It is based on the GroupBar control of Essential® Tools. Each symbol palette loaded in the PaletteGroupBar control occupies a panel that can be selected by a bar button. The bar button is labeled with the name of the symbol palette. Each symbol palette is a list of symbols that have an icon and a label. The symbols in the palette are shown as icons that can be dragged onto the diagram. This control allows users to add symbols to a palette, and save or load the palette whenever necessary. It provides a way to classify and maintain symbols. It also provides a preview of symbols during drag and drop operations. @@ -64,7 +64,7 @@ The PaletteGroupBar control provides a way for users to drag symbols onto a diag The PaletteGroupView control provides an easy way to serialize a symbol palette to and from a resource file of a form. At design time, users can attach a symbol palette to the PaletteGroupView control in the form. Selecting PaletteGroupView and clicking the Palette property in the Visual Studio .NET Properties window will open a standard Open File dialog, which allows the user to select a symbol palette file that has been created with the Symbol Designer. -It displays the symbol models belonging to a symbol palette in the GroupView control of Essential® Tools for Windows Forms. It contains a list of icons and labels that can be hosted in the PaletteGroupBar control. The symbol models can be dragged from this control and dropped onto the diagram. It also provides preview of symbols during drag-and-drop operation. +It displays the symbol models belonging to a symbol palette in the GroupView control of Essential® Tools for Windows Forms. It contains a list of icons and labels that can be hosted in the PaletteGroupBar control. The symbol models can be dragged from this control and dropped onto the diagram. It also provides a preview of symbols during drag and drop operation. ### PropertyEditor @@ -86,7 +86,7 @@ The DocumentExplorer control allows you to visualize the details of the various -## React Diagram in Windows Forms Application +## WinForms Diagram in Windows Forms Application This section helps you to create the Diagram, PaletteGroupBar, PaletteGroupView, Overview, PropertyEditor, and DocumentExplorer controls through the designer and code in a Windows Forms application. @@ -108,7 +108,7 @@ To create a Diagram control using the designer: -The Diagram control will be added to the designer and its dependent assemblies will be added to the project once you dropped it to the Designer Form window. +The Diagram control will be added to the designer and its dependent assemblies will be added to the project once you drag and drop it onto the Designer Form. @@ -229,7 +229,7 @@ Me.Controls.Add(diagram) #### Adding Nodes to the Model -The Diagram control has a list of predefined basic shapes ([nodes](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Model.html#Syncfusion_Windows_Forms_Diagram_Model_Nodes)) which help you to draw diagrams according to your requirement. You can create your own shapes by inheriting the existing shape’s class and the Symbol Designer utility tool which is shipped with the React Diagram package. +The Diagram control has a list of predefined basic shapes ([nodes](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Model.html#Syncfusion_Windows_Forms_Diagram_Model_Nodes)) which help you to draw diagrams according to your requirement. You can create your own shapes by inheriting the existing shape’s class and the Symbol Designer utility tool which is shipped with the WinForms Diagram package. The following code creates a rectangular node and adds it to the model. @@ -498,7 +498,7 @@ To create a [PaletteGroupBar](https://help.syncfusion.com/cr/windowsforms/Syncfu -The PaletteGroupBar control will be added to the designer and its dependent assemblies will be added to the project once you dropped it to the Designer Form window. +The PaletteGroupBar control will be added to the designer and its dependent assemblies will be added to the project once you drag and drop it onto the Designer Form. @@ -597,7 +597,7 @@ To create a [PaletteGroupView](https://help.syncfusion.com/cr/windowsforms/Syncf -The PaletteGroupView control will be added to the designer and its dependent assemblies will be added to the project once you dropped it to the Designer Form window. +The PaletteGroupView control will be added to the designer and its dependent assemblies will be added to the project once you drag and drop it onto the Designer Form. @@ -691,7 +691,7 @@ To create an Overview control using the designer: -The Overview control will be added to the designer and its dependent assemblies will be added to the project once you dropped it to the Designer Form window. +The Overview control will be added to the designer and its dependent assemblies will be added to the project once you drag and drop it onto the Designer Form. @@ -775,7 +775,7 @@ To create a [PropertyEditor](https://help.syncfusion.com/cr/windowsforms/Syncfus -The PropertyEditor control will be added to the designer and its dependent assemblies will be added to the project once you dropped it to the Designer Form window. +The PropertyEditor control will be added to the designer and its dependent assemblies will be added to the project once you drag and drop it onto the Designer Form. @@ -861,7 +861,7 @@ To create a [DocumentExplorer](https://help.syncfusion.com/cr/windowsforms/Syncf -The DocumentExplorer control will be added to the designer and its dependent assemblies will be added to the project once you dropped it to the Designer Form window. +The DocumentExplorer control will be added to the designer and its dependent assemblies will be added to the project once you drag and drop it onto the Designer Form. @@ -931,47 +931,47 @@ Diagram Builder application allows the user to create new diagrams and also modi The main difference between the diagram builder and symbol palette is as follows: -* In Diagram Builder, user creates diagram documents +* In Diagram Builder, users create diagram documents * In Symbol Designer, user creates palettes. Software Path "[Installed Drive]:\Program Files\Syncfusion\Essential Studio\{{ site.releaseversion }}\Utilities\Diagram\Windows Forms\DiagramBuilder" -1. Overview Control +**1. Overview Control** Overview Control provides a perspective view of a diagram model, and allows users to dynamically pan and zoom the diagrams. The control features a view port window that can be moved and / or resized using the mouse to modify the diagrams' origin and magnification properties at run-time. The properties of this control is discussed in the Overview Control topic. -2. Palette GroupBar and GroupView +**2. Palette GroupBar and GroupView** The PaletteGroupBar control provides a way for users to drag and drop symbols onto a diagram. It is based on the Syncfusion® Essential® Tools GroupBar control. Each symbol palette loaded in thePaletteGroupBar occupies a panel that can be selected by a bar button. The bar button is labeled with the name of the symbol palette. The symbols in the palette are shown as icons that can be dragged and dropped onto the diagram. This control allows users to add symbols to a palette, and save or load the palette whenever necessary. It provides a way to classify and maintain symbols. The PaletteGroupView control provides an easy way to serialize a symbol palette to and from the resource file of a form. At design-time, users can attach a symbol palette to a PaletteGroupView control in the form. Selecting the PaletteGroupView and clicking the Palette property in the Visual Studio .NET Properties window will open a standard Open File dialog, which allows the user to select a symbol palette file that has been created with the Symbol Designer. For more details about these diagram controls, refer to the Palette GroupBar and GroupView topic. -3. Property Editor +**3. Property Editor** -The Property Editor in React Diagram displays properties of the currently selected object(s) in the diagram. It is a Windows Forms control that can be added to the Visual Studio .NET Toolbox. It also allows users to set or modify various properties of the objects or the model. The Property Editor provides an easy interface to set and view the various property settings. To know about the control's properties see Property Editor topic. +The Property Editor in WinForms Diagram displays properties of the currently selected object(s) in the diagram. It is a Windows Forms control that can be added to the Visual Studio .NET Toolbox. It also allows users to set or modify various properties of the objects or the model. The Property Editor provides an easy interface to set and view the various property settings. To know about the control's properties see Property Editor topic. -4. Document Explorer +**4. Document Explorer** Document Explorer allows you to visualize the details of the various objects that are added onto the diagram control at run-time. The layers will be listed under the _Layers_ node and other objects like shapes, links, lines and text editor will be listed under _Nodes_ node. -5. Diagram Document +**5. Diagram Document** The [DiagramDocument](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.DiagramDocument.html#) is a serializable document type that encapsulates the model and view data for the diagram. The grid area of the diagram document is the diagram view object area. The nodes dragged from the PaletteGroupBar will be dropped here. For more details, see Diagram Grid topic. -Diagram Builder Functionalities +**Diagram Builder Functionalities** 1. How to Open an Existing Diagram Document -Follow the below steps in order to open an existing diagram document + Follow the below steps in order to open an existing diagram document -1. Add OpenFileDialog control to the Form. -2. Set the Filter property of OpenFileDialog as React Diagram Palettes|*.edp|Visio Stencils|*.vss; *.vsx|Visio Drawings(Shapes only)|*.vsd; *.vdx|All files|*.*. -3. Add the below code snippet in your button click event. + 1. Add OpenFileDialog control to the Form. + 2. Set the Filter property of OpenFileDialog as WinForms Diagram Palettes|*.edp|Visio Stencils|*.vss; *.vsx|Visio Drawings(Shapes only)|*.vsd; *.vdx|All files|*.*. + 3. Add the below code snippet in your button click event. {% capture codesnippet9 %} {% tabs %} @@ -1005,7 +1005,7 @@ The diagram1.LoadBinary() method loads the selected diagram file into diagram do Below are the steps to save a diagram document. 1. Add SaveFileDialog control to the Form. - 2. Set the Filter property of SaveFileDialog as React Diagram Files|*.edd|All files|*.*. + 2. Set the Filter property of SaveFileDialog as WinForms Diagram Files|*.edd|All files|*.*. 3. Add the following code snippet in your button click event. {% capture codesnippet10 %} @@ -1036,13 +1036,13 @@ this.diagram1.SaveBinary(this.FileName); 3. How to print a Diagram Document -Following are the steps to print a diagram document: + Following are the steps to print a diagram document: -1. Page Setup + 1. **Page Setup** - The Page Setup dialog modifies the [Page Settings](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.View.html#Syncfusion_Windows_Forms_Diagram_View_PageSettings) and [Printer Settings](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.PageSizeControl.html#Syncfusion_Windows_Forms_Diagram_PageSizeControl_PrinterSettings) information for a given document. The user can enable sections of the dialog to manipulate printing, margins, paper orientation, size, source and to show help and network buttons. MinMargins defines the minimum margins a user can select. + The Page Setup dialog modifies the [Page Settings](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.View.html#Syncfusion_Windows_Forms_Diagram_View_PageSettings) and [Printer Settings](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.PageSizeControl.html#Syncfusion_Windows_Forms_Diagram_PageSizeControl_PrinterSettings) information for a given document. The user can enable sections of the dialog to manipulate printing, margins, paper orientation, size, source and to show help and network buttons. MinMargins defines the minimum margins a user can select. - The following code snippet can be used for setting the page set up for diagram document. + The following code snippet can be used for setting the page set up for diagram document. @@ -1067,11 +1067,11 @@ if (dlgPageSetup.ShowDialog() == DialogResult.OK) ![Print a Diagram document in WindowsForms Diagram](getting-started_images/windowsforms-diagram-print-document.jpeg) -2. Page Borders + 2. **Page Borders** - The Page Borders dialog provides an interactive form-based interface, for setting the page borders of a diagram, initializing the dialog's Syncfusion.Windows.Forms.Diagram.PageBorderDialog. The PageBorderStyle property with the corresponding Syncfusion.Windows.Forms.Diagram.View.PageBorderStyle member of the diagram's view, will let the users to configure the page border settings using the dialog controls. + The Page Borders dialog provides an interactive form-based interface, for setting the page borders of a diagram, initializing the dialog's Syncfusion.Windows.Forms.Diagram.PageBorderDialog. The PageBorderStyle property with the corresponding Syncfusion.Windows.Forms.Diagram.View.PageBorderStyle member of the diagram's view, will let the users to configure the page border settings using the dialog controls. - The following code snippet can be used for setting the page border for diagram document. + The following code snippet can be used for setting the page border for diagram document. @@ -1097,11 +1097,11 @@ if (diagram1 != null && diagram1.Model != null) -3. Header and Footers + 3. **Header and Footers** - The [Header](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Header.html#) and [Footer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Footer.html#) dialog provides an interactive form-based interface for initializing the Header and Footer settings of a diagram. + The [Header](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Header.html#) and [Footer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Footer.html#) dialog provides an interactive form-based interface for initializing the Header and Footer settings of a diagram. - The following code snippet can be used for creating the [Header and Footer dialog](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.HeaderFooterDialog.html#). + The following code snippet can be used for creating the [Header and Footer dialog](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.HeaderFooterDialog.html#). @@ -1128,13 +1128,13 @@ if (diagram1 != null && diagram1.Model != null) ![Header and footer in WindowsForms Diagram](getting-started_images/windowsforms-diagram-header-and-footer.jpeg) -4. Print Preview + 4. **Print Preview** - It will show a preview of the page which will appear when printed. The Print Preview dialog shows the preview of the page with the following: + It will show a preview of the page which will appear when printed. The Print Preview dialog shows the preview of the page with the following: - * Page setup - * Page border set up - * Header and footers in the page + * Page setup + * Page border set up + * Header and footers in the page The following code snippet can be used for creating Print Preview dialog. @@ -1165,11 +1165,11 @@ if (diagram1 != null) -5. Print + 5. **Print** - This option will send the diagram document to the printer. + This option will send the diagram document to the printer. - The following code snippet can be used for sending the document for printing. + The following code snippet can be used for sending the document for printing. @@ -2104,7 +2104,7 @@ diagram.Location = new Point(20, 5); #### Establishing Database Connectivity -2. You can populate Nodes and Connectors in diagram automatically based on content from database by using binding APIs. To achieve this, you need a table in a database that have 2 columns, one representing ‘Id’ to uniquely identify objects, and one ‘ParentId’ representing relationship with the parent object. The following code example explains how to bind diagram with data from database by initializing the binding properties. +2. You can populate Nodes and Connectors in diagram automatically based on content from database by using binding APIs. To achieve this, you need a table in a database that has two columns, one representing ‘Id’ to uniquely identify objects, and one ‘ParentId’ representing relationship with the parent object. The following code example explains how to bind diagram with data from database by initializing the binding properties. {% capture codesnippet11 %} {% tabs %} From aaea3edd6c50ef213ed7d2b8468092578271beb0 Mon Sep 17 00:00:00 2001 From: VijayakumarSF4470 <160592658+VijayakumarSF4470@users.noreply.github.com> Date: Thu, 16 Jul 2026 20:04:07 +0530 Subject: [PATCH 22/36] 1041550: Need to create documentation file for WinForms platform. --- WindowsForms/mcp.md | 233 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 233 insertions(+) create mode 100644 WindowsForms/mcp.md diff --git a/WindowsForms/mcp.md b/WindowsForms/mcp.md new file mode 100644 index 000000000..9296ff823 --- /dev/null +++ b/WindowsForms/mcp.md @@ -0,0 +1,233 @@ +--- +layout: post +title: Syncfusion WinForms MCP Server | Syncfusion +description: Learn how to configure and use Syncfusion WinForms MCP server for intelligent code generation, documentation, and troubleshooting in WindowsForms apps. +platform: WindowsForms +control: Getting started with Syncfusion WinForms MCP Server +documentation: ug +--- + +# Syncfusion WinForms MCP Server + +Syncfusion® MCP Server accelerates WinForms application development by providing deep knowledge directly in your AI-powered IDE. [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro) (MCP) integration enables quick access to documentation, API references, and code-generation features from within the development environment. + +These tools speed up development and reinforce best practices for Syncfusion component integration in desktop applications. + +## Key Benefits + +- **Expert Component Knowledge** - Deep understanding of 80+ WinForms controls and their implementation patterns. +- **Unlimited Usage** - No request limits, time restrictions, or query caps. +- **Privacy-Focused** - The tools operate based on the user's query and do not store any content, data, or prompts. + +## Installation + +### Prerequisites + +Before beginning, ensure the following prerequisites are met: + +- **.NET Framework** 4.7.2 or higher, or **.NET Core** 3.1 or higher +- A **compatible MCP client** (VS Code, Syncfusion® Code Studio, Cursor, JetBrains, etc.) +- An active [Syncfusion® API key](https://syncfusion.com/account/api-key) +- A **WinForms application** (existing or new); see [Windows Forms application that includes Syncfusion Windows Forms](https://help.syncfusion.com/windowsforms/overview) +- 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) + - [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials) + +### Getting Your API Key + +Generate the Syncfusion® API key from the [API Key page](https://www.syncfusion.com/account/api-key) and store it in a `.txt` or `.key` file. The saved file will be referenced in the MCP configuration: + +````json +"env": { + "Syncfusion_API_Key_Path": "D:\\syncfusion-key.txt" +} +```` + +> Alternatively, the API key can also be set directly using `"Syncfusion_API_Key": "YOUR_API_KEY"` in the env configuration. Using a file path is recommended to keep the key out of source control. + +### Setting Up in MCP Clients + +Create a configuration file in your project folder to install the server for your workspace. **Replace `YOUR_API_KEY_FILE_PATH` with the path to your API key file.** + +{% tabs %} +{% highlight bash tabtitle="VS Code" %} + +// Create a `.vscode/mcp.json` file in your workspace: + +{ + "servers": { + "sf-winforms-mcp": { + "type": "stdio", + "command": "dnx", + "args": ["Syncfusion.WinForms.MCP.dll"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +{% endhighlight %} +{% highlight bash tabtitle="Code Studio" %} + +// Create a `.codestudio/mcp.json` file in your workspace: + +{ + "servers": { + "sf-winforms-mcp": { + "type": "stdio", + "command": "dnx", + "args": ["Syncfusion.WinForms.MCP.dll"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +// After creating the file, click Start in the inline action to install the server. + +{% endhighlight %} +{% highlight bash tabtitle="Cursor" %} + +// Create a `.cursor/mcp.json` file in your workspace: + +{ + "mcpServers": { + "sf-winforms-mcp": { + "command": "dnx", + "args": ["Syncfusion.WinForms.MCP.dll"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +{% endhighlight %} +{% highlight bash tabtitle="JetBrains" %} + +// Open AI Assistant chat, type /, and select Add Command. +// Click ➕ Add on the MCP settings page. +// Choose STDIO and select JSON configuration: + +{ + "mcpServers": { + "sf-winforms-mcp": { + "command": "dnx", + "args": ["Syncfusion.WinForms.MCP.dll"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +// Click OK, then click Apply. The server starts and shows Connected status. + +{% endhighlight %} +{% endtabs %} + +**Verifying Installation** Check your editor's MCP Server list for `sf-winforms-mcp` with a **Connected** status to confirm a successful installation. + +## Common use cases + +The examples below showcase how the different MCP tools handle real-world WinForms development scenarios. Tools can be invoked directly, as shown in the examples below, for specific needs. Alternatively, an AI assistant can automatically select the most appropriate tool based on the request. + +**Get Started** + +Use `search_docs` to get contextual guidance, code snippets, and configuration examples for any component. + +{% promptcards %} +{% promptcard Grid with Paging & Sorting %} +#search_docs Create a Syncfusion WinForms Grid with paging, sorting, and filtering enabled. +{% endpromptcard %} +{% endpromptcards %} + +{% promptcards %} +{% promptcard RichTextEditor Setup %} +#search_docs How do I set up the Syncfusion WinForms RichTextEditor with a custom toolbar? +{% endpromptcard %} +{% endpromptcards %} + +**Implement Features** + +Get step-by-step help for adding specific features to components that are already in the project. + +{% promptcards %} +{% promptcard Grid Export %} +#search_docs How can I add PDF and Excel export options to my DataGrid control? +{% endpromptcard %} +{% endpromptcards %} + +{% promptcards %} +{% promptcard Schedule Events %} +#search_docs How do I implement recurring events and reminders in the Schedule control? +{% endpromptcard %} +{% endpromptcards %} + +**Troubleshooting** + +Describe the problem in plain language, and let `search_docs` help resolve it. +{% promptcards %} +{% promptcard Grid Issues %} +#search_docs Why isn't my Grid loading or rendering data correctly? +{% endpromptcard %} +{% endpromptcards %} + +{% promptcards %} +{% promptcard Schedule Issues %} +#search_docs Why aren't my Schedule events displaying or saving correctly? +{% endpromptcard %} +{% endpromptcards %} + +## Best Practices + +To get the most out of the Syncfusion® WinForms MCP Server: + +- **Be Specific** - Include the platform and control in your queries (for example, *"Create a Syncfusion WinForms DataGrid with grouping and summaries"*). +- **Provide Context** - Include applicable .NET framework versions, expected outcomes, and any requirements or limitations that may affect the request. +- **Use Descriptive Queries** - Avoid overly brief or ambiguous requests. Providing sufficient detail helps improve the accuracy and relevance of the response. +- **Stay Consistent** - Keep file organization, naming conventions, and coding standards consistent throughout your WinForms project. +- **Start Fresh for New Topics** - Begin a new chat when switching to a different component or task to maintain clean context. +- **Use Advanced AI Models** - For best results, use **Claude Sonnet 4.5 or higher**. Other compatible models include **GPT-5 and Gemini 3 Pro**. Higher-capability models produce more accurate component implementations. +- **For Troubleshooting** - Use AI suggestions for common issues; consult the [official documentation](https://help.syncfusion.com/windowsforms/overview) or [support](https://support.syncfusion.com/support/tickets/create) for complex problems. +- **Minimize Active Tools** - Limit the number of active MCP tools in your IDE to prevent tool-selection ambiguity and improve response accuracy. + +> Always review AI-generated code before using it in production. + +## Troubleshooting + +The table below lists frequently encountered issues and suggested resolutions to help diagnose and address common setup or usage challenges. + +| Issue | Solution | +|-------|----------| +| **Server failed to start** | Ensure .NET Framework 4.7.2+ or .NET Core 3.1+ is installed, verify JSON syntax in the config file, and restart your IDE. | +| **Invalid API key** | Verify your key is active at the [Syncfusion Account Page](https://syncfusion.com/account/api-key). | +| **Incorrect API key config** | For the file path: verify file location and content. For inline key: check the key is correctly updated. | +| **Wrong config file location** | VS Code: `.vscode/mcp.json` • Code Studio: `.codestudio/mcp.json` • Cursor: `.cursor/mcp.json` in the workspace root. | +| **Check IDE logs** | VS Code / Code Studio: Output panel → "MCP" • Cursor: Developer Console for MCP errors. | + +## Privacy & Security + +The Syncfusion® MCP Servers are designed with privacy considerations: + +* The tools process requests according to the user's query without storing any content or prompts. +* User prompts are not stored or used for other purposes. +* Prompts are not used to train Syncfusion models. +* The assistant provides context; the final output is produced by the selected AI model. + +The MCP Server acts purely as a knowledge bridge, connecting your AI model with Syncfusion-specific expertise while respecting your privacy and maintaining security. + +## See Also + +- [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro) \ No newline at end of file From 00c595f6cb0cd77881883c91f7f3f39032351e54 Mon Sep 17 00:00:00 2001 From: AshaBhaskaran Date: Thu, 16 Jul 2026 20:27:42 +0530 Subject: [PATCH 23/36] added links --- WindowsForms/DataGrid/GettingStarted.md | 2 +- WindowsForms/DataGrid/Overview.md | 2 +- WindowsForms/Diagram/Context-Menu.md | 2 +- WindowsForms/Diagram/Data-Binding.md | 2 +- WindowsForms/Diagram/Drawing-Tool.md | 4 ++-- WindowsForms/Diagram/Dynamic-Properties.md | 2 +- WindowsForms/Diagram/Event-Handlers.md | 2 +- WindowsForms/Diagram/Getting-Started.md | 4 ++-- WindowsForms/Diagram/Gridlines.md | 4 ++-- WindowsForms/Diagram/Grouping.md | 2 +- WindowsForms/Diagram/Guides.md | 2 +- WindowsForms/Diagram/Layers.md | 2 +- WindowsForms/Diagram/Layout-Management.md | 2 +- WindowsForms/Diagram/Measurement-Units.md | 4 ++-- WindowsForms/Diagram/Nodes-or-Shapes.md | 4 ++-- WindowsForms/Diagram/Overview.md | 4 ++-- WindowsForms/Diagram/Ports-And-Connections.md | 2 +- WindowsForms/Diagram/Rulers.md | 4 ++-- WindowsForms/Diagram/Serialization/Diagram-Serialization.md | 2 +- WindowsForms/Diagram/Supported-Controls.md | 2 +- WindowsForms/Diagram/Touch-Support.md | 2 +- WindowsForms/Diagram/Zoom-And-Pan.md | 2 +- WindowsForms/GridGrouping/Overview.md | 2 +- WindowsForms/Scheduler/Getting-Started.md | 2 +- WindowsForms/Scheduler/Overview.md | 2 +- 25 files changed, 32 insertions(+), 32 deletions(-) diff --git a/WindowsForms/DataGrid/GettingStarted.md b/WindowsForms/DataGrid/GettingStarted.md index 2aba9cdbb..b88f4843c 100644 --- a/WindowsForms/DataGrid/GettingStarted.md +++ b/WindowsForms/DataGrid/GettingStarted.md @@ -566,4 +566,4 @@ End Sub {% endhighlight %} {% endtabs %} -N> Looking for the full WinForms Data Grid component overview, features, pricing, and documentation? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file +N> Looking for the full WinForms Data Grid component overview, features, and pricing? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file diff --git a/WindowsForms/DataGrid/Overview.md b/WindowsForms/DataGrid/Overview.md index 3779259f9..bfb452648 100644 --- a/WindowsForms/DataGrid/Overview.md +++ b/WindowsForms/DataGrid/Overview.md @@ -272,4 +272,4 @@ The [`Windows Forms SfDataGrid`](https://support.syncfusion.com/kb/desktop/secti Similar to the [`Knowledge Base`](https://support.syncfusion.com/kb/desktop/section/952), the [`forum`](https://www.syncfusion.com/forums/windowsforms) section also contains responses to questions that other customers have asked us in the past. -N> Looking for the full WinForms Data Grid component overview, features, pricing, and documentation? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file +N> Looking for the full WinForms Data Grid component overview, features, and pricing? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Context-Menu.md b/WindowsForms/Diagram/Context-Menu.md index 7b01dec9a..6ae2165ee 100644 --- a/WindowsForms/Diagram/Context-Menu.md +++ b/WindowsForms/Diagram/Context-Menu.md @@ -11,7 +11,7 @@ documentation: ug ### Built-in context menu -The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) provides built-in context menu support to the Diagram. +The [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) provides built-in context menu support to the Diagram. All available tools for the Diagram control such as File options, Edit options, Action options, Layout, Connectors, and Shapes are listed in the built-in context menu. diff --git a/WindowsForms/Diagram/Data-Binding.md b/WindowsForms/Diagram/Data-Binding.md index c379a921d..9f4193b1b 100644 --- a/WindowsForms/Diagram/Data-Binding.md +++ b/WindowsForms/Diagram/Data-Binding.md @@ -11,7 +11,7 @@ documentation: ug ### Populating the data -* [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) can be populated with the nodes and connectors based on the information provided from an external data source. +* [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) can be populated with the nodes and connectors based on the information provided from an external data source. * Diagram exposes its specific data-related properties, which allow you specify the data source fields from where the node information has to be retrieved. To explore those properties, refer to the [Data source settings](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Binding.html). diff --git a/WindowsForms/Diagram/Drawing-Tool.md b/WindowsForms/Diagram/Drawing-Tool.md index e284ff933..26dd87639 100644 --- a/WindowsForms/Diagram/Drawing-Tool.md +++ b/WindowsForms/Diagram/Drawing-Tool.md @@ -10,7 +10,7 @@ documentation: ug # Drawing Tool in Windows Forms Diagram -[WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control now provides a drawing tool to draw different types of connectors dynamically and connector types are listed below. +[WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control now provides a drawing tool to draw different types of connectors dynamically and connector types are listed below. 1. LineConnector 2. OrthogonalConnector @@ -43,4 +43,4 @@ Please refer to the Connectors sample from Windows Forms control Panel and find Sample : Windows Forms Control Panel -> Diagram -> Getting Started -> Connectors -N> Looking for the full WinForms Diagram component overview, features, pricing, and documentation? Visit the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) page. \ No newline at end of file +N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Dynamic-Properties.md b/WindowsForms/Diagram/Dynamic-Properties.md index a9081ac5a..16809c097 100644 --- a/WindowsForms/Diagram/Dynamic-Properties.md +++ b/WindowsForms/Diagram/Dynamic-Properties.md @@ -14,7 +14,7 @@ This feature lets the user add additional properties or data to the nodes and co The node’s [PropertyBag](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.Node.html#Syncfusion_Windows_Forms_Diagram_Node_PropertyBag) property, which is a key value pair, is used to add, edit, and remove the additional properties or data and can be serialized when saving the diagram. -The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) has built-in UI dialogs to add, edit, and remove the dynamic properties. +The [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) has built-in UI dialogs to add, edit, and remove the dynamic properties. Use Case Scenario: diff --git a/WindowsForms/Diagram/Event-Handlers.md b/WindowsForms/Diagram/Event-Handlers.md index 369cbaaf0..d7b9130f5 100644 --- a/WindowsForms/Diagram/Event-Handlers.md +++ b/WindowsForms/Diagram/Event-Handlers.md @@ -13,7 +13,7 @@ This section elaborates on the following: ### Diagram Events -[DiagramViewerEventSink](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.DiagramViewerEventSink.html#) class contains the events specific to the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram). The various events that can be invoked using this class are discussed in the following topics. +[DiagramViewerEventSink](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.DiagramViewerEventSink.html#) class contains the events specific to the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram). The various events that can be invoked using this class are discussed in the following topics. #### Node Collection Events diff --git a/WindowsForms/Diagram/Getting-Started.md b/WindowsForms/Diagram/Getting-Started.md index 801027021..859598eba 100644 --- a/WindowsForms/Diagram/Getting-Started.md +++ b/WindowsForms/Diagram/Getting-Started.md @@ -9,7 +9,7 @@ documentation: ug # Getting Started with Windows Forms Diagram -This section helps you understand and quickly get started using [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) in your Windows Forms applications. Control appearance and structure are defined, and the relevant classes are depicted. +This section helps you understand and quickly get started using [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) in your Windows Forms applications. Control appearance and structure are defined, and the relevant classes are depicted. ## Assembly deployment @@ -28,7 +28,7 @@ The Windows Forms Diagram package is comprised of the following controls: ### Diagram -The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control is an interactive two-dimensional graphics control for diagramming, technical drawing, visualization, and simulation applications. It provides a surface for rendering and manipulating 2-D shapes, text, images, and Windows Form controls. The UI supports drag and drop, scaling, zooming, rotation, grouping, ungrouping, connection points, layouts, and many other features. +The [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control is an interactive two-dimensional graphics control for diagramming, technical drawing, visualization, and simulation applications. It provides a surface for rendering and manipulating 2-D shapes, text, images, and Windows Form controls. The UI supports drag and drop, scaling, zooming, rotation, grouping, ungrouping, connection points, layouts, and many other features. The Diagram control’s architecture is composed of three objects, namely Model, View, and Controller and it provides a clear separation between data, visualization, and user interface. One advantage of model-view-controller architecture is that the parts are interchangeable. The model, view, and controller can be swapped in and out independently. diff --git a/WindowsForms/Diagram/Gridlines.md b/WindowsForms/Diagram/Gridlines.md index 628aee8a5..e2ba3fb2a 100644 --- a/WindowsForms/Diagram/Gridlines.md +++ b/WindowsForms/Diagram/Gridlines.md @@ -9,7 +9,7 @@ documentation: ug # Diagram Grid in Windows Forms Diagram -The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) grid is drawn with evenly spaced points that provides a visual guidance to the user. +The [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) grid is drawn with evenly spaced points that provides a visual guidance to the user. #### Behavior @@ -88,4 +88,4 @@ diagram1.View.Grid.SnapToGrid = true; ![Diagram-Gridlines](Diagram-Grid_images/Diagram-Grid_img1.jpeg) -N> Looking for the full WinForms Diagram component overview, features, pricing, and documentation? Visit the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) page. \ No newline at end of file +N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Grouping.md b/WindowsForms/Diagram/Grouping.md index 6fd000009..ff4623a45 100644 --- a/WindowsForms/Diagram/Grouping.md +++ b/WindowsForms/Diagram/Grouping.md @@ -12,7 +12,7 @@ documentation: ug A group is a node that acts as a transparent container for other nodes. A group is a composite node that controls a set of child nodes. The bounding rectangle of a group is the union of the bounds of its children. The group renders itself by iterating through its children and rendering them. Child nodes cannot be selected or manipulated individually. Members of the group are added and removed through the ICompositeNode interface. -There are two ways available to add a Group in [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control: +There are two ways available to add a Group in [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control: 1. Add the children to the group manually with the help of Group class methods. The below code snippet creates a group with two nodes. diff --git a/WindowsForms/Diagram/Guides.md b/WindowsForms/Diagram/Guides.md index 9f5da5e8f..44191c02c 100644 --- a/WindowsForms/Diagram/Guides.md +++ b/WindowsForms/Diagram/Guides.md @@ -10,7 +10,7 @@ documentation: ug # Guides in Windows Forms Diagram -Guides for the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control are viewable, non printing guidelines used to align a diagram node with other nodes. They provide support to align a diagram node with the boundary, center, or margin of other nodes. +Guides for the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control are viewable, non printing guidelines used to align a diagram node with other nodes. They provide support to align a diagram node with the boundary, center, or margin of other nodes. You can also change the visual style of Guides by using its LineStyle property. diff --git a/WindowsForms/Diagram/Layers.md b/WindowsForms/Diagram/Layers.md index 16b2bf730..e7abe6127 100644 --- a/WindowsForms/Diagram/Layers.md +++ b/WindowsForms/Diagram/Layers.md @@ -9,7 +9,7 @@ documentation: ug # Layers in Windows Forms Diagram -Layers are transparent sheets that can be added to the model and the objects are added to it. Layers allow to categorically arrange a set of nodes onto the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram). +Layers are transparent sheets that can be added to the model and the objects are added to it. Layers allow to categorically arrange a set of nodes onto the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram). diff --git a/WindowsForms/Diagram/Layout-Management.md b/WindowsForms/Diagram/Layout-Management.md index 75fabc5f8..5606a5969 100644 --- a/WindowsForms/Diagram/Layout-Management.md +++ b/WindowsForms/Diagram/Layout-Management.md @@ -13,7 +13,7 @@ Different Layout Manager are discussed under the following section: ## Manual Layout -The various types of Layout Managers that are supported by the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control to align nodes are as follows. +The various types of Layout Managers that are supported by the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control to align nodes are as follows. Some common Layout Manager settings are discussed in the below topic. diff --git a/WindowsForms/Diagram/Measurement-Units.md b/WindowsForms/Diagram/Measurement-Units.md index e72b3d6e4..e25297099 100644 --- a/WindowsForms/Diagram/Measurement-Units.md +++ b/WindowsForms/Diagram/Measurement-Units.md @@ -9,7 +9,7 @@ documentation: ug # Measurement Units in Windows Forms Diagram -The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control provides a multiple logical unit of measurement option. The following are the measurement units that are supported by the Diagram control. +The [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control provides a multiple logical unit of measurement option. The following are the measurement units that are supported by the Diagram control. * Pixel * Point @@ -63,7 +63,7 @@ The following code example illustrates to set measurement unit for the diagram. ### Custom Measurement unit -The MeasureUnits contain constant values to apply in our [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram). So, you can use MeasureUnits.Custom to set the customized unit and specify the Custom Measurement unit value by using the Syncfusion.Windows.Forms.Diagram.Model.CustomUnitValue property. +The MeasureUnits contain constant values to apply in our [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram). So, you can use MeasureUnits.Custom to set the customized unit and specify the Custom Measurement unit value by using the Syncfusion.Windows.Forms.Diagram.Model.CustomUnitValue property. The following code example illustrates how to set custom measurement unit for the Diagram control. {% tabs %} diff --git a/WindowsForms/Diagram/Nodes-or-Shapes.md b/WindowsForms/Diagram/Nodes-or-Shapes.md index ae395543f..94fc19973 100644 --- a/WindowsForms/Diagram/Nodes-or-Shapes.md +++ b/WindowsForms/Diagram/Nodes-or-Shapes.md @@ -9,7 +9,7 @@ documentation: ug # Nodes or Shapes in Windows Forms Diagram -The [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control supports different kinds of nodes. The following are the nodes that are supported by the Diagram control: +The [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control supports different kinds of nodes. The following are the nodes that are supported by the Diagram control: * TextNode * Shape @@ -405,4 +405,4 @@ diagram1.Controller.RotatingStyle = RenderingHelperStyle.DashedOutline ![Node-Selections_img5](Nodes-or-Shapes_images/Node-Selections_img5.png) -N> Looking for the full WinForms Diagram component overview, features, pricing, and documentation? Visit the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) page. \ No newline at end of file +N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Overview.md b/WindowsForms/Diagram/Overview.md index aa6c5b8af..1a58b66f5 100644 --- a/WindowsForms/Diagram/Overview.md +++ b/WindowsForms/Diagram/Overview.md @@ -9,7 +9,7 @@ documentation: ug # Windows Forms Diagram Overview -This section covers information on [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control, its key features, and prerequisites to use the control, its compatibility with various OS and browsers and finally the documentation details complimentary with the product. It comprises the following sub sections: +This section covers information on [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control, its key features, and prerequisites to use the control, its compatibility with various OS and browsers and finally the documentation details complimentary with the product. It comprises the following sub sections: ## Introduction To Essential® Diagram @@ -154,4 +154,4 @@ Class Reference    		 Online{{ '' | markdownify }} (Navigate to the Windows Forms User Guide. Select {{ '_Diagram_' | markdownify }} in the second text box, and then click the Class Reference link found in the upper right section of the page.)Installed DocumentationDashboard -> Documentation -> Installed Documentation.
    -N> You can refer to our [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control feature tour page for its groundbreaking feature representations. You can also explore our [WinForms Diagram example](https://github.com/syncfusion/winforms-demos/tree/master/diagram) that shows you how to render and configure the Diagram. +N> You can refer to our [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control feature tour page for its groundbreaking feature representations. You can also explore our [WinForms Diagram example](https://github.com/syncfusion/winforms-demos/tree/master/diagram) that shows you how to render and configure the Diagram. diff --git a/WindowsForms/Diagram/Ports-And-Connections.md b/WindowsForms/Diagram/Ports-And-Connections.md index 33dff6c79..e4c0b8864 100644 --- a/WindowsForms/Diagram/Ports-And-Connections.md +++ b/WindowsForms/Diagram/Ports-And-Connections.md @@ -16,7 +16,7 @@ Port is an object used to establish a connection between the node and the link. ### Central Port -By default, the central port for a [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) is enabled using the EnableCentralPort property available for the node. +By default, the central port for a [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) is enabled using the EnableCentralPort property available for the node. diff --git a/WindowsForms/Diagram/Rulers.md b/WindowsForms/Diagram/Rulers.md index 4a4b856ef..a96d3b7a1 100644 --- a/WindowsForms/Diagram/Rulers.md +++ b/WindowsForms/Diagram/Rulers.md @@ -9,7 +9,7 @@ documentation: ug # Rulers in Windows Forms Diagram -Rulers can be enabled by setting the ShowRulers property for the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control. The rulers will automatically inherit the MeasurementUnit set for the diagram model and get converted accordingly. +Rulers can be enabled by setting the ShowRulers property for the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control. The rulers will automatically inherit the MeasurementUnit set for the diagram model and get converted accordingly. The height of the ruler can be set through RulersHeight property. @@ -185,4 +185,4 @@ Sample diagram is as follows, ![Change HRuler Minor lines colors](Rulers_images/Rulers_img3.jpeg) -N> Looking for the full WinForms Diagram component overview, features, pricing, and documentation? Visit the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) page. +N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. diff --git a/WindowsForms/Diagram/Serialization/Diagram-Serialization.md b/WindowsForms/Diagram/Serialization/Diagram-Serialization.md index 657c6bd41..e1b82b900 100644 --- a/WindowsForms/Diagram/Serialization/Diagram-Serialization.md +++ b/WindowsForms/Diagram/Serialization/Diagram-Serialization.md @@ -13,7 +13,7 @@ Serialization is the process of converting the state of diagram objects into a b ## Save -In the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram), [DataContractSerializer](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.serialization.datacontractserializer?view=net-8.0) is used for serialization. The features provided by `DataContractSerializer` apply to diagram serialization, supporting saving the diagram to a stream while preserving all its properties. +In the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram), [DataContractSerializer](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.serialization.datacontractserializer?view=net-8.0) is used for serialization. The features provided by `DataContractSerializer` apply to diagram serialization, supporting saving the diagram to a stream while preserving all its properties. ### Saving a Diagram via Filename diff --git a/WindowsForms/Diagram/Supported-Controls.md b/WindowsForms/Diagram/Supported-Controls.md index bb62c24c1..baf84ed3b 100644 --- a/WindowsForms/Diagram/Supported-Controls.md +++ b/WindowsForms/Diagram/Supported-Controls.md @@ -11,7 +11,7 @@ documentation: ug The controls supported by Essential® Diagram are as follows. -The controls associated with the [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control are illustrated in the following image. +The controls associated with the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control are illustrated in the following image. diff --git a/WindowsForms/Diagram/Touch-Support.md b/WindowsForms/Diagram/Touch-Support.md index 8fe86bb69..3f6e07cbd 100644 --- a/WindowsForms/Diagram/Touch-Support.md +++ b/WindowsForms/Diagram/Touch-Support.md @@ -9,7 +9,7 @@ documentation: ug # Touch Support in Windows Forms Diagram -Touch support for [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) control helps to create sophisticated diagrams quickly and easily by interacting with Diagram nodes through touch gestures such as Tap, Double Tap, Long Press, Pinch, and more. These touch gestures help you perform actions such as select, label text editing, open the context menu, zoom in, and zoom out. +Touch support for [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) control helps to create sophisticated diagrams quickly and easily by interacting with Diagram nodes through touch gestures such as Tap, Double Tap, Long Press, Pinch, and more. These touch gestures help you perform actions such as select, label text editing, open the context menu, zoom in, and zoom out. ## Properties diff --git a/WindowsForms/Diagram/Zoom-And-Pan.md b/WindowsForms/Diagram/Zoom-And-Pan.md index 350bb7230..396b95774 100644 --- a/WindowsForms/Diagram/Zoom-And-Pan.md +++ b/WindowsForms/Diagram/Zoom-And-Pan.md @@ -12,7 +12,7 @@ documentation: ug ## Zooming Support -One of the interactive features of [WinForms Diagram](https://www.syncfusion.com/winforms-ui-controls/diagram) is its zooming capabilities. This feature allows you to interactively zoom in and out of the diagram in the following ways: +One of the interactive features of [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) is its zooming capabilities. This feature allows you to interactively zoom in and out of the diagram in the following ways: * Zoom to the center of the diagram. * Zoom to the top left of the diagram. diff --git a/WindowsForms/GridGrouping/Overview.md b/WindowsForms/GridGrouping/Overview.md index c5b66d36f..57d2e4afa 100644 --- a/WindowsForms/GridGrouping/Overview.md +++ b/WindowsForms/GridGrouping/Overview.md @@ -32,4 +32,4 @@ The grid grouping control is a very powerful data grid with built-in support for * Serialization: Supports serializing the grid data to Binary, SOAP, and XML format and vice versa. * Touch support: Completely supports resizing, dragging-dropping a column, sorting, filtering, grouping, etc. in touch devices. -N> Looking for the full WinForms Data Grid component overview, features, pricing, and documentation? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file +N> Looking for the full WinForms Data Grid component overview, features, and pricing? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file diff --git a/WindowsForms/Scheduler/Getting-Started.md b/WindowsForms/Scheduler/Getting-Started.md index 6d139ef12..20f7e140c 100644 --- a/WindowsForms/Scheduler/Getting-Started.md +++ b/WindowsForms/Scheduler/Getting-Started.md @@ -757,4 +757,4 @@ The C# WinForms Calendar Scheduler control supports creating the recurring appoi [Create the recurrence appointment in WinForms Calendar Scheduler control ](time-interval) -N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full Winforms Scheduler component overview, features, pricing, and documentation? Visit the [WinForms Scheduler](https://www.syncfusion.com/winforms-ui-controls/scheduler) page. +N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full Winforms Scheduler component overview, features, and pricing? Visit the [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler) page. diff --git a/WindowsForms/Scheduler/Overview.md b/WindowsForms/Scheduler/Overview.md index 43ebbd931..a14078437 100644 --- a/WindowsForms/Scheduler/Overview.md +++ b/WindowsForms/Scheduler/Overview.md @@ -32,4 +32,4 @@ The [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-sched * Recurrence appointment: Supports schedule recurring appointments to repeat daily, weekly, monthly, or yearly. * Touch support: Completely supports swiping, panning, zooming, and more. -N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full WinForms Scheduler component overview, features, pricing, and documentation? Visit the [WinForms Scheduler](https://www.syncfusion.com/winforms-ui-controls/scheduler) page. +N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full WinForms Scheduler component overview, features, pricing, and documentation? Visit the [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler) page. From 445e2f8dd7dbfb629cc059b139a2b3ea95a7338d Mon Sep 17 00:00:00 2001 From: AshaBhaskaran Date: Fri, 17 Jul 2026 15:46:07 +0530 Subject: [PATCH 24/36] remove the note section --- WindowsForms/DataGrid/GettingStarted.md | 2 -- WindowsForms/DataGrid/Overview.md | 2 -- WindowsForms/Diagram/Drawing-Tool.md | 2 -- WindowsForms/Diagram/Gridlines.md | 2 -- WindowsForms/Diagram/Nodes-or-Shapes.md | 2 -- WindowsForms/Diagram/Rulers.md | 2 +- WindowsForms/GridGrouping/Overview.md | 2 -- WindowsForms/Scheduler/Getting-Started.md | 2 +- WindowsForms/Scheduler/Overview.md | 2 +- 9 files changed, 3 insertions(+), 15 deletions(-) diff --git a/WindowsForms/DataGrid/GettingStarted.md b/WindowsForms/DataGrid/GettingStarted.md index b88f4843c..f1f675686 100644 --- a/WindowsForms/DataGrid/GettingStarted.md +++ b/WindowsForms/DataGrid/GettingStarted.md @@ -565,5 +565,3 @@ Private Sub OnMouseDown(ByVal sender As Object, ByVal e As MouseEventArgs) End Sub {% endhighlight %} {% endtabs %} - -N> Looking for the full WinForms Data Grid component overview, features, and pricing? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file diff --git a/WindowsForms/DataGrid/Overview.md b/WindowsForms/DataGrid/Overview.md index bfb452648..e708168b7 100644 --- a/WindowsForms/DataGrid/Overview.md +++ b/WindowsForms/DataGrid/Overview.md @@ -271,5 +271,3 @@ Large amount of data can be loaded in less time by setting {{'[EnableDataVirtual The [`Windows Forms SfDataGrid`](https://support.syncfusion.com/kb/desktop/section/952) Knowledge Base section contains responses to some of the most common questions that other customers have asked us before. So this will 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/section/952), the [`forum`](https://www.syncfusion.com/forums/windowsforms) section also contains responses to questions that other customers have asked us in the past. - -N> Looking for the full WinForms Data Grid component overview, features, and pricing? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Drawing-Tool.md b/WindowsForms/Diagram/Drawing-Tool.md index 26dd87639..7b7b0c6f1 100644 --- a/WindowsForms/Diagram/Drawing-Tool.md +++ b/WindowsForms/Diagram/Drawing-Tool.md @@ -42,5 +42,3 @@ diagram1.Controller.ActivateTool("OrgLineConnectorTool") Please refer to the Connectors sample from Windows Forms control Panel and find navigation path for the Connector sample as link. Sample : Windows Forms Control Panel -> Diagram -> Getting Started -> Connectors - -N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Gridlines.md b/WindowsForms/Diagram/Gridlines.md index e2ba3fb2a..610131459 100644 --- a/WindowsForms/Diagram/Gridlines.md +++ b/WindowsForms/Diagram/Gridlines.md @@ -87,5 +87,3 @@ diagram1.View.Grid.SnapToGrid = true; {% endtabs %} ![Diagram-Gridlines](Diagram-Grid_images/Diagram-Grid_img1.jpeg) - -N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Nodes-or-Shapes.md b/WindowsForms/Diagram/Nodes-or-Shapes.md index 94fc19973..a2264962c 100644 --- a/WindowsForms/Diagram/Nodes-or-Shapes.md +++ b/WindowsForms/Diagram/Nodes-or-Shapes.md @@ -404,5 +404,3 @@ diagram1.Controller.RotatingStyle = RenderingHelperStyle.DashedOutline ![Node-Selections_img5](Nodes-or-Shapes_images/Node-Selections_img5.png) - -N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. \ No newline at end of file diff --git a/WindowsForms/Diagram/Rulers.md b/WindowsForms/Diagram/Rulers.md index a96d3b7a1..5bddc3e52 100644 --- a/WindowsForms/Diagram/Rulers.md +++ b/WindowsForms/Diagram/Rulers.md @@ -185,4 +185,4 @@ Sample diagram is as follows, ![Change HRuler Minor lines colors](Rulers_images/Rulers_img3.jpeg) -N> Looking for the full WinForms Diagram component overview, features, and pricing? Visit the [WinForms Diagram](https://www.syncfusion.com/diagram-sdk/winforms-diagram) page. + diff --git a/WindowsForms/GridGrouping/Overview.md b/WindowsForms/GridGrouping/Overview.md index 57d2e4afa..53edcef79 100644 --- a/WindowsForms/GridGrouping/Overview.md +++ b/WindowsForms/GridGrouping/Overview.md @@ -31,5 +31,3 @@ The grid grouping control is a very powerful data grid with built-in support for * Expression fields: Supports computing and displaying the values based on another columns value. * Serialization: Supports serializing the grid data to Binary, SOAP, and XML format and vice versa. * Touch support: Completely supports resizing, dragging-dropping a column, sorting, filtering, grouping, etc. in touch devices. - -N> Looking for the full WinForms Data Grid component overview, features, and pricing? Visit the [WinForms Data Grid](https://www.syncfusion.com/winforms-ui-controls/datagrid) page. \ No newline at end of file diff --git a/WindowsForms/Scheduler/Getting-Started.md b/WindowsForms/Scheduler/Getting-Started.md index 20f7e140c..7fe5bb66d 100644 --- a/WindowsForms/Scheduler/Getting-Started.md +++ b/WindowsForms/Scheduler/Getting-Started.md @@ -757,4 +757,4 @@ The C# WinForms Calendar Scheduler control supports creating the recurring appoi [Create the recurrence appointment in WinForms Calendar Scheduler control ](time-interval) -N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full Winforms Scheduler component overview, features, and pricing? Visit the [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler) page. +N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. \ No newline at end of file diff --git a/WindowsForms/Scheduler/Overview.md b/WindowsForms/Scheduler/Overview.md index a14078437..ae65337f3 100644 --- a/WindowsForms/Scheduler/Overview.md +++ b/WindowsForms/Scheduler/Overview.md @@ -32,4 +32,4 @@ The [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-sched * Recurrence appointment: Supports schedule recurring appointments to repeat daily, weekly, monthly, or yearly. * Touch support: Completely supports swiping, panning, zooming, and more. -N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full WinForms Scheduler component overview, features, pricing, and documentation? Visit the [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler) page. +N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. \ No newline at end of file From 584773ee72461431e5efffa91127644bc9cb0b5d Mon Sep 17 00:00:00 2001 From: Nithi-22 <90109517+Nithi-22@users.noreply.github.com> Date: Fri, 17 Jul 2026 15:52:28 +0530 Subject: [PATCH 25/36] updated --- WindowsForms/ComboBox/GettingStarted.md | 5 ----- WindowsForms/ListView/GettingStarted.md | 5 ----- WindowsForms/Syntax-Editor/Getting-Started.md | 5 ----- 3 files changed, 15 deletions(-) diff --git a/WindowsForms/ComboBox/GettingStarted.md b/WindowsForms/ComboBox/GettingStarted.md index 660b36e6c..693df82d1 100644 --- a/WindowsForms/ComboBox/GettingStarted.md +++ b/WindowsForms/ComboBox/GettingStarted.md @@ -10,11 +10,6 @@ documentation: ug # Getting Started with Windows Forms ComboBox (SfComboBox) This section provides a quick overview for working with the ComboBox in WinForms. -> **Prerequisites** -> - Visual Studio 2017 or later with the **.NET desktop development** workload installed. -> - A WinForms project that targets a .NET Framework (4.5+) or .NET (Core 3.1 / 5 / 6 / 7 / 8) version supported by your Syncfusion WinForms release. -> - Syncfusion WinForms controls installed locally, or a reference to the `Syncfusion.ComboBox.WinForms` NuGet package (see [Assembly Deployment](#assembly-deployment)). - ## Assembly Deployment Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sfcombobox) section for the list of assemblies or NuGet package that must be referenced to use the control in any application. diff --git a/WindowsForms/ListView/GettingStarted.md b/WindowsForms/ListView/GettingStarted.md index 769fce722..3b5942c46 100644 --- a/WindowsForms/ListView/GettingStarted.md +++ b/WindowsForms/ListView/GettingStarted.md @@ -10,11 +10,6 @@ documentation: ug # Getting Started with Windows Forms ListView (SfListView) This section provides a quick overview for getting started with SfListView for WinForms. Walk through the entire process of creating a real-world SfListView. -> **Prerequisites** -> - Visual Studio 2017 or later with the **.NET desktop development** workload installed. -> - A WinForms project that targets a .NET Framework (4.5+) or .NET (Core 3.1 / 5 / 6 / 7 / 8) version supported by your Syncfusion WinForms release. -> - Syncfusion WinForms controls installed locally, or a reference to the `Syncfusion.ListView.WinForms` NuGet package (see [Assembly Deployment](#assembly-deployment)). - ## Assembly Deployment Refer to the [control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#sflistview) section for the list of assemblies or NuGet package that must be referenced to use the control in any application. diff --git a/WindowsForms/Syntax-Editor/Getting-Started.md b/WindowsForms/Syntax-Editor/Getting-Started.md index 3e9c5c8ff..2b492edd8 100644 --- a/WindowsForms/Syntax-Editor/Getting-Started.md +++ b/WindowsForms/Syntax-Editor/Getting-Started.md @@ -11,11 +11,6 @@ documentation: ug This section explains how to create an interactive code editor application like the Microsoft Visual Studio Editor by using the EditControl. -> **Prerequisites** -> - Visual Studio 2017 or later with the **.NET desktop development** workload installed. -> - A WinForms project that targets a .NET Framework (4.5+) or .NET (Core 3.1 / 5 / 6 / 7 / 8) version supported by your Syncfusion WinForms release. -> - Syncfusion WinForms controls installed locally, or a NuGet reference to `Syncfusion.Edit.Windows` (see [Assembly Deployment](#assembly-deployment)). - ## Assembly deployment Refer to the [Control Dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#editcontrol) section for the list of assemblies or the NuGet package details that must be referenced to use the control in any application. From eaf2cf3c9fa23f3b67b1e24ccf97a5f3aef4d411 Mon Sep 17 00:00:00 2001 From: VijayakumarSF4470 <160592658+VijayakumarSF4470@users.noreply.github.com> Date: Fri, 17 Jul 2026 17:30:29 +0530 Subject: [PATCH 26/36] 1041550: Need to create documentation file for WinForms platform. --- WindowsForms/mcp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WindowsForms/mcp.md b/WindowsForms/mcp.md index 9296ff823..27ca31099 100644 --- a/WindowsForms/mcp.md +++ b/WindowsForms/mcp.md @@ -141,7 +141,7 @@ Create a configuration file in your project folder to install the server for you ## Common use cases -The examples below showcase how the different MCP tools handle real-world WinForms development scenarios. Tools can be invoked directly, as shown in the examples below, for specific needs. Alternatively, an AI assistant can automatically select the most appropriate tool based on the request. +The examples below showcase how the `search_docs` tool handles real-world WinForms development scenarios. The tool can be invoked directly, as shown in the examples below, for specific needs. Alternatively, an AI assistant can automatically invoke it based on the request. **Get Started** From e321294e0c16a510c98b5326e8ca23b13589959f Mon Sep 17 00:00:00 2001 From: VijayakumarSF4470 <160592658+VijayakumarSF4470@users.noreply.github.com> Date: Fri, 17 Jul 2026 20:05:50 +0530 Subject: [PATCH 27/36] 1041550: Need to create documentation file for WinForms platform. --- WindowsForms/mcp.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/WindowsForms/mcp.md b/WindowsForms/mcp.md index 27ca31099..7425554f8 100644 --- a/WindowsForms/mcp.md +++ b/WindowsForms/mcp.md @@ -25,7 +25,7 @@ These tools speed up development and reinforce best practices for Syncfusion com Before beginning, ensure the following prerequisites are met: -- **.NET Framework** 4.7.2 or higher, or **.NET Core** 3.1 or higher +- Microsoft [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) or later - A **compatible MCP client** (VS Code, Syncfusion® Code Studio, Cursor, JetBrains, etc.) - An active [Syncfusion® API key](https://syncfusion.com/account/api-key) - A **WinForms application** (existing or new); see [Windows Forms application that includes Syncfusion Windows Forms](https://help.syncfusion.com/windowsforms/overview) @@ -48,7 +48,9 @@ Generate the Syncfusion® API key from the [ ### Setting Up in MCP Clients -Create a configuration file in your project folder to install the server for your workspace. **Replace `YOUR_API_KEY_FILE_PATH` with the path to your API key file.** +Create a configuration file in your project folder to install the server for your workspace. **Replace `YOUR_API_KEY_FILE_PATH` with the path to your API key file.** The tabs below show a working configuration for each supported MCP client. + +**For .NET 10** : {% tabs %} {% highlight bash tabtitle="VS Code" %} @@ -137,6 +139,35 @@ Create a configuration file in your project folder to install the server for you {% endhighlight %} {% endtabs %} +**For .NET 8 / .NET 9 (using a local tool):** + +You can install the Syncfusion WinForms MCP server as a local tool without a global installation. For guidance on installing and managing local .NET tools, refer the [documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use). + +1. Install the Syncfusion WinForms MCP tool locally: + + ````bash + dotnet tool install Syncfusion.WinForms.MCP + ```` + +2. In your MCP client config (`.vscode/mcp.json`, `.codestudio/mcp.json`, `.cursor/mcp.json`, or the JetBrains MCP settings), replace the server entry with: + + ````json + { + "servers": { + "sf-winforms-mcp": { + "type": "stdio", + "command": "dotnet", + "args": ["tool", "run", "syncfusion-winforms-mcp"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } + } + ```` + **Verifying Installation** Check your editor's MCP Server list for `sf-winforms-mcp` with a **Connected** status to confirm a successful installation. ## Common use cases From 442aeed4a15c0c2995263d2cef89ed5c1d800f0e Mon Sep 17 00:00:00 2001 From: VijayakumarSF4470 <160592658+VijayakumarSF4470@users.noreply.github.com> Date: Mon, 20 Jul 2026 12:28:29 +0530 Subject: [PATCH 28/36] 1041550: Need to create documentation file for WinForms platform. --- WindowsForms/mcp.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/WindowsForms/mcp.md b/WindowsForms/mcp.md index 7425554f8..90b02d3e5 100644 --- a/WindowsForms/mcp.md +++ b/WindowsForms/mcp.md @@ -62,7 +62,7 @@ Create a configuration file in your project folder to install the server for you "sf-winforms-mcp": { "type": "stdio", "command": "dnx", - "args": ["Syncfusion.WinForms.MCP.dll"], + "args": ["Syncfusion.WinForms.MCP", "--yes"], "env": { "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // or @@ -71,7 +71,6 @@ Create a configuration file in your project folder to install the server for you } } } - {% endhighlight %} {% highlight bash tabtitle="Code Studio" %} @@ -82,7 +81,7 @@ Create a configuration file in your project folder to install the server for you "sf-winforms-mcp": { "type": "stdio", "command": "dnx", - "args": ["Syncfusion.WinForms.MCP.dll"], + "args": ["Syncfusion.WinForms.MCP", "--yes"], "env": { "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // or @@ -103,7 +102,7 @@ Create a configuration file in your project folder to install the server for you "mcpServers": { "sf-winforms-mcp": { "command": "dnx", - "args": ["Syncfusion.WinForms.MCP.dll"], + "args": ["Syncfusion.WinForms.MCP", "--yes"], "env": { "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // or @@ -124,7 +123,7 @@ Create a configuration file in your project folder to install the server for you "mcpServers": { "sf-winforms-mcp": { "command": "dnx", - "args": ["Syncfusion.WinForms.MCP.dll"], + "args": ["Syncfusion.WinForms.MCP", "--yes"], "env": { "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // or @@ -185,11 +184,12 @@ Use `search_docs` to get contextual guidance, code snippets, and configuration e {% endpromptcards %} {% promptcards %} -{% promptcard RichTextEditor Setup %} -#search_docs How do I set up the Syncfusion WinForms RichTextEditor with a custom toolbar? +{% promptcard Scheduler Views Setup %} +#search_docs How do I configure the Syncfusion WPF Scheduler to support Day, Week,Month, TimelineDay, TimelineWeek, TimelineWorkWeek, and TimelineMonth views, and add a quick view switching option? {% endpromptcard %} {% endpromptcards %} + **Implement Features** Get step-by-step help for adding specific features to components that are already in the project. @@ -242,7 +242,7 @@ The table below lists frequently encountered issues and suggested resolutions to | Issue | Solution | |-------|----------| -| **Server failed to start** | Ensure .NET Framework 4.7.2+ or .NET Core 3.1+ is installed, verify JSON syntax in the config file, and restart your IDE. | +| **Server failed to start** | Update to .NET 8 SDK or higher, verify JSON syntax in the config file, and restart your IDE. | | **Invalid API key** | Verify your key is active at the [Syncfusion Account Page](https://syncfusion.com/account/api-key). | | **Incorrect API key config** | For the file path: verify file location and content. For inline key: check the key is correctly updated. | | **Wrong config file location** | VS Code: `.vscode/mcp.json` • Code Studio: `.codestudio/mcp.json` • Cursor: `.cursor/mcp.json` in the workspace root. | From a574a2401962dbf74df230e346de60ee1a8f9d62 Mon Sep 17 00:00:00 2001 From: VijayakumarSF4470 <160592658+VijayakumarSF4470@users.noreply.github.com> Date: Mon, 20 Jul 2026 13:03:10 +0530 Subject: [PATCH 29/36] 1041550: Need to create documentation file for WinForms platform. --- WindowsForms/mcp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WindowsForms/mcp.md b/WindowsForms/mcp.md index 90b02d3e5..3b0e57066 100644 --- a/WindowsForms/mcp.md +++ b/WindowsForms/mcp.md @@ -148,7 +148,7 @@ You can install the Syncfusion WinForms MCP server as a local tool without a glo dotnet tool install Syncfusion.WinForms.MCP ```` -2. In your MCP client config (`.vscode/mcp.json`, `.codestudio/mcp.json`, `.cursor/mcp.json`, or the JetBrains MCP settings), replace the server entry with: +2. In your MCP client config (for example, `.vscode/mcp.json`), replace the server entry with: ````json { From a31cb3ee0b8fdb24708f60ae0bbdf8ef6f71aa47 Mon Sep 17 00:00:00 2001 From: Deepak Raj Sundar Date: Tue, 21 Jul 2026 03:57:25 +0530 Subject: [PATCH 30/36] Added the release notes MD file and corresponding node entry in the TOC.html file --- WindowsForms-toc.html | 2 +- WindowsForms/Release-notes/v34.1.32.md | 92 ++++++++++++++++++++++++++ 2 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 WindowsForms/Release-notes/v34.1.32.md diff --git a/WindowsForms-toc.html b/WindowsForms-toc.html index 1d335b587..0cc20dc9f 100644 --- a/WindowsForms-toc.html +++ b/WindowsForms-toc.html @@ -6159,7 +6159,7 @@
  • Release Notes -
    • 2026 Volume 2 - v34.*
      • +
      • 2026 Volume 2 - v34.*
      • 2026 Volume 1 - v33.*
        • Weekly Nuget Release diff --git a/WindowsForms/Release-notes/v34.1.32.md b/WindowsForms/Release-notes/v34.1.32.md new file mode 100644 index 000000000..3fbddbd4f --- /dev/null +++ b/WindowsForms/Release-notes/v34.1.32.md @@ -0,0 +1,92 @@ +--- +title: Essential Studio® for Windows Forms Release Notes - v34.1.32 +description: Learn here about the controls in the Essential Studio® for Windows Forms Weekly Nuget Release - Release Notes - v34.1.32 +platform: windowsforms +documentation: ug +--- + +# Essential Studio® for Windows Forms - v34.1.32 Release Notes + +{% include release-info.html date="July 21, 2026" version="v34.1.32" passed="9713" failed="0" %} + +{% directory path: _includes/release-notes/v34.1.32 %} + +{% include {{file.url}} %} + +{% enddirectory %} + +## Test Results + +| Component Name | Test Cases | Passed | Failed | Remarks | +|----------------|------------|--------|--------|---------| +| AutoComplete | 59 | 59 | 0 | All Passed | +| AutoLabel | 3 | 3 | 0 | All Passed | +| Breadcrumb | 2 | 2 | 0 | All Passed | +| Button | 4 | 4 | 0 | All Passed | +| ButtonAdv | 3 | 3 | 0 | All Passed | +| Calendar | 2 | 2 | 0 | All Passed | +| Carousel | 7 | 7 | 0 | All Passed | +| Chart | 906 | 906 | 0 | All Passed | +| CheckBox | 134 | 134 | 0 | All Passed | +| Color Picker | 28 | 28 | 0 | All Passed | +| Color Picker DropDown | 3 | 3 | 0 | All Passed | +| ComboBox | 70 | 70 | 0 | All Passed | +| ComboBoxAdv | 339 | 339 | 0 | All Passed | +| ComboDropDown | 2 | 2 | 0 | All Passed | +| CommandBarController | 1 | 1 | 0 | All Passed | +| CurrencyEdit | 1 | 1 | 0 | All Passed | +| DataGrid | 943 | 943 | 0 | All Passed | +| DateTimePicker | 104 | 104 | 0 | All Passed | +| DateTimePickerAdv | 44 | 44 | 0 | All Passed | +| Digital Gauge | 7 | 7 | 0 | All Passed | +| Docking Manager | 1971 | 1971 | 0 | All Passed | +| DomainUpDownExt | 4 | 4 | 0 | All Passed | +| DoubleTextBox | 3 | 3 | 0 | All Passed | +| FontListBox | 2 | 2 | 0 | All Passed | +| Form | 23 | 23 | 0 | All Passed | +| Gradient Panel | 4 | 4 | 0 | All Passed | +| GroupView | 2 | 2 | 0 | All Passed | +| HTML Viewer | 53 | 53 | 0 | All Passed | +| Image Streamer | 1 | 1 | 0 | All Passed | +| Linear Gauge | 58 | 58 | 0 | All Passed | +| ListView | 65 | 65 | 0 | All Passed | +| Menu | 3 | 3 | 0 | All Passed | +| MessageBox | 2 | 2 | 0 | All Passed | +| Metro Form | 26 | 26 | 0 | All Passed | +| MonthCalendarAdv | 25 | 25 | 0 | All Passed | +| Multicolumn ComboBox | 8 | 8 | 0 | All Passed | +| Multicolumn TreeView | 104 | 104 | 0 | All Passed | +| MultiSelectionComboBox | 7 | 7 | 0 | All Passed | +| Navigation Drawer | 52 | 52 | 0 | All Passed | +| Navigation Pane | 38 | 38 | 0 | All Passed | +| Numeric TextBox | 5 | 5 | 0 | All Passed | +| NumericUpdown | 6 | 6 | 0 | All Passed | +| Office 2007 Form | 61 | 61 | 0 | All Passed | +| PercentTextBox | 2 | 2 | 0 | All Passed | +| Pivot Chart | 124 | 124 | 0 | All Passed | +| Pivot Grid | 216 | 216 | 0 | All Passed | +| Popup | 4 | 4 | 0 | All Passed | +| Progress Bar | 4 | 4 | 0 | All Passed | +| Radial Gauge | 85 | 85 | 0 | All Passed | +| Radial Menu | 2 | 2 | 0 | All Passed | +| Radial Slider | 18 | 18 | 0 | All Passed | +| Range Slider | 7 | 7 | 0 | All Passed | +| Rating Control | 1 | 1 | 0 | All Passed | +| Ribbon | 1492 | 1492 | 0 | All Passed | +| Scroll Frame | 1 | 1 | 0 | All Passed | +| SfDataPager | 95 | 95 | 0 | All Passed | +| Spell Checker | 51 | 51 | 0 | All Passed | +| Splash Screen | 2 | 2 | 0 | All Passed | +| Split Button | 15 | 15 | 0 | All Passed | +| StatusStrip | 21 | 21 | 0 | All Passed | +| SuperToolTip | 1 | 1 | 0 | All Passed | +| Syntax Editor | 534 | 534 | 0 | All Passed | +| Tabbed Form | 25 | 25 | 0 | All Passed | +| TabbedMdiManager | 481 | 481 | 0 | All Passed | +| TabControl | 729 | 729 | 0 | All Passed | +| TextBox | 13 | 13 | 0 | All Passed | +| ToolBar | 5 | 5 | 0 | All Passed | +| TrackBar | 1 | 1 | 0 | All Passed | +| Tree Navigator | 17 | 17 | 0 | All Passed | +| TreeView | 474 | 474 | 0 | All Passed | +| XpTaskbar | 108 | 108 | 0 | All Passed | \ No newline at end of file From ca41c9972bd9663fdbdb4c662eecb84583a20d7e Mon Sep 17 00:00:00 2001 From: Paranthaman Palani Date: Tue, 21 Jul 2026 17:55:33 +0530 Subject: [PATCH 31/36] Moved the staging changes to live --- .../how-to-register-in-an-application.md | 33 +++++++++++++++---- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/WindowsForms/Licensing/how-to-register-in-an-application.md b/WindowsForms/Licensing/how-to-register-in-an-application.md index 8777b70d1..5965a152b 100644 --- a/WindowsForms/Licensing/how-to-register-in-an-application.md +++ b/WindowsForms/Licensing/how-to-register-in-an-application.md @@ -1,25 +1,44 @@ --- layout: post title: Overview of Syncfusion license registration - Syncfusion -description: Learn here about how to register Syncfusion Windows Forms license key for Windows Forms application for license validation. +description: Learn how to register the Syncfusion license key in a Windows Forms application for license validation. platform: windowsforms control: Essential Studio documentation: ug --- - -# Register Syncfusion License key in Windows Forms application +# Register Syncfusion license key in a Windows Forms application The generated license key is just a string that needs to be registered before any Syncfusion control is initiated. The following code is used to register the license. +**Registering a single license key** + {% tabs %} {% highlight c# %} Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY"); {% endhighlight %} {% endtabs %} -N> * Place the license key between double quotes. Also, ensure that Syncfusion.Licensing.dll is referenced in your project where the license key is being registered. -* Syncfusion license validation is done 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. +**Registering multiple license keys** + +You can register multiple license keys using either a comma (,) or a semicolon (;) as the separator between keys. + +{% tabs %} +{% highlight c# %} +Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY_1,YOUR LICENSE KEY_2,..."); +{% endhighlight %} +{% endtabs %} + +or + +{% tabs %} +{% highlight c# %} +Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY_1;YOUR LICENSE KEY_2;..."); +{% endhighlight %} +{% endtabs %} + +N> * Place the license key between double quotes. Also, ensure that Syncfusion.Licensing.dll is referenced in your project where the license key is being registered (see the package name in the Prerequisites note above). +* Syncfusion license validation is done 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. I> Syncfusion license keys can be validated during the Continuous Integration (CI) processes to ensure proper licensing and prevent licensing errors during deployment. Refer to the [CI License Validation](https://help.syncfusion.com/windowsforms/licensing/licensing-faq/ci-license-validation) section for detailed instructions on how to implement it. @@ -34,8 +53,8 @@ N> * If the **Application.Designer.vb** file is not included by default in the p {% highlight c# %} static void Main() { - //Register Syncfusion license - Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY"); + //Register Syncfusion license + Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY"); Application.EnableVisualStyles(); Application.SetCompatibleTextRenderingDefault(false); From 725a0e9f91bac1f2a3ce0cb2ac9e3d0e3adf1c1d Mon Sep 17 00:00:00 2001 From: VijayakumarSF4470 <160592658+VijayakumarSF4470@users.noreply.github.com> Date: Wed, 22 Jul 2026 16:37:28 +0530 Subject: [PATCH 32/36] 1041550: Update the mcp server Documentation WinForms. --- WindowsForms/mcp.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/WindowsForms/mcp.md b/WindowsForms/mcp.md index 3b0e57066..f2e808fbc 100644 --- a/WindowsForms/mcp.md +++ b/WindowsForms/mcp.md @@ -140,7 +140,7 @@ Create a configuration file in your project folder to install the server for you **For .NET 8 / .NET 9 (using a local tool):** -You can install the Syncfusion WinForms MCP server as a local tool without a global installation. For guidance on installing and managing local .NET tools, refer the [documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use). +You can install the Syncfusion WinForms MCP server as a local tool without a global installation. For guidance on installing and managing local .NET tools, refer to the [documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use). 1. Install the Syncfusion WinForms MCP tool locally: @@ -230,7 +230,7 @@ To get the most out of the Syncfusion® WinF - **Use Descriptive Queries** - Avoid overly brief or ambiguous requests. Providing sufficient detail helps improve the accuracy and relevance of the response. - **Stay Consistent** - Keep file organization, naming conventions, and coding standards consistent throughout your WinForms project. - **Start Fresh for New Topics** - Begin a new chat when switching to a different component or task to maintain clean context. -- **Use Advanced AI Models** - For best results, use **Claude Sonnet 4.5 or higher**. Other compatible models include **GPT-5 and Gemini 3 Pro**. Higher-capability models produce more accurate component implementations. +- **Use Advanced AI Models** - For the best results, use advanced AI models such as the latest-generation **Claude**, **GPT**, or **Gemini** models. - **For Troubleshooting** - Use AI suggestions for common issues; consult the [official documentation](https://help.syncfusion.com/windowsforms/overview) or [support](https://support.syncfusion.com/support/tickets/create) for complex problems. - **Minimize Active Tools** - Limit the number of active MCP tools in your IDE to prevent tool-selection ambiguity and improve response accuracy. @@ -259,6 +259,6 @@ The Syncfusion® MCP Servers are designed wi The MCP Server acts purely as a knowledge bridge, connecting your AI model with Syncfusion-specific expertise while respecting your privacy and maintaining security. -## See Also +## See also - [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro) \ No newline at end of file From db8872bac5835e055718f14c2461285d702602cf Mon Sep 17 00:00:00 2001 From: GokulSF4339 Date: Wed, 22 Jul 2026 23:40:29 +0530 Subject: [PATCH 33/36] Task(1036752): Updated UG revamp work for WF scheduler control. --- .../Scheduler/Customizing-Appearance.md | 8 ++-- WindowsForms/Scheduler/Getting-Started.md | 41 +++++++++---------- ...gging-Context-in-the-ItemChanging-event.md | 10 +++-- .../Metro-Theme-for-Essential-Schedule.md | 6 ++- WindowsForms/Scheduler/Overview.md | 4 +- WindowsForms/Scheduler/ScheduleControl.md | 8 ++-- WindowsForms/Scheduler/Time-Interval.md | 24 ++++++----- WindowsForms/Scheduler/TouchSupport.md | 14 ++++--- 8 files changed, 63 insertions(+), 52 deletions(-) diff --git a/WindowsForms/Scheduler/Customizing-Appearance.md b/WindowsForms/Scheduler/Customizing-Appearance.md index 66ef548a7..af5056cef 100644 --- a/WindowsForms/Scheduler/Customizing-Appearance.md +++ b/WindowsForms/Scheduler/Customizing-Appearance.md @@ -1,6 +1,6 @@ --- layout: post -title: Customizing Appearance in Windows Forms Scheduler control | Syncfusion® +title: Customization in Winforms Scheduler control | Syncfusion® description: Learn about Customizing Appearance support in Syncfusion® Windows Forms Scheduler (Event Calendar) control and more details. platform: windowsforms control: Schedule @@ -9,9 +9,7 @@ documentation: ug # Customizing Appearance in Windows Forms Scheduler (Event Calendar) -Appearance of any region of the ScheduleControl can be customized by using the [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler). Appearance property. - -This property gains access to the ScheduleAppearance object that controls various appearance attributes of different WinForms Scheduler regions. +The appearance of any region of the ScheduleControl can be customized by using the [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler). Appearance property. This property provides access to the ScheduleAppearance object that controls various appearance attributes of different WinForms Scheduler regions. The following table describes the appearance options available in the customized WinForms Scheduler control. @@ -212,7 +210,7 @@ Indicates whether the time column should appear or not. TimeBackColor -Specifies the back color of the time column or not. +Specifies the back color of the time column. TimeBigFontSize diff --git a/WindowsForms/Scheduler/Getting-Started.md b/WindowsForms/Scheduler/Getting-Started.md index 7fe5bb66d..64950daeb 100644 --- a/WindowsForms/Scheduler/Getting-Started.md +++ b/WindowsForms/Scheduler/Getting-Started.md @@ -18,7 +18,7 @@ Refer to [control dependencies](https://help.syncfusion.com/windowsforms/control ## Creating application with the ScheduleControl -In this walkthrough, user will create a WinForms application that contains the [Windows Forms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler) (Event Calendar) control. +In this walkthrough, you will create a WinForms application that contains the [Windows Forms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-scheduler) (Event Calendar) control. ### Creating the project @@ -30,7 +30,7 @@ Create a new Windows Forms project in Visual Studio to display the Windows Forms ![Adding WinForms Scheduler through designer](Getting-Started_images/Getting-Started_img9.jpeg) -2. The ScheduleControl will be shown on the design surface. Following screenshot is a typical display of this. Notice the Appearance property in the property grid. This object has many properties that affects the appearance of the ScheduleControl. + The ScheduleControl will be shown on the design surface. Following screenshot is a typical display of this. Notice the Appearance property in the property grid. This object has many properties that affect the appearance of the ScheduleControl. ![Adding WinForms Scheduler through designer](Getting-Started_images/Getting-Started_img10.png) @@ -104,7 +104,7 @@ Use the implementation provided in the `SimpleScheduleDataProvider.cs` file. Thi ![Adding appointment in Winforms Scheduler](Getting-Started_images/Getting-Started_img12.jpeg) -2. You can find the `SimpleScheduleDataProvider.cs` file in the [Syncfuion_build_installed_location]\Syncfusion\Essential Studio\<Product_version>\Windows\Schedule.Windows\ Samples\<Framework_version>\ScheduleSample\CS_ folder. Drill down to this folder and add this file to our project. +2. You can find the `SimpleScheduleDataProvider.cs` file in the [Syncfusion_build_installed_location]\Syncfusion\Essential Studio\<Product_version>\Windows\Schedule.Windows\ Samples\<Framework_version>\ScheduleSample\CS_ folder. Drill down to this folder and add this file to our project. ![Adding appointment in Winforms Scheduler](Getting-Started_images/Getting-Started_img13.jpeg) @@ -126,8 +126,8 @@ using System.Drawing; using System.Text; using System.Windows.Forms; using Syncfusion.Windows.Forms.Schedule; -using GridScheduleSample; -namespace ScheduleSample + +namespace GridScheduleSample { public partial class Form1 : Form { @@ -158,9 +158,8 @@ Imports System.Drawing Imports System.Text Imports System.Windows.Forms Imports Syncfusion.Windows.Forms.Schedule -Imports GridScheduleSample -Namespace ScheduleSample +Namespace GridScheduleSample Public Partial Class Form1 Inherits Form @@ -209,11 +208,11 @@ The WinForms appointment Scheduler control supports to insert, remove, modify, a ### Insert -Double-click one of the timeslots on the ScheduleGrid. This action will display a new appointment screen where you can enter a new schedule item. +Double-click one of the timeslots on the ScheduleGrid. This action will display an appointment form where you can enter a new schedule item. ![Adding appointment in WinForms Scheduler](Getting-Started_images/Getting-Started_img17.jpeg) -Clicking the Save and Close button on the Appointment, the screen will re-display the `Day view` ScheduleControl with a new appointment. If you hover over the appointment in the ScheduleGrid, a tooltip will display. +After clicking Save and Close on the appointment form, the Day view ScheduleControl will re-display with a new appointment. If you hover over the appointment in the ScheduleGrid, a tooltip will display. ![Adding appointment in WinForms Scheduler](Getting-Started_images/Getting-Started_img18.jpeg) @@ -229,17 +228,17 @@ Double-click on the appointment or right-click and choose the Edit Item from con ![Modifying appointment in WinForms Scheduler](Getting-Started_images/Getting-Started_img20.jpeg) -This action will display an appointment form with appointment details to modify the appointment then, click on Save and Close button. +This action will display an appointment form with appointment details to modify the appointment. Then, click the Save and Close button. ![Modifying appointment in WinForms Scheduler](Getting-Started_images/Getting-Started_img21.jpg) ### Save all the appointment -Click the Close button on the form system menu on the upper-right corner of the form. Because, the data has been modified in this ScheduleControl. A dialog will appear as follows, click Yes to save the changes to a disk file. +Click the Close button on the form system menu on the upper-right corner of the form. The data has been modified in this ScheduleControl. A dialog will appear as follows; click Yes to save the changes to a disk file. ![Saving all appointment in WinForms Scheduler](Getting-Started_images/Getting-Started_img22.jpg) -Then modify our `Form_Load` code to conditionally reload the saved data if the file is present on the disk. Copy this code to your Form1.cs file. Notice that you have added a `using` statement to reference the `System.IO namespace` to the new code in the Form1_Load. +Then modify the `Form_Load` code to conditionally reload the saved data if the file is present on the disk. Copy this code to your Form1.cs file. Notice that you have added a `using` statement to reference the `System.IO namespace` to the new code in the Form1_Load. {% tabs %} {% highlight c# %} @@ -251,9 +250,9 @@ using System.Drawing; using System.Text; using System.Windows.Forms; using Syncfusion.Windows.Forms.Schedule; -using GridScheduleSample; using System.IO; -namespace ScheduleSample + +namespace GridScheduleSample { public partial class Form1 : Form { @@ -271,15 +270,14 @@ namespace ScheduleSample data = SimpleScheduleDataProvider.LoadBinary("default.schedule"); data.FileName = "default.schedule"; } - else { - data = new SimpleScheduleDataProvider(); + data = new SimpleScheduleDataProvider(); data.MasterList = new SimpleScheduleAppointmentList(); data.FileName = "default.schedule"; } - this.scheduleControl1.ScheduleType = ScheduleViewType.Month; - this.scheduleControl1.DataSource = data; + this.scheduleControl1.ScheduleType = ScheduleViewType.Month; + this.scheduleControl1.DataSource = data; } } @@ -295,10 +293,9 @@ Imports System.Drawing Imports System.Text Imports System.Windows.Forms Imports Syncfusion.Windows.Forms.Schedule -Imports GridScheduleSample Imports System.IO -Namespace ScheduleSample +Namespace GridScheduleSample Public Partial Class Form1 Inherits Form @@ -755,6 +752,6 @@ End Property The C# WinForms Calendar Scheduler control supports creating the recurring appointment. By this recurrence appointment, you can process on the daily, weekly, monthly, or yearly view to create the recurrence rule with or without end date. Details are explained in the following link: -[Create the recurrence appointment in WinForms Calendar Scheduler control ](time-interval) +[Create the recurrence appointment in WinForms Calendar Scheduler control ](time-interval.md) -N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. \ No newline at end of file +N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full WinForms Scheduler component overview, features, pricing, and documentation? Visit the [WinForms Scheduler](https://www.syncfusion.com/winforms-ui-controls/scheduler) page. diff --git a/WindowsForms/Scheduler/Item-Dragging-Context-in-the-ItemChanging-event.md b/WindowsForms/Scheduler/Item-Dragging-Context-in-the-ItemChanging-event.md index e61025706..8f204f240 100644 --- a/WindowsForms/Scheduler/Item-Dragging-Context-in-the-ItemChanging-event.md +++ b/WindowsForms/Scheduler/Item-Dragging-Context-in-the-ItemChanging-event.md @@ -9,11 +9,11 @@ documentation: ug # Item Dragging Context in the ItemChanging event in Scheduler -This feature provides support to detect the dragging context when an item is dropped in the schedule part or calendar part. It also enables you to cancel the needed items through the ItemChanging event. +This feature provides support to detect the dragging context when an item is dropped in the schedule part or calendar part. It also enables you to cancel specific items as needed through the ItemChanging event. ### Use case scenario -In ItemChanging event, through the ItemDragHitContext enumeration, you can detect the dragging context (Schedule or Calendar) and cancel the needed items. +In the ItemChanging event, through the ItemDragHitContext enumeration, you can detect the dragging context (Schedule or Calendar) and cancel specific items as needed. ### Property @@ -51,7 +51,7 @@ You can get the schedule sample from the following online location: [http://samples.syncfusion.com/windowsforms](http://samples.syncfusion.com/windowsforms) -### Adding this support to an application +### Adding drag-context detection to an application The following steps help you to get the target part in the Schedule control while dragging: @@ -62,9 +62,13 @@ The following steps help you to get the target part in the Schedule control whil {% capture codesnippet1 %}​ {% tabs %} {% highlight c# %} +using Syncfusion.Windows.Forms.Schedule; + this.scheduleControl1.ItemChanging += new ScheduleAppointmentChangingEventHandler(scheduleControl1_ItemChanging); {% endhighlight %} {% highlight vb %} +Imports Syncfusion.Windows.Forms.Schedule + AddHandler scheduleControl1.ItemChanging, AddressOf scheduleControl1_ItemChanging {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/Scheduler/Metro-Theme-for-Essential-Schedule.md b/WindowsForms/Scheduler/Metro-Theme-for-Essential-Schedule.md index 5f7d1f9de..4e6e56613 100644 --- a/WindowsForms/Scheduler/Metro-Theme-for-Essential-Schedule.md +++ b/WindowsForms/Scheduler/Metro-Theme-for-Essential-Schedule.md @@ -9,7 +9,7 @@ documentation: ug # Metro Theme for Schedule in Windows Forms Scheduler -This feature enables you to apply new Metro styles to the Schedule control. +This feature enables you to apply the Metro theme to the Schedule control. ### Use case scenario @@ -49,9 +49,13 @@ You can apply Metro theme to the Schedule control by setting the GridVisualStyle {% tabs %} {% highlight c# %} +using Syncfusion.Windows.Forms.Schedule; + this.scheduleControl1.GetScheduleHost().Schedule.Appearance.VisualStyle = Syncfusion.Windows.Forms.GridVisualStyles.Metro; {% endhighlight %} {% highlight vb %} +Imports Syncfusion.Windows.Forms.Schedule + Me.scheduleControl1.GetScheduleHost().Schedule.Appearance.VisualStyle = Syncfusion.Windows.Forms.GridVisualStyles.Metro {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/Scheduler/Overview.md b/WindowsForms/Scheduler/Overview.md index ae65337f3..de35824d0 100644 --- a/WindowsForms/Scheduler/Overview.md +++ b/WindowsForms/Scheduler/Overview.md @@ -12,7 +12,7 @@ documentation: ug The Scheduler is a Windows Forms class library built around the functionalities found in the Windows Forms Grid control. The control allows you to add scheduling support to your applications. -The most popular WinForms Scheduler includes creating new appointments, displaying those appointments in a variety of views, including Monthly, Daily, Weekly, Work Week, and multiple days. In the daily formats, you can use the UI to drag appointments to another time slot and to extend appointments. A flexible navigation calendar lets you easily home on the dates you would like to see in the Schedule control. +The most popular WinForms Scheduler includes creating new appointments, displaying those appointments in a variety of views, including Monthly, Daily, Weekly, Work Week, and multiple days. In the daily formats, you can use the UI to drag appointments to another time slot and to extend appointments. A flexible navigation calendar lets you easily navigate to the dates you would like to see in the Schedule control. ![windows forms schedule showing month view](overview_images/windowsforms-scheduler-showing-month-view.png) @@ -32,4 +32,4 @@ The [WinForms Scheduler](https://www.syncfusion.com/scheduler-sdk/winforms-sched * Recurrence appointment: Supports schedule recurring appointments to repeat daily, weekly, monthly, or yearly. * Touch support: Completely supports swiping, panning, zooming, and more. -N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. \ No newline at end of file +N> You can also explore our [WinForms Scheduler example](https://github.com/syncfusion/winforms-demos/tree/master/schedulecontrol) that shows how to schedule and manage appointments through an intuitive user interface, similar to the Outlook calendar. Looking for the full WinForms Scheduler component overview, features, pricing, and documentation? Visit the [WinForms Scheduler](https://www.syncfusion.com/winforms-ui-controls/scheduler) page. diff --git a/WindowsForms/Scheduler/ScheduleControl.md b/WindowsForms/Scheduler/ScheduleControl.md index 44051ab1a..fb59610d6 100644 --- a/WindowsForms/Scheduler/ScheduleControl.md +++ b/WindowsForms/Scheduler/ScheduleControl.md @@ -9,7 +9,7 @@ documentation: ug # ScheduleControl in Windows Forms Scheduler (Schedule) -It is a User Control that provides the basic scheduling functionality. +The ScheduleControl is a User Control that provides the basic scheduling functionality. ### Properties @@ -45,7 +45,7 @@ Gets the navigation panel. ScheduleType -Gets or sets whether a daily, weekly or monthly schedule is displayed or not. +Gets or sets whether a daily, weekly or monthly schedule is displayed. ### Methods @@ -99,7 +99,7 @@ Occurs when an item is clicked or double-clicked. ScheduleGridCreated -Lets you either use a derived ScheduleGridControl or subscribe to the events on the ScheduleGridControl. +Allows you to either use a derived ScheduleGridControl or subscribe to the events on the ScheduleGridControl. ## Caption panel @@ -112,7 +112,7 @@ It is a panel where you can place additional controls and make them appear adjac ## Navigation calendar -A GridControl-derived object displays multiple calendars lets you select particular dates or data ranges to be displayed in the ScheduleControl. +A GridControl-derived object displays multiple calendars and lets you select particular dates or data ranges to be displayed in the ScheduleControl. ### Properties diff --git a/WindowsForms/Scheduler/Time-Interval.md b/WindowsForms/Scheduler/Time-Interval.md index a4552e483..8c41b1e8d 100644 --- a/WindowsForms/Scheduler/Time-Interval.md +++ b/WindowsForms/Scheduler/Time-Interval.md @@ -45,43 +45,47 @@ Maintains the repeat type value for the selected Week. Syntax:{StartDate};{EndDa 5. Every SEC -Maintains the repeat type value for every mentioned second for the appointed date. Syntax:{StartDate};{EndDate};Every DAY {NumberOfDay};Every SEC {Interval} Example:10/08/2015;10/15/2015;Every DAY 1;Every SEC 120;10/08/2015;11/08/2015;Every WEEKDAY; Every SEC 120; +Maintains the repeat type value for every mentioned second for the appointed date. Syntax:{StartDate};{EndDate};Every DAY {NumberOfDay};Every SEC {Interval} Example:10/08/2015;10/15/2015;Every DAY 1;Every SEC 120;10/08/2015;11/08/2015;Every WEEKDAY;Every SEC 120; 6. Every MIN -Maintains the repeat type value for every mentioned minute for the appointed date. Syntax:{StartDate};{EndDate};Every DAY {NumberOfDay};Every MIN {Interval} Example:10/08/2015;10/15/2015;Every DAY 1;Every MIN 10;10/08/2015;11/08/2015;Every WEEKDAY; Every MIN 10; +Maintains the repeat type value for every mentioned minute for the appointed date. Syntax:{StartDate};{EndDate};Every DAY {NumberOfDay};Every MIN {Interval} Example:10/08/2015;10/15/2015;Every DAY 1;Every MIN 10;10/08/2015;11/08/2015;Every WEEKDAY;Every MIN 10; 7. Every HR -Maintains the repeat type value for every mentioned hour for the appointed date. Syntax:{StartDate};{EndDate};Every DAY {NumberOfDay};Every HR {Interval} Example:10/08/2015;10/15/2015;Every DAY 1;Every HR 10;10/08/2015;11/08/2015;Every WEEKDAY; Every HR 10; +Maintains the repeat type value for every mentioned hour for the appointed date. Syntax:{StartDate};{EndDate};Every DAY {NumberOfDay};Every HR {Interval} Example:10/08/2015;10/15/2015;Every DAY 1;Every HR 10;10/08/2015;11/08/2015;Every WEEKDAY;Every HR 10; 8. Every MONTH -Maintains the repeat type value for every Month on the selected date or week. Syntax:{StartDate};{EndDate};Every MONTH on {Date}{StartDate};{EndDate};Every MONTH on {Day}:{WhichWeek} Example:5/08/2009;10/08/2009;Every MONTH on 205/08/2009;10/08/2009;Every MONTH on WED:2 +Maintains the repeat type value for every Month on the selected date or week. Syntax:{StartDate};{EndDate};Every MONTH on {Date}{StartDate};{EndDate};Every MONTH on {Day}:{WhichWeek} Example:05/08/2009;10/08/2009;Every MONTH on 05/08/2009;10/08/2009;Every MONTH on WED:2 9. Every QUARTER -Maintains the repeat type value for every quarter. Syntax:{StartDate};{EndDate};Every QUARTER on {Date} after MONTH:{MonthDifference}{StartDate};{EndDate};Every QUARTER on {Day}:{Date} after MONTH:{MonthDifference} Example:10/13/2015;10/13/2016;Every QUARTER on 20 after MONTH:110/13/2015;10/13/2016;Every QUARTER on MON:1 after MONTH:1 +Maintains the repeat type value for every quarter. Syntax:{StartDate};{EndDate};Every QUARTER on {Date} after MONTH:{MonthDifference}{StartDate};{EndDate};Every QUARTER on {Day}:{Date} after MONTH:{MonthDifference} Example:10/13/2015;10/13/2016;Every QUARTER on 20 after MONTH:10/13/2015;10/13/2016;Every QUARTER on MON:1 after MONTH:1 10. Every YEAR -Maintains the repeat type value for every year. Syntax:{StartDate};{EndDate};Every YEAR on {Month}{Date}{StartDate};{EndDate};Every YEAR on {DAY}:{whichWeek} after {Month} Example:10/13/2015;10/13/2017;Every YEAR on JAN 2010/15/2015;10/15/2017;Every YEAR on MON:1 after JAN +Maintains the repeat type value for every year. Syntax:{StartDate};{EndDate};Every YEAR on {Month}{Date}{StartDate};{EndDate};Every YEAR on {DAY}:{whichWeek} after {Month} Example:10/13/2015;10/13/2017;Every YEAR on JAN 10/15/2015;10/15/2017;Every YEAR on MON:1 after JAN ## Setting the time interval in seconds format -The Schedule control, by default, allows you to set the time interval for scheduling appointments only in hours and minutes formats. Now, you can also include seconds in the time interval by enabling the AllowSecondsInAppointment property. +The Schedule control, by default, allows you to set the time interval for scheduling appointments only in hours and minutes formats. You can also include seconds in the time interval by enabling the AllowSecondsInAppointment property. {% tabs %} {% highlight c# %} +using Syncfusion.Windows.Forms.Schedule; + this.scheduleControl1.AllowSecondsInAppointment = true; {% endhighlight %} {% highlight vb %} +Imports Syncfusion.Windows.Forms.Schedule + Me.scheduleControl1.AllowSecondsInAppointment = True {% endhighlight %} {% endtabs %} @@ -91,7 +95,7 @@ Me.scheduleControl1.AllowSecondsInAppointment = True ## Setting the recurrence appointments in seconds -By default, the Schedule control allows you to add the recurrence appointments only for each day, month, or year. Now, recurrence appointments in the Schedule WF can also be organized in seconds, minutes, and hours. To add the recurrence appointments in seconds, it is necessary to enable the [AllowSecondsInAppointment](https://help.syncfusion.com/windowsforms/scheduler/time-interval#setting-the-time-interval-in-seconds-format) property. The minimum value used for adding the recurrence appointments is 60 seconds. When the value goes below 60 seconds, then by default, the appointment time assigns 60 seconds. Recurrence Appointments can be added in two ways. +By default, the Schedule control allows you to add the recurrence appointments only for each day, month, or year. Recurrence appointments in the WinForms Scheduler can also be organized in seconds, minutes, and hours. To add the recurrence appointments in seconds, it is necessary to enable the [AllowSecondsInAppointment](https://help.syncfusion.com/windowsforms/scheduler/time-interval#setting-the-time-interval-in-seconds-format) property. When the value goes below 60 seconds, then by default, the appointment time defaults to 60 seconds. Recurrence appointments can be added in two ways. ### Adding recurrence by using Appointment Recurrence dialog @@ -108,7 +112,7 @@ Recurrence appointments can be added by using the Appointment Recurrence dialog ![Appointment recurrence dialog in WindowsForms Scheduler](time-interval_images/windowsforms-scheduler-appointment-recurrence-dialog.jpeg) 5. The highlighted area above is the newly implemented recurrence settings. -6. Choose the desired option to make the recurrence appointment in the schedule control and press OK. +6. Choose the desired option to create the recurrence appointment in the schedule control and press OK. 7. Now, Save and Close. ### Adding recurrence by using the RecurrenceRule property @@ -141,7 +145,7 @@ Dim item As IRecurringScheduleAppointment = TryCast(app, IRecurringScheduleAppoi If item IsNot Nothing Then item.StartTime = New DateTime(2015, 05, 06, 1, 0, 0) -item.EndTime = New DateTime(2015, 5, 6, 2, 0, 0) +item.EndTime = New DateTime(2015, 05, 06, 2, 0, 0) item.Subject = "Call Joe" item.RecurrenceRule = "05/06/2015 ;05/07/2015 ;Every DAY;EVERY MIN 10" dataProvider.AddNewRecurringAppointments(item, New DateTime(2015, 09, 09)) diff --git a/WindowsForms/Scheduler/TouchSupport.md b/WindowsForms/Scheduler/TouchSupport.md index 7ab8d039d..de9dfa017 100644 --- a/WindowsForms/Scheduler/TouchSupport.md +++ b/WindowsForms/Scheduler/TouchSupport.md @@ -9,27 +9,31 @@ documentation: ug # Touch Support in Windows Forms Scheduler (Schedule) -The ScheduleControl provides the swipe scrolling and zooming touch support like Outlook calendar. The touch support for schedule control can be enabled by setting the [EnableTouchMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Schedule.ScheduleControl.html#Syncfusion_Windows_Forms_Schedule_ScheduleControl_EnableTouchMode) property to `true`. This will enable the grid to support the swiping, panning, and zooming. Default value of the `EnableTouchMode` property is `false`. +The ScheduleControl provides swipe scrolling and zooming touch support, like the Outlook calendar. The touch support for schedule control can be enabled by setting the [EnableTouchMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Schedule.ScheduleControl.html#Syncfusion_Windows_Forms_Schedule_ScheduleControl_EnableTouchMode) property to `true`. This will enable the grid to support swiping, panning, and zooming. Default value of the `EnableTouchMode` property is `false`. {% tabs %} {% highlight c# %} -//Enable the touch mode +using Syncfusion.Windows.Forms.Schedule; + +//Enable the touch mode. scheduleControl1.EnableTouchMode = true; {% endhighlight %} {% highlight vb %} -'Enable the touch mode +Imports Syncfusion.Windows.Forms.Schedule + +'Enable the touch mode. scheduleControl1.EnableTouchMode = True {% endhighlight %} {% endtabs %} ## Touch swiping -The ScheduleControl allows you to perform the vertical swipe scrolling in Day, `WorkWeek`, and custom views. The previous or next value can be viewed by horizontal swipe scrolling in left to right or right to left direction like MS Outlook. +The ScheduleControl allows you to perform the vertical swipe scrolling in Day, `WorkWeek`, and custom views. The previous or next period can be viewed by horizontal swiping left-to-right or right-to-left, like the MS Outlook calendar. ![Schedule_img1](TouchSupport_images/Schedule_img1.png) ## Touch zooming -The ScheduleControl view can be changed when zooming like MS Outlook calendar. +The ScheduleControl view can be changed when zooming, like the MS Outlook calendar. ![Schedule_img2](TouchSupport_images/Schedule_img2.png) From 921f3c96cacf2ad5226d88d0d90f28af94080e7b Mon Sep 17 00:00:00 2001 From: GokulSF4339 Date: Wed, 22 Jul 2026 23:44:45 +0530 Subject: [PATCH 34/36] Task(1036752): Updated UG revamp work for WF calendar control. --- WindowsForms/Calendar/Getting-Started.md | 46 +- WindowsForms/Calendar/Overview.md | 6 +- WindowsForms/Calendar/appearance.md | 121 +++-- WindowsForms/Calendar/cell-customization.md | 467 ++++++++++---------- WindowsForms/Calendar/globalization.md | 8 +- WindowsForms/Calendar/navigation.md | 22 +- WindowsForms/Calendar/selection.md | 119 ++++- 7 files changed, 471 insertions(+), 318 deletions(-) diff --git a/WindowsForms/Calendar/Getting-Started.md b/WindowsForms/Calendar/Getting-Started.md index 2377bacc5..7d7854739 100644 --- a/WindowsForms/Calendar/Getting-Started.md +++ b/WindowsForms/Calendar/Getting-Started.md @@ -19,7 +19,7 @@ Refer to this [documentation](https://help.syncfusion.com/windowsforms/installat ## Adding the SfCalendar control via designer -The following steps describe how to create an WinForms Calendar (SfCalendar) control via designer. +The following steps describe how to create a WinForms Calendar (SfCalendar) control via designer. 1. Create a new Windows Forms application in Visual Studio. @@ -33,7 +33,7 @@ The following steps describe how to create an WinForms Calendar (SfCalendar) con ## Adding the SfCalendar control via code -The following steps describe how to create an WinForms Calendar (SfCalendar) control programmatically: +The following steps describe how to create a WinForms Calendar (SfCalendar) control programmatically: 1. Create a C# or VB application via Visual Studio. @@ -64,12 +64,13 @@ Imports Syncfusion.WinForms.Input {% endcapture %} {{ codesnippet1 | OrderList_Indent_Level_1 }} -4. Create an instance of the [WinForms Calendar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) (SfCalendar) control instance, and then add it to the form. +4. Create an instance of the [WinForms Calendar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) (SfCalendar) control, and add it to the Form. {% capture codesnippet2 %}​ {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; SfCalendar calendar = new SfCalendar(); @@ -78,6 +79,7 @@ this.Controls.Add(calendar); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim calendar As SfCalendar = New SfCalendar @@ -96,12 +98,14 @@ At run time, a particular date should be focused or selected using the `Selected {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; calendar.SelectedDate = new System.DateTime(2019, 08, 12); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input calendar.SelectedDate = New System.DateTime(2019, 08, 12) @@ -118,6 +122,7 @@ The WinForms Calendar (SfCalendar) control notifies the date changes using the ` {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Invoking selection changing event calendar.SelectionChanging += Calendar_SelectionChanging; @@ -143,12 +148,13 @@ private void Calendar_SelectionChanged(Syncfusion.WinForms.Input.SfCalendar send {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Invoking selection changing event -Private calendar.SelectionChanging += AddressOf Calendar_SelectionChanging +AddHandler calendar.SelectionChanging, AddressOf Calendar_SelectionChanging ' Invoking selection changed event -Private calendar.SelectionChanged += AddressOf Calendar_SelectionChanged +AddHandler calendar.SelectionChanged, AddressOf Calendar_SelectionChanged ' Occurs before the selected date is changed in Calendar. Private Sub Calendar_SelectionChanging(ByVal sender As Syncfusion.WinForms.Input.SfCalendar, ByVal e As Syncfusion.WinForms.Input.Events.SelectionChangingEventArgs) @@ -170,15 +176,16 @@ End Sub ## Date range -The [WinForms Calendar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) (SfCalendar) prevents users from selecting dates within specified minimum and maximum ranges. To specify a range, set the start date and end date to the [MinDate](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_MinDate) and [MaxDate](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_MaxDate) properties, respectively. +The [WinForms Calendar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) (SfCalendar) prevents users from selecting dates outside the specified minimum and maximum range. To specify a range, set the start date and end date to the [MinDate](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_MinDate) and [MaxDate](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_MaxDate) properties, respectively. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Setting the minimum and maximum dates -Syncfusion.WinForms.Input.SfCalendar calendar = new Syncfusion.WinForms.Input.SfCalendar(); +SfCalendar calendar = new SfCalendar(); this.Controls.Add(calendar); calendar.SelectedDate = new DateTime(2018, 1, 17); @@ -188,10 +195,11 @@ calendar.MaxDate = new DateTime(2018, 1, 25); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting the minimum and maximum dates -Dim calendar As Syncfusion.WinForms.Input.SfCalendar = New Syncfusion.WinForms.Input.SfCalendar +Dim calendar As SfCalendar = New SfCalendar Me.Controls.Add(calendar) calendar.SelectedDate = New DateTime(2018, 1, 17) @@ -211,6 +219,7 @@ calendar.MaxDate = New DateTime(2018, 1, 25) {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; //Setting the blackout dates @@ -224,6 +233,7 @@ calendar.BlackoutDates.Add(new System.DateTime(2018, 1, 20)); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input 'Setting the Blackout Dates @@ -249,6 +259,7 @@ The following code sample demonstrates how to add special dates to the calendar. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; SpecialDate specialDate1 = new SpecialDate(); List SpecialDates = new List(); @@ -257,7 +268,7 @@ specialDate1.BackColor = System.Drawing.Color.White; specialDate1.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, System.Drawing.GraphicsUnit.Point, ((byte)(0))); specialDate1.ForeColor = System.Drawing.Color.Magenta; specialDate1.Image = Properties.Resources.icons_Womens_day; -specialDate1.Description = "Army Day"; +specialDate1.Description = "International Women's Day"; specialDate1.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; specialDate1.IsDateVisible = false; specialDate1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; @@ -269,6 +280,7 @@ calendar.SpecialDates = SpecialDates; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim specialDate1 As New SpecialDate() Dim SpecialDates As New List(Of SpecialDate)() @@ -277,7 +289,7 @@ specialDate1.BackColor = System.Drawing.Color.White specialDate1.Font = New System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, System.Drawing.GraphicsUnit.Point, (CByte(0))) specialDate1.ForeColor = System.Drawing.Color.Magenta specialDate1.Image = My.Resources.icons_Womens_day -specialDate1.Description = "Army Day" +specialDate1.Description = "International Women's Day" specialDate1.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter specialDate1.IsDateVisible = False specialDate1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter @@ -299,6 +311,7 @@ The WinForms Calendar (SfCalendar) control allows you to select multiple dates b {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Setting to Allow Multiple Selection calendar.AllowMultipleSelection = true; @@ -306,6 +319,7 @@ calendar.AllowMultipleSelection = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting to Allow Multiple Selection calendar.AllowMultipleSelection = True @@ -323,6 +337,7 @@ The first day of a week can be changed by setting the [FirstDayOfWeek](https://h {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; //Setting the First Day Of Week calendar.FirstDayOfWeek = DayOfWeek.Monday; @@ -330,9 +345,10 @@ calendar.FirstDayOfWeek = DayOfWeek.Monday; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input 'Setting the First Day Of Week -Me.SfCalendar1.FirstDayOfWeek = DayOfWeek.Monday +calendar.FirstDayOfWeek = DayOfWeek.Monday {% endhighlight %} @@ -347,15 +363,17 @@ The week number of current week in a year can be shown in the calendar control b {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; -// Setting the Minimum and Maximum date +// Setting the ShowWeekNumber calendar.ShowWeekNumber = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input -' Setting the Minimum and Maximum date +' Setting the ShowWeekNumber calendar.ShowWeekNumber = True {% endhighlight %} @@ -371,6 +389,7 @@ You can get the current week number in WinForms Calendar (SfCalendar) control by {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; SfCalendar sfCalendar1 = new SfCalendar(); CultureInfo info = new CultureInfo("en-EN"); @@ -380,6 +399,7 @@ sfCalendar1.Culture = info; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim sfCalendar1 As SfCalendar = New SfCalendar() Dim info As CultureInfo = New CultureInfo("en-EN") diff --git a/WindowsForms/Calendar/Overview.md b/WindowsForms/Calendar/Overview.md index 36446faad..8e4e216e1 100644 --- a/WindowsForms/Calendar/Overview.md +++ b/WindowsForms/Calendar/Overview.md @@ -23,7 +23,7 @@ The **SfCalendar** is a control that allows you to select a date from calendar, **Special dates** - Supports highlighting special dates with icons and descriptions. -**Blackout dates** - Supports blocking a certain dates from selection and user interaction. Separate styles can be applied to blackout dates. +**Blackout dates** - Supports blocking certain dates from selection and user interaction. Separate styles can be applied to blackout dates. **Accessibility** - Provides touch, keyboard, and mouse supports to make applications available to a wide variety of users. @@ -70,7 +70,7 @@ SelectedDate Value -Indicates the current date of calendar. +Indicates the current date of the calendar. @@ -104,7 +104,7 @@ ShowVerticalSplitter GridLines -To change the border style of calendar. +To change the border style of the calendar. diff --git a/WindowsForms/Calendar/appearance.md b/WindowsForms/Calendar/appearance.md index 222eacfc7..5132e9318 100644 --- a/WindowsForms/Calendar/appearance.md +++ b/WindowsForms/Calendar/appearance.md @@ -19,8 +19,8 @@ The BackColor and ForeColor of each part in the calendar header can be customize The header text in the calendar control displays the month and year of the selected date. The calendar header color can be customized by using the following style properties: -* BackColor: Changes the background color of header in the calendar. -* ForeColor: Changes the foreground color of the text, which displays month and year in the calendar header. +* BackColor: Changes the background color of the header in the calendar. +* ForeColor: Changes the foreground color of the header text that displays the month and year in the calendar header. * HoverForeColor: Changes the foreground color of the header text on mouse hover. * Font: Changes the font that is used to draw the header text in the calendar. @@ -37,6 +37,7 @@ The following code example illustrates how to customize appearances of the calen {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Header customizations @@ -63,6 +64,7 @@ calendar.Style.Header.DayNamesFont = new System.Drawing.Font("Calibri", 11.25F, {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Header customizations @@ -105,6 +107,7 @@ The following code example illustrates the same: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // set the Navigation Button ForeColor @@ -118,9 +121,18 @@ calendar.Style.Header.NavigationButtonHoverForeColor = Color.Indigo; calendar.Style.Header.NavigationButtonDisabledForeColor = Color.LightGray; +// set the UpArrowImage + +calendar.UpArrowImage = Image.FromFile("UpArrow.png"); + +// set the DownArrowImage + +calendar.DownArrowImage = Image.FromFile("DownArrow.png"); + {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' set the Navigation Button ForeColor @@ -134,7 +146,13 @@ calendar.Style.Header.NavigationButtonHoverForeColor = Color.Indigo calendar.Style.Header.NavigationButtonDisabledForeColor = Color.LightGray -The visibility and alignment of navigation buttons can also be customized. +' set the UpArrowImage + +calendar.UpArrowImage = Image.FromFile("UpArrow.png") + +' set the DownArrowImage + +calendar.DownArrowImage = Image.FromFile("DownArrow.png") {% endhighlight %} @@ -149,6 +167,7 @@ Navigation buttons are used to move between views in the `SfCalendar`. The visib {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Indicating whether show the navigation buttons which used to move between views. @@ -157,6 +176,7 @@ calendar.ShowNavigationButton = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Indicating whether show the navigation buttons which used to move between views. @@ -175,6 +195,7 @@ Navigation buttons can be aligned in different sides relative to the calendar he {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Indicating how the navigation buttons should align relative to the Calendar Header. Setting Left alignment. @@ -183,6 +204,7 @@ calendar.NavigationButtonAlignment = Syncfusion.WinForms.Input.Enums.NavigationB {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Indicating how the navigation buttons should align relative to the Calendar Header. Setting Left alignment. @@ -197,6 +219,7 @@ calendar.NavigationButtonAlignment = Syncfusion.WinForms.Input.Enums.NavigationB {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Indicating how the navigation buttons should align relative to the Calendar Header. Setting Both alignment. @@ -205,6 +228,7 @@ calendar.NavigationButtonAlignment = Syncfusion.WinForms.Input.Enums.NavigationB {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Indicating how the navigation buttons should align relative to the Calendar Header. Setting Both alignment. @@ -230,6 +254,7 @@ The following code example illustrates how to change the background and foregrou {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Footer customizations @@ -252,6 +277,7 @@ calendar.Style.Footer.HoverForeColor = Color.SpringGreen; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Footer customizations @@ -309,12 +335,13 @@ The following code example illustrates the customization of calendar cells: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Setting CellBackColor calendarr.Style.Cell.CellBackColor = Color.LightBlue; -// Setting CellForeColor +// Settig CellForeColor calendar.Style.Cell.CellForeColor = Color.Red; @@ -361,6 +388,7 @@ calendar.Style.Cell.SelectedCellFont = new System.Drawing.Font("Calibri", 11.25F {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting CellBackColor @@ -434,47 +462,49 @@ Theme can be applied to SfCalendar by following the below steps: **Syncfusion.Office2016Theme.WinForms** assembly should be added as reference to set theme for SfCalendar in any application: -Before apply theme to SfCalendar, required theme assembly should be loaded as follows. +Before applying theme to SfCalendar, required theme assembly should be loaded as follows. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Core; using Syncfusion.WinForms.Core.Events; - static class Program +static class Program +{ + /// + /// The main entry point for the application. + /// + + static void Main() { - /// - /// The main entry point for the application. - /// - - static void Main() - { - SfSkinManager.LoadAssembly(typeof(Office2016Theme).Assembly); - Application.EnableVisualStyles(); - Application.SetCompatibleTextRenderingDefault(false); - Application.Run(new Form1()); - } + SfSkinManager.LoadAssembly(typeof(Office2016Theme).Assembly); + Application.EnableVisualStyles(); + Application.SetCompatibleTextRenderingDefault(false); + Application.Run(new Form1()); } +} {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Core Imports Syncfusion.WinForms.Core.Events - Friend Module Program - ''' - ''' The main entry point for the application. - ''' - - Sub Main() - SfSkinManager.LoadAssembly(GetType(Office2016Theme).Assembly) - Application.EnableVisualStyles() - Application.SetCompatibleTextRenderingDefault(False) - Application.Run(New Form1()) - End Sub - End Module +Friend Module Program +''' +''' The main entry point for the application. +''' + +Sub Main() + SfSkinManager.LoadAssembly(GetType(Office2016Theme).Assembly) + Application.EnableVisualStyles() + Application.SetCompatibleTextRenderingDefault(False) + Application.Run(New Form1()) +End Sub +End Module {% endhighlight %} @@ -491,6 +521,7 @@ This option helps to set the Office2016Colorful Theme. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Office2016Colorful @@ -499,6 +530,7 @@ calendar.ThemeName = "Office2016Colorful"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Office2016Colorful @@ -515,8 +547,8 @@ calendar.ThemeName = "Office2016Colorful" This option helps to set the Office2016White Theme. {% tabs %} - {% highlight C# %} +using Syncfusion.WinForms.Input; // Office2016White @@ -525,6 +557,7 @@ This option helps to set the Office2016White Theme. {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Office2016White @@ -543,6 +576,7 @@ This option helps to set the Office2016DarkGray Theme. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Office2016DarkGray @@ -551,6 +585,7 @@ This option helps to set the Office2016DarkGray Theme. {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Office2016DarkGray @@ -569,6 +604,7 @@ This option helps to set the Office2016Black Theme. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Office2016Black @@ -577,6 +613,7 @@ This option helps to set the Office2016Black Theme. {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Office2016Black @@ -586,7 +623,7 @@ calendar.ThemeName = "Office2016Black" {% endtabs %} -![WindowsForms Calendar office2016 black theme](appearance-images/windowsforms-calendar-office2016-black-theme.png) +![WindowsForms Calendar office2016 black theme](appearance-images/windowsforms-calendar-office2016black.png) ## Hide trailing dates @@ -595,6 +632,7 @@ The `SfCalendar` allows you to hide the days of next month and previous month in {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Setting the Next and Previous Months Dates invisible @@ -603,6 +641,7 @@ calendar.TrailingDatesVisible = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting the Next and Previous Months Dates invisible @@ -621,6 +660,7 @@ By default, the day names are displayed in an abbreviated form in the calendar c {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Setting the Show Abbreviated Day Names @@ -629,6 +669,7 @@ calendar.ShowAbbreviatedDayNames = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting the Show Abbreviated Day Names @@ -647,6 +688,7 @@ calendar.ShowAbbreviatedDayNames = false {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; //Enable the Right to Left @@ -655,6 +697,7 @@ calendar.RightToLeft = RightToLeft.Yes; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input 'Enable the Right to Left @@ -673,6 +716,7 @@ The today cell will be highlighted even the selected date differs from today in {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Indicating whether Today cell highlighted even selected date is different than today @@ -681,6 +725,7 @@ calendar.HighlightTodayCell = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Indicating whether Today cell highlighted even selected date is different than Today @@ -696,10 +741,10 @@ calendar.HighlightTodayCell = true The BackColor, ForeColor, and BorderColor of the today cell in the calendar can be customized. The today cell in the calendar control can be customized by using the following style properties: -* TodayBackColor: Changes the background color of today cell in the calendar. -* TodayForeColor: Changes the foreground color of today cell in the calendar. -* TodayFont: Changes the font that is used to draw the date text of today cell in the calendar. -* TodayHoverBorderColor: Changes the border color of today cell on mouse hover. +* TodayBackColor: Changes the background color of the today cell in the calendar. +* TodayForeColor: Changes the foreground color of the today cell in the calendar. +* TodayFont: Changes the font that is used to draw the date text of the today cell in the calendar. +* TodayHoverBorderColor: Changes the border color of the today cell on mouse hover. ## Change visibility of the footer @@ -708,6 +753,7 @@ The visibility of the calendar footer can be customized by using the [ShowFooter {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Indicating the visibility of none button in footer @@ -718,6 +764,7 @@ calendar.ShowNone = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Indicating the visibility of none button in footer @@ -734,6 +781,7 @@ calendar.ShowNone = false {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Indicating the visibility of today button in footer @@ -744,6 +792,7 @@ calendar.ShowToday = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Indicating the visibility of today button in footer @@ -764,6 +813,7 @@ The visibility of splitters in the calendar control can be customized by setting {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Enable Horizontal splitter @@ -784,6 +834,7 @@ calendar.Style.VerticalSplitterColor = Color.Green; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Enable Horizontal splitter diff --git a/WindowsForms/Calendar/cell-customization.md b/WindowsForms/Calendar/cell-customization.md index 91ab3fef0..05c8631f9 100644 --- a/WindowsForms/Calendar/cell-customization.md +++ b/WindowsForms/Calendar/cell-customization.md @@ -13,7 +13,7 @@ documentation: ug ## Special dates -The [SpecialDates](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_SpecialDates) helps you to hold the special dates collection with icon and description for dates which need to be highlighted. The `SpecialDates` contains the following properties to customize the cells:]() +The [SpecialDates](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_SpecialDates) property holds a collection of special dates with icons and descriptions for dates that need to be highlighted. The `SpecialDates` contains the following properties to customize the cells:]() * **BackColor**: The background color for the special date to fill the cell. * **Value**: The value for the special date. @@ -31,225 +31,227 @@ To customize the dates, use the following code example: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - SpecialDate specialDate1 = new SpecialDate(); +SpecialDate specialDate1 = new SpecialDate(); - SpecialDate specialDate2 = new SpecialDate(); +SpecialDate specialDate2 = new SpecialDate(); - SpecialDate specialDate3 = new SpecialDate(); +SpecialDate specialDate3 = new SpecialDate(); - SpecialDate specialDate4 = new SpecialDate(); +SpecialDate specialDate4 = new SpecialDate(); - List SpecialDates = new List(); - - specialDate1.BackColor = System.Drawing.Color.White; +List SpecialDates = new List(); - specialDate1.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, ((byte)(0))); +specialDate1.BackColor = System.Drawing.Color.White; - specialDate1.ForeColor = System.Drawing.Color.Magenta; +specialDate1.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, ((byte)(0))); - specialDate1.Image = Properties.Resources.icons_Womens_day; +specialDate1.ForeColor = System.Drawing.Color.Magenta; - specialDate1.Description = "International Women’s Day"; +specialDate1.Image = Properties.Resources.icons_Womens_day; - specialDate1.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate1.Description = "International Women’s Day"; - specialDate1.IsDateVisible = false; +specialDate1.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate1.IsDateVisible = false; - specialDate1.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; +specialDate1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate1.Value = new System.DateTime(2018, 3, 8, 0, 0, 0, 0); - - specialDate2.BackColor = System.Drawing.Color.White; +specialDate1.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; - specialDate2.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, ((byte)(0))); +specialDate1.Value = new System.DateTime(2018, 3, 8, 0, 0, 0, 0); + +specialDate2.BackColor = System.Drawing.Color.White; + +specialDate2.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, ((byte)(0))); - specialDate2.ForeColor = System.Drawing.Color.Magenta; +specialDate2.ForeColor = System.Drawing.Color.Magenta; - specialDate2.Description = "World Forestry Day"; +specialDate2.Description = "World Forestry Day"; - specialDate2.Image = Properties.Resources.Icon_World_Forestry_Day; +specialDate2.Image = Properties.Resources.Icon_World_Forestry_Day; - specialDate2.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate2.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate2.IsDateVisible = false; +specialDate2.IsDateVisible = false; - specialDate2.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate2.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate2.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; +specialDate2.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; - specialDate2.Value = new System.DateTime(2018, 3, 21, 0, 0, 0, 0); - - specialDate3.BackColor = System.Drawing.Color.White; +specialDate2.Value = new System.DateTime(2018, 3, 21, 0, 0, 0, 0); + +specialDate3.BackColor = System.Drawing.Color.White; - specialDate3.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, ((byte)(0))); +specialDate3.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, ((byte)(0))); - specialDate3.ForeColor = System.Drawing.Color.Magenta; +specialDate3.ForeColor = System.Drawing.Color.Magenta; - specialDate3.Image = Properties.Resources.Icon_Water_day; +specialDate3.Image = Properties.Resources.Icon_Water_day; - specialDate3.Description = "World Day for Water"; +specialDate3.Description = "World Day for Water"; - specialDate3.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate3.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate3.IsDateVisible = false; +specialDate3.IsDateVisible = false; - specialDate3.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate3.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate3.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; +specialDate3.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; - specialDate3.Value = new System.DateTime(2018, 3, 24, 0, 0, 0, 0); - - specialDate4.BackColor = System.Drawing.Color.White; +specialDate3.Value = new System.DateTime(2018, 3, 24, 0, 0, 0, 0); - specialDate4.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, ((byte)(0))); +specialDate4.BackColor = System.Drawing.Color.White; - specialDate4.ForeColor = System.Drawing.Color.Magenta; +specialDate4.Font = new System.Drawing.Font("Segoe UI", 11.25F, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, ((byte)(0))); - specialDate4.Image = Properties.Resources.Icon_Healthy_day; +specialDate4.ForeColor = System.Drawing.Color.Magenta; - specialDate4.Description = "World Health Day"; +specialDate4.Image = Properties.Resources.Icon_Healthy_day; - specialDate4.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate4.Description = "World Health Day"; - specialDate4.IsDateVisible = false; +specialDate4.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate4.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; +specialDate4.IsDateVisible = false; - specialDate4.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; +specialDate4.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; - specialDate4.Value = new System.DateTime(2018, 4, 7, 0, 0, 0, 0); +specialDate4.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage; - SpecialDates.Add(specialDate1); +specialDate4.Value = new System.DateTime(2018, 4, 7, 0, 0, 0, 0); - SpecialDates.Add(specialDate2); +SpecialDates.Add(specialDate1); - SpecialDates.Add(specialDate3); +SpecialDates.Add(specialDate2); - SpecialDates.Add(specialDate4); +SpecialDates.Add(specialDate3); - this.sfCalendar.SpecialDates = SpecialDates; +SpecialDates.Add(specialDate4); + +this.sfCalendar.SpecialDates = SpecialDates; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Private Sub InitializeComponent() - Me.components = New System.ComponentModel.Container - - Dim specialDate1 As SpecialDate = New SpecialDate +Me.components = New System.ComponentModel.Container - Dim specialDate2 As SpecialDate = New SpecialDate +Dim specialDate1 As SpecialDate = New SpecialDate - Dim specialDate3 As SpecialDate = New SpecialDate +Dim specialDate2 As SpecialDate = New SpecialDate - Dim specialDate4 As SpecialDate = New SpecialDate +Dim specialDate3 As SpecialDate = New SpecialDate - Dim SpecialDates As List(Of SpecialDate) = New List(Of SpecialDate) +Dim specialDate4 As SpecialDate = New SpecialDate - - specialDate1.BackColor = System.Drawing.Color.White +Dim SpecialDates As List(Of SpecialDate) = New List(Of SpecialDate) - specialDate1.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, CType(0,Byte)) - specialDate1.ForeColor = System.Drawing.Color.Magenta +specialDate1.BackColor = System.Drawing.Color.White - specialDate1.Image = Properties.Resources.icons_Womens_day +specialDate1.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, CType(0,Byte)) - specialDate1.Description = "International Womens Day" +specialDate1.ForeColor = System.Drawing.Color.Magenta - specialDate1.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate1.Image = Properties.Resources.icons_Womens_day - specialDate1.IsDateVisible = false +specialDate1.Description = "International Womens Day" - specialDate1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate1.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter - specialDate1.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage +specialDate1.IsDateVisible = false - specialDate1.Value = New Date(2018, 3, 8, 0, 0, 0, 0) +specialDate1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter - specialDate2.BackColor = System.Drawing.Color.White +specialDate1.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage - specialDate2.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, CType(0,Byte)) +specialDate1.Value = New Date(2018, 3, 8, 0, 0, 0, 0) - specialDate2.ForeColor = System.Drawing.Color.Magenta +specialDate2.BackColor = System.Drawing.Color.White - specialDate2.Description = "World Forestry Day" +specialDate2.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, CType(0,Byte)) - specialDate2.Image = Properties.Resources.Icon_World_Forestry_Day +specialDate2.ForeColor = System.Drawing.Color.Magenta - specialDate2.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate2.Description = "World Forestry Day" - specialDate2.IsDateVisible = false +specialDate2.Image = Properties.Resources.Icon_World_Forestry_Day - specialDate2.TextAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate2.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter - specialDate2.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage +specialDate2.IsDateVisible = false - specialDate2.Value = New Date(2018, 3, 21, 0, 0, 0, 0) +specialDate2.TextAlign = System.Drawing.ContentAlignment.MiddleCenter - specialDate3.BackColor = System.Drawing.Color.White +specialDate2.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage - specialDate3.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, CType(0,Byte)) +specialDate2.Value = New Date(2018, 3, 21, 0, 0, 0, 0) - specialDate3.ForeColor = System.Drawing.Color.Magenta +specialDate3.BackColor = System.Drawing.Color.White - specialDate3.Image = Properties.Resources.Icon_Water_day +specialDate3.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, CType(0,Byte)) - specialDate3.Description = "World Day for Water" +specialDate3.ForeColor = System.Drawing.Color.Magenta - specialDate3.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate3.Image = Properties.Resources.Icon_Water_day - specialDate3.IsDateVisible = false +specialDate3.Description = "World Day for Water" - specialDate3.TextAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate3.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter - specialDate3.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage +specialDate3.IsDateVisible = false - specialDate3.Value = New Date(2018, 3, 24, 0, 0, 0, 0) +specialDate3.TextAlign = System.Drawing.ContentAlignment.MiddleCenter - specialDate4.BackColor = System.Drawing.Color.White +specialDate3.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage - specialDate4.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, - System.Drawing.GraphicsUnit.Point, CType(0,Byte)) +specialDate3.Value = New Date(2018, 3, 24, 0, 0, 0, 0) - specialDate4.ForeColor = System.Drawing.Color.Magenta +specialDate4.BackColor = System.Drawing.Color.White - specialDate4.Image = Properties.Resources.Icon_Healthy_day +specialDate4.Font = New System.Drawing.Font("Segoe UI", 11.25!, System.Drawing.FontStyle.Italic, + System.Drawing.GraphicsUnit.Point, CType(0,Byte)) - specialDate4.Description = "World Health Day" +specialDate4.ForeColor = System.Drawing.Color.Magenta - specialDate4.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate4.Image = Properties.Resources.Icon_Healthy_day - specialDate4.IsDateVisible = false +specialDate4.Description = "World Health Day" - specialDate4.TextAlign = System.Drawing.ContentAlignment.MiddleCenter +specialDate4.ImageAlign = System.Drawing.ContentAlignment.MiddleCenter - specialDate4.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage +specialDate4.IsDateVisible = false - specialDate4.Value = New Date(2018, 4, 7, 0, 0, 0, 0) - - SpecialDates.Add(specialDate1) +specialDate4.TextAlign = System.Drawing.ContentAlignment.MiddleCenter - SpecialDates.Add(specialDate2) +specialDate4.TextImageRelation = System.Windows.Forms.TextImageRelation.TextBeforeImage - SpecialDates.Add(specialDate3) - - SpecialDates.Add(specialDate4) +specialDate4.Value = New Date(2018, 4, 7, 0, 0, 0, 0) + +SpecialDates.Add(specialDate1) + +SpecialDates.Add(specialDate2) + +SpecialDates.Add(specialDate3) - Me.sfCalendar.SpecialDates = SpecialDates +SpecialDates.Add(specialDate4) - End Sub +Me.sfCalendar.SpecialDates = SpecialDates + +End Sub {% endhighlight %} @@ -259,7 +261,7 @@ To customize the dates, use the following code example: ## ToolTip -This support is used to display additional information such as text or image about a cell in calendar in form of tooltip.The `ToolTipOpeningEventArgs` provides the following data for the [ToolTipOpening](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event of the calendar. All the [customization with tooltip](/windowsforms/tooltip/appearance) will be reflected in tooltip of cell in SfCalendar. +This feature is used to display additional information such as text or image about a cell in the calendar in the form of a tooltip.The `ToolTipOpeningEventArgs` provides the following data for the [ToolTipOpening](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event of the calendar. All the [customization with tooltip](/windowsforms/tooltip/appearance) will be reflected in tooltip of cell in SfCalendar. * ToolTipInfo: This option helps to set more information such as text or image about cell in calendar. @@ -278,71 +280,71 @@ This support is used to display additional information such as text or image abo * Handled: This option is used to handle the tooltip opening event. It will restrict to visibility of tooltip, and you can set own text or image as tooltip. -* ViewType: This option helps to represents the ViewType of calendar, whether it is month view or year view or decade view or century view. +* ViewType: This option helps to represent the ViewType of calendar, whether it is month view, year view, decade view, or century view. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - // Invoking the ToolTipOpening Event. - - this.SfCalendar1.DrawCell += SfCalendar_ToolTipOpening; - - //To show ToolTip - - private void SfCalendar_ToolTipOpening(SfCalendar sender, ToolTipOpeningEventArgs e) - { - if (e.ViewType == CalendarViewType.Month && e.Value.Value.Date == new DateTime(2018, 02, 14)) - { - e.ToolTipInfo.Items[0].Text = "Valentine's Day"; - } - if (e.ViewType == CalendarViewType.Year && e.Value.Value.Month == DateTime.Now.Month) - { - e.ToolTipInfo.Items[0].Text = e.Value.Value.Date.ToString("MMM"); - } - if (e.ViewType == CalendarViewType.Decade && e.RowIndex == 0) - { - e.ToolTipInfo.Items[0].Text = "Decade"; - } - if (e.ViewType == CalendarViewType.Century && e.ColumnIndex == 1) - { - e.ToolTipInfo.Items[0].Text = "Century"; - } - } +// Invoking the ToolTipOpening Event. + +this.sfCalendar.ToolTipOpening += SfCalendar_ToolTipOpening; + +//To show ToolTip + +private void SfCalendar_ToolTipOpening(SfCalendar sender, ToolTipOpeningEventArgs e) +{ + if (e.ViewType == CalendarViewType.Month && e.Value.Value.Date == new DateTime(2018, 02, 14)) + { + e.ToolTipInfo.Items[0].Text = "Valentine's Day"; + } + if (e.ViewType == CalendarViewType.Year && e.Value.Value.Month == DateTime.Now.Month) + { + e.ToolTipInfo.Items[0].Text = e.Value.Value.Date.ToString("MMM"); + } + if (e.ViewType == CalendarViewType.Decade && e.RowIndex == 0) + { + e.ToolTipInfo.Items[0].Text = "Decade"; + } + if (e.ViewType == CalendarViewType.Century && e.ColumnIndex == 1) + { + e.ToolTipInfo.Items[0].Text = "Century"; + } +} - {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - ' Invoking the ToolTipOpening Event. +' Invoking the ToolTipOpening Event. - AddHandler Me.sfCalendar.ToolTipOpening, AddressOf SfCalendar_ToolTipOpening +AddHandler Me.sfCalendar.ToolTipOpening, AddressOf SfCalendar_ToolTipOpening - ' To show ToolTip +' To show ToolTip - Private Sub SfCalendar_ToolTipOpening(ByVal sender As SfCalendar, ByVal e As ToolTipOpeningEventArgs) +Private Sub SfCalendar_ToolTipOpening(ByVal sender As SfCalendar, ByVal e As ToolTipOpeningEventArgs) - If e.ViewType = CalendarViewType.Month AndAlso e.Value.Value.Date = New Date(2018,02,14) Then - e.ToolTipInfo.Items(0).Text = "Valentine's Day" - End If - If e.ViewType = CalendarViewType.Year AndAlso e.Value.Value.Month = Date.Now.Date.Month Then - e.ToolTipInfo.Items(0).Text = e.Value.Value.Date.ToString("MMM") - End If - If e.ViewType = CalendarViewType.Decade AndAlso e.RowIndex = 0 Then - e.ToolTipInfo.Items(0).Text = "Decade" - End If - If e.ViewType = CalendarViewType.Century AndAlso e.ColumnIndex = 0 Then - e.ToolTipInfo.Items(0).Text = "Century" - End If + If e.ViewType = CalendarViewType.Month AndAlso e.Value.Value.Date = New Date(2018,02,14) Then + e.ToolTipInfo.Items(0).Text = "Valentine's Day" + End If + If e.ViewType = CalendarViewType.Year AndAlso e.Value.Value.Month = Date.Now.Month Then + e.ToolTipInfo.Items(0).Text = e.Value.Value.Date.ToString("MMM") + End If + If e.ViewType = CalendarViewType.Decade AndAlso e.RowIndex = 0 Then + e.ToolTipInfo.Items(0).Text = "Decade" + End If + If e.ViewType = CalendarViewType.Century AndAlso e.ColumnIndex = 1 Then + e.ToolTipInfo.Items(0).Text = "Century" + End If - End Sub +End Sub {% endhighlight %} - {% endtabs %} @@ -353,7 +355,7 @@ This support is used to display additional information such as text or image abo ## Render cell on-demand -This support is used to highlight or customize dates to mention some special date on-demand. The `DrawCellEventArgs` provides the following data for the [DrawCell](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event of the calendar. +This feature is used to highlight or customize dates on-demand to mark special dates. The `DrawCellEventArgs` provides the following data for the [DrawCell](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event of the calendar. * BackColor: Changes the background color of the date cell to draw in the calendar. @@ -384,7 +386,7 @@ This support is used to highlight or customize dates to mention some special dat * Handled: This option is used to handle the draw cell event. It will restrict to draw default text, and you can draw own text within the bounds of the cell. -* ViewType: This option helps to represents the ViewType of calendar, whether it is month view or year view or decade view or century view. +* ViewType: This option helps to represent the ViewType of calendar, whether it is month view, year view, decade view, or century view. The following code example illustrates how to customize the cell on-demand: @@ -392,91 +394,90 @@ The following code example illustrates how to customize the cell on-demand: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - // Invoking the DrawCell Event. - - this.SfCalendar1.DrawCell += SfCalendar1_DrawCell; - - - // To Draw the Cell - - private void SfCalendar1_DrawCell(SfCalendar sender, DrawCellEventArgs args) - - { - //Image for year view cell - Image image = null; - //Month View - if (e.ViewType == CalendarViewType.Month && e.Value.Value.Date == DateTime.Now.Date) - { - e.Handled = true; - TextRenderer.DrawText(e.Graphics, e.Value.Value.ToString("dd"), new Font("Segoe UI Bold", - this.sfCalendar1.Style.Cell.CellFont.Size), e.CellBounds, Color.Green); - - e.Graphics.FillRectangle(new SolidBrush(Color.Purple), new Rectangle((e.CellBounds.X + - (e.CellBounds.Width - e.CellBounds.Width / 2)) - 15, - (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)); - - e.Graphics.FillRectangle(new SolidBrush(Color.Orange), new Rectangle((e.CellBounds.X + - (e.CellBounds.Width - e.CellBounds.Width / 2)) + 5, - (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)); - } - - //Year View - if (e.ViewType == CalendarViewType.Year && e.Value.Value.Month == new DateTime(2018, 02, 14).Month - && e.Value.Value.Year == new DateTime(2018, 02, 14).Year) - { - e.Handled = true; - image = Properties.Resources.Icon_Valentines_day; - e.Graphics.DrawImage(image, e.CellBounds); - } - - } +// Invoking the DrawCell Event. + +this.sfCalendar1.DrawCell += SfCalendar1_DrawCell; + + +// To Draw the Cell + +private void SfCalendar1_DrawCell(SfCalendar sender, DrawCellEventArgs e) + +{ + //Image for year view cell + Image image = null; + //Month View + if (e.ViewType == CalendarViewType.Month && e.Value.Value.Date == DateTime.Now.Date) + { + e.Handled = true; + TextRenderer.DrawText(e.Graphics, e.Value.Value.ToString("dd"), new Font("Segoe UI Bold", + this.sfCalendar1.Style.Cell.CellFont.Size), e.CellBounds, Color.Green); + + e.Graphics.FillRectangle(new SolidBrush(Color.Purple), new Rectangle((e.CellBounds.X + + (e.CellBounds.Width - e.CellBounds.Width / 2)) - 15, + (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)); + + e.Graphics.FillRectangle(new SolidBrush(Color.Orange), new Rectangle((e.CellBounds.X + + (e.CellBounds.Width - e.CellBounds.Width / 2)) + 5, + (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)); + } + + //Year View + if (e.ViewType == CalendarViewType.Year && e.Value.Value.Month == new DateTime(2018, 02, 14).Month + && e.Value.Value.Year == new DateTime(2018, 02, 14).Year) + { + e.Handled = true; + image = Properties.Resources.Icon_Valentines_day; + e.Graphics.DrawImage(image, e.CellBounds); + } + +} {% endhighlight %} {% highlight VB %} - -InitializeComponent +Imports Syncfusion.WinForms.Input ' Invoking the DrawCell Event. -Me.SfCalendar1.DrawCell = (Me.SfCalendar1.DrawCell + SfCalendar1_DrawCell) +AddHandler Me.SfCalendar1.DrawCell, AddressOf SfCalendar1_DrawCell ' To Draw the Cell - Private Sub SfCalendar1_DrawCell(ByVal sender As SfCalendar, ByVal args As DrawCellEventArgs) + Private Sub SfCalendar1_DrawCell(ByVal sender As SfCalendar, ByVal e As DrawCellEventArgs) - 'Image for year view cell - Dim image As Image = Nothing + 'Image for year view cell + Dim image As Image = Nothing - 'Month View - If e.ViewType = CalendarViewType.Month AndAlso e.Value.Value.Date = Date.Now.Date Then - - e.Handled = True - TextRenderer.DrawText(e.Graphics, e.Value.Value.ToString("dd"), New Font("Segoe UI Bold", - Me.sfCalendar1.Style.Cell.CellFont.Size), e.CellBounds, Color.Green) - - e.Graphics.FillRectangle(New SolidBrush(Color.Purple), New Rectangle((e.CellBounds.X + - (e.CellBounds.Width - e.CellBounds.Width \ 2)) - 15, - (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)) + 'Month View + If e.ViewType = CalendarViewType.Month AndAlso e.Value.Value.Date = Date.Now.Date Then + + e.Handled = True + TextRenderer.DrawText(e.Graphics, e.Value.Value.ToString("dd"), New Font("Segoe UI Bold", + Me.sfCalendar1.Style.Cell.CellFont.Size), e.CellBounds, Color.Green) - e.Graphics.FillRectangle(New SolidBrush(Color.Orange), New Rectangle((e.CellBounds.X + - (e.CellBounds.Width - e.CellBounds.Width \ 2)) + 5, - (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)) + e.Graphics.FillRectangle(New SolidBrush(Color.Purple), New Rectangle((e.CellBounds.X + + (e.CellBounds.Width - e.CellBounds.Width \ 2)) - 15, + (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)) - End If + e.Graphics.FillRectangle(New SolidBrush(Color.Orange), New Rectangle((e.CellBounds.X + + (e.CellBounds.Width - e.CellBounds.Width \ 2)) + 5, + (e.CellBounds.Y + (e.CellBounds.Height - 20)) - 2, 12, 12)) - If e.ViewType = CalendarViewType.Year AndAlso e.Value.Value.Month = (New Date(2018, 02, 14)).Month - AndAlso e.Value.Value.Year = (New Date(2018, 02, 14)).Year Then + End If - e.Handled = True - image = My.Resources.Icon_Valentines_day - e.Graphics.DrawImage(image, e.CellBounds) - + If e.ViewType = CalendarViewType.Year AndAlso e.Value.Value.Month = (New Date(2018, 02, 14)).Month + AndAlso e.Value.Value.Year = (New Date(2018, 02, 14)).Year Then - End If + e.Handled = True + image = My.Resources.Icon_Valentines_day + e.Graphics.DrawImage(image, e.CellBounds) + + End If - End Sub +End Sub {% endhighlight %} diff --git a/WindowsForms/Calendar/globalization.md b/WindowsForms/Calendar/globalization.md index 3bc65b100..269397f37 100644 --- a/WindowsForms/Calendar/globalization.md +++ b/WindowsForms/Calendar/globalization.md @@ -18,6 +18,7 @@ The culture information can be applied to the calendar by using the [Culture](ht {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; //Setting the culture @@ -26,6 +27,7 @@ calendar.Culture = new CultureInfo("he-IL"); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting the culture @@ -53,13 +55,13 @@ The `SfCalendar` control allows you to localize the static text used in the cale ![Add resource file in application](globalization-images/NewItem.png) -* **Step 5**: The culture name that indicates the name of language and country. +* **Step 5**: The culture name indicates the name of the language and country. -* **Step 6**: Now, select Add option to add the resource file in Resources folder. +* **Step 6**: Now, select Add option to add the resource file in the Resources folder. ![Add culture resource file in application](globalization-images/resource.png) -* **Step 7**: Add the required text to the `NoneButtonText` and `TodayButtonText`. +* **Step 7**: Add the required text to the `NoneButtonText` and `TodayButtonText` fields. ![Add attribute values](globalization-images/resxfile.png) diff --git a/WindowsForms/Calendar/navigation.md b/WindowsForms/Calendar/navigation.md index baad89bb0..63be0922c 100644 --- a/WindowsForms/Calendar/navigation.md +++ b/WindowsForms/Calendar/navigation.md @@ -13,7 +13,7 @@ By default, the calendar displays the month view. You can move from current mont ## Different views -Calendar supports month, year, decade, and century views and provides intuitive interface through which you can navigate and quickly select dates. +Calendar supports month, year, decade, and century views and provides an intuitive interface through which you can navigate and quickly select dates. ![Navigation view](navigation-images/allview.png) @@ -24,6 +24,7 @@ You can choose the required view options in the calendar by the [ViewMode](https {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // setting Year and decade mode to display year and decade view @@ -32,6 +33,7 @@ calendar.ViewMode = Syncfusion.WinForms.Input.Enums.CalendarViewType.Year | Sync {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' setting Year and decade mode to display year and decade view @@ -43,7 +45,7 @@ calendar.ViewMode = Syncfusion.WinForms.Input.Enums.CalendarViewType.Year Or Syn ## Navigation through mouse -The navigation between next or previous range of dates for the current view in the calendar can be done by clicking up and down navigation buttons in the calendar header. The `SfCalendar` control allows you to navigate from one view to other view by clicking the header text of the calendar and selecting the cell from the view to navigate back to the next available view in the `ViewMode`. +The navigation between the next and previous ranges of dates for the current view in the calendar can be done by clicking up and down navigation buttons in the calendar header. The `SfCalendar` control allows you to navigate from one view to other view by clicking the header text of the calendar and selecting the cell from the view to navigate back to the next available view in the `ViewMode`. ## Navigation through keyboard @@ -51,15 +53,16 @@ The `SfCalendar` control allows you to navigate from one view to other view by p ## Navigation through touch -The navigation between next or previous range of dates for the current view in the calendar can be done by panning on the calendar view. The `SfCalendar` control allows you to navigate from one view to other view by tapping the header of the calendar. Tapping the cell in view navigates back to the next available view in the `ViewMode`. +The navigation between the next and previous ranges of dates for the current view in the calendar can be done by panning on the calendar view. The `SfCalendar` control allows you to navigate from one view to other view by tapping the header of the calendar. Tapping the cell in view navigates back to the next available view in the `ViewMode`. ## Handle view change -The [ViewChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event occurs when the calendar header text is clicked to change the view from one view to another view. The change of view can be restricted on-demand by handling the [ViewChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event. The `ViewChangingEventArgs` provides information about the old and new `ViewType`. This helps to restrict the view change in specific scenarios only. The following code example illustrates the same: +The [ViewChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event occurs when the calendar header text is clicked to change the calendar from one view to another. The change of view can be restricted on-demand by handling the [ViewChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html) event. The `ViewChangingEventArgs` provides information about the old and new `ViewType`. This helps to restrict the view change in specific scenarios only. The following code example illustrates the same: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Invoked when the view changed. @@ -82,10 +85,11 @@ The [ViewChanging](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinFor {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Invoked when the view changed. -calendar.ViewChanging += SfCalendar_ViewChanging +AddHandler calendar.ViewChanging, AddressOf SfCalendar_ViewChanging Private Sub SfCalendar_ViewChanging(ByVal sender As Syncfusion.WinForms.Input.SfCalendar, ByVal args As Syncfusion.WinForms.Input.Events.ViewChangingEventArgs) @@ -110,6 +114,7 @@ The [Navigating](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Invoked the Navigating event. @@ -132,10 +137,11 @@ private void SfCalendar_Navigating(SfCalendar sender, Syncfusion.WinForms.Input. {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Invoked the Navigating event. -Me.sfCalendar.Navigating = (Me.sfCalendar.Navigating + SfCalendar_Navigating) +AddHandler Me.sfCalendar.Navigating, AddressOf SfCalendar_Navigating Private Sub SfCalendar_Navigating(ByVal sender As SfCalendar, ByVal args As Syncfusion.WinForms.Input.Events.NavigatingEventArgs) @@ -155,11 +161,12 @@ End Sub ## Disable animation on navigation -The SfCalendar animates the content while navigating between different sets of date ranges or move from one view to another view. This animation can be disabled by setting the [EnableAnimation](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_EnableAnimation) to false. The following code example illustrates the same: +The SfCalendar animates the content while navigating between different sets of date ranges or moving from one view to another view. This animation can be disabled by setting the [EnableAnimation](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfCalendar.html#Syncfusion_WinForms_Input_SfCalendar_EnableAnimation) to false. The following code example illustrates the same: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Disabling the animation @@ -168,6 +175,7 @@ calendar.EnableAnimation = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Disabling the animation diff --git a/WindowsForms/Calendar/selection.md b/WindowsForms/Calendar/selection.md index 91bddf497..73f049929 100644 --- a/WindowsForms/Calendar/selection.md +++ b/WindowsForms/Calendar/selection.md @@ -13,11 +13,11 @@ The SfCalendar allows you to select one or more dates. The selected date in the ## Change selection -The `SfCalendar` control allows you to change the selection by clicking the specific date. +The `SfCalendar` control allows you to change the selection by clicking a specific date. ### Change selection through keyboard -The selected date of the `SfCalendar` control can be changed by the keyboard. `Up/Down` and `Left/Right` arrow keys help you to change the selection according to the key board interaction. +The selected date of the `SfCalendar` control can be changed by the keyboard. `Up/Down` and `Left/Right` arrow keys help you to change the selection according to the keyboard interaction. ### Change selection programmatically @@ -26,6 +26,7 @@ The selection of the calendar control can be changed programmatically by setting {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Move the current view to the date based on given value. Return value as false when the date is not fall within min max range or Blackout dates contains the date. @@ -37,6 +38,7 @@ if (calendar.GoToDate(new DateTime(2018,02,02))) {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Move the current view to the date based on given value. Return value as false when the date is not fall within min max range or Blackout dates contains the date. @@ -74,14 +76,14 @@ Gets the CalendarViewType of the cell to draw in SfCalendar; whether it is month {{ '[IsBlackoutDate](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.Events.CalendarCellEventArgs.html#Syncfusion_WinForms_Input_Events_CalendarCellEventArgs_IsBlackoutDate)' | markdownify }} -Gets a value that indicates whether the date of cell is SpecialDate in SfCalendar. +Gets a value that indicates whether the date of cell is BlackoutDate in SfCalendar. {{ '[DateRange](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.Events.CalendarCellEventArgs.html#Syncfusion_WinForms_Input_Events_CalendarCellEventArgs_DateRange)' | markdownify }} -Gets the StartDate and endDate range values of the clicked cell. +Gets the StartDate and EndDate range values of the clicked cell. -{{ '[IsWeekNumber](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.Events.CalendarCellEventArgs.html#Syncfusion_WinForms_Input_Events_CalendarCellEventArgs_IsSpecialDate)' | markdownify }} +{{ '[IsWeekNumber](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.Events.CalendarCellEventArgs.html#Syncfusion_WinForms_Input_Events_CalendarCellEventArgs_IsWeekNumber)' | markdownify }} Gets a value that indicates whether the date of cell is WeekNumber in SfCalendar. @@ -96,6 +98,11 @@ Gets the value of the clicked cell text. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; + +// Invoking the CellClick event. + +this.sfCalendar1.CellClick += SfCalendar1_CellClick; private void SfCalendar1_CellClick(object sender, Syncfusion.WinForms.Input.Events.CalendarCellEventArgs e) { @@ -111,6 +118,11 @@ private void SfCalendar1_CellClick(object sender, Syncfusion.WinForms.Input.Even {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input + +' Invoking the CellClick event. + +AddHandler Me.sfCalendar1.CellClick, AddressOf SfCalendar1_CellClick Private Sub SfCalendar1_CellClick(ByVal sender As Object, ByVal e As Syncfusion.WinForms.Input.Events.CalendarCellEventArgs) ' e.DateRange - Start and end range value of clicked cell @@ -133,6 +145,7 @@ The `SfCalendar` control allows you to select multiple dates when the [AllowMult {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Setting to Allow Multiple Selection @@ -141,6 +154,7 @@ calendar.AllowMultipleSelection = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting to Allow Multiple Selection @@ -161,17 +175,17 @@ The specific range of dates can be selected by pressing the `Shift`. Select a da The `SfCalendar` allows you to select multiple dates through the keyboard by selecting the cells while pressing `Shift + UP/DOWN/LEFT/RIGHT` and `Shift + HOME/END` arrow keys. -* Shift + UP: Selects previous week dates from the selected date. +* Shift + UP: Selects the dates in the previous week from the selected date. -* Shift + DOWN: Selects next week dates from the selected date. +* Shift + DOWN: Selects the dates in the next week from the selected date. -* Shift + RIGHT: Selects next date from the selected date. +* Shift + RIGHT: Selects the next date from the selected date. -* Shift + LEFT: Selects previous date from the selected date. +* Shift + LEFT: Selects the previous date from the selected date. -* Shift + HOME: Selects the date range from first day of month to the current selected date. +* Shift + HOME: Selects the date range from the first day of the month to the current selected date. -* Shift + END: Selects the date range from current selected date to the last date of a month. +* Shift + END: Selects the date range from the current selected date to the last date of a month. ### Multiple selection programmatically @@ -181,6 +195,7 @@ Multiple dates in the calendar control can be selected programmatically by addin {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; calendar.AllowMultipleSelection = true; @@ -202,6 +217,29 @@ calendar.SelectedDates.Add(new DateTime(2018, 02, 18)); {% endhighlight %} +{% highlight VB %} +Imports Syncfusion.WinForms.Input + +calendar.AllowMultipleSelection = True + +calendar.BlackoutDates.Add(New DateTime(2018, 02, 12)) + +calendar.SelectedDates.Add(New DateTime(2018, 02, 12)) + +calendar.SelectedDates.Add(New DateTime(2018, 02, 13)) + +calendar.SelectedDates.Add(New DateTime(2018, 02, 14)) + +calendar.SelectedDates.Add(New DateTime(2018, 02, 15)) + +calendar.SelectedDates.Add(New DateTime(2018, 02, 16)) + +calendar.SelectedDates.Add(New DateTime(2018, 02, 17)) + +calendar.SelectedDates.Add(New DateTime(2018, 02, 18)) + +{% endhighlight %} + {% endtabs %} ![Multiple date selection](selection-images/multiselection.png) @@ -213,6 +251,7 @@ The `BlackoutDates` refers the disabled dates that restrict the user from select {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; //Setting the Blackout Dates @@ -228,17 +267,17 @@ calendar.BlackoutDates = time; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - 'Setting the Blackout Dates +'Setting the Blackout Dates - Dim weekends = GetDaysBetween(minDateTimeEdit.Value.Value, maxDateTimeEdit.Value.Value).Where(() => { }, ((d.DayOfWeek = DayOfWeek.Saturday) _ - OrElse (d.DayOfWeek = DayOfWeek.Sunday))) +Dim weekends = GetDaysBetween(minDateTimeEdit.Value.Value, maxDateTimeEdit.Value.Value).Where(Function(d) d.DayOfWeek = DayOfWeek.Saturday OrElse d.DayOfWeek = DayOfWeek.Sunday) - Dim time As List(Of DateTime) = New List(Of DateTime) +Dim time As List(Of DateTime) = New List(Of DateTime) - time = weekends.ToList +time = weekends.ToList - calendar.BlackoutDates = time +calendar.BlackoutDates = time {% endhighlight %} @@ -259,12 +298,13 @@ Sometimes, the value should be restricted between some date ranges. In that scen {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Setting the Minimum and Maximum date Syncfusion.WinForms.Input.SfCalendar calendar = new Syncfusion.WinForms.Input.SfCalendar(); -calendar.Value = new DateTime(2018, 1, 12); +calendar.SelectedDate = new DateTime(2018, 1, 12); calendar.MinDate = new DateTime(2018, 1, 05); @@ -273,16 +313,17 @@ calendar.MaxDate = new DateTime(2018, 1, 25); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Setting the Minimum and Maximum date Dim calendar As New Syncfusion.WinForms.Input.SfCalendar () -calendar.Value = New DateTime(2018, 1, 12) +calendar.SelectedDate = New DateTime(2018, 1, 12) -calendar.MinDate = new DateTime(2018, 1, 05) +calendar.MinDate = New DateTime(2018, 1, 05) -calendar.MaxDate = new DateTime(2018, 1, 25) +calendar.MaxDate = New DateTime(2018, 1, 25) {% endhighlight %} @@ -310,6 +351,7 @@ The following code example illustrates how to restrict the selection change on-d {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Invoking selection changing event @@ -343,14 +385,15 @@ private void SfCalendar_SelectionChanged(object sender, EventArgs e) {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Invoking selection changing event -calendar.SelectionChanging = (Me.sfCalendar.SelectionChanging + SfCalendar_SelectionChanging) +AddHandler calendar.SelectionChanging, AddressOf SfCalendar_SelectionChanging ' Invoking selection changed event -calendar.SelectionChanged = (Me.sfCalendar.SelectionChanged + SfCalendar_SelectionChanged) +AddHandler calendar.SelectionChanged, AddressOf SfCalendar_SelectionChanged ' Occurs before the selected date changed in Calendar. @@ -383,6 +426,7 @@ Selected dates of the calendar control can be removed from the selection by prog {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Clear the selected dates and set the new date as selected date @@ -390,6 +434,15 @@ calendar.ClearSelection(new DateTime(2018, 02, 16)); {% endhighlight %} +{% highlight VB %} +Imports Syncfusion.WinForms.Input + +' Clear the selected dates and set the new date as selected date + +calendar.ClearSelection(New DateTime(2018, 02, 16)) + +{% endhighlight %} + {% endtabs %} ![Clear selection dates](selection-images/selection.png) @@ -401,6 +454,7 @@ Weekends of the calendar can be disabled by providing the Date collection to [Bl {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // disabling the weekends @@ -414,6 +468,23 @@ for (var date = sfCalendar1.MinDate; date <= sfCalendar1.MaxDate; date = date.Ad {% endhighlight %} +{% highlight VB %} +Imports Syncfusion.WinForms.Input + +' disabling the weekends + +sfCalendar1.MinDate = New DateTime(2000, 1, 5) +sfCalendar1.MaxDate = New DateTime(2500, 1, 25) +Dim [date] As DateTime = sfCalendar1.MinDate +While [date] <= sfCalendar1.MaxDate + If [date].DayOfWeek = DayOfWeek.Sunday OrElse [date].DayOfWeek = DayOfWeek.Saturday Then + sfCalendar1.BlackoutDates.Add([date]) + End If + [date] = [date].AddDays(1) +End While + +{% endhighlight %} + {% endtabs %} -![Disable WeekEnds](selection-images/disable_Weekends.png) +![Disable Weekends](selection-images/disable_Weekends.png) From 999d76b0353f72478166c4f583a910e7480a54b3 Mon Sep 17 00:00:00 2001 From: GokulSF4339 Date: Wed, 22 Jul 2026 23:49:14 +0530 Subject: [PATCH 35/36] Task(1036752): Updated UG revamp work for WF DateTimeEdit control. --- WindowsForms/DateTimePicker/Appearance.md | 280 +++++++++--------- WindowsForms/DateTimePicker/DateRange.md | 12 +- .../DateTimePicker/DateTimeDisplayPattern.md | 22 +- .../DateTimePicker/Editing-Support.md | 22 +- .../DateTimePicker/Getting-Started.md | 30 +- WindowsForms/DateTimePicker/Globalization.md | 8 +- WindowsForms/DateTimePicker/Overview.md | 20 +- WindowsForms/DateTimePicker/navigation.md | 14 +- WindowsForms/DateTimePicker/righttoleft.md | 6 +- WindowsForms/DateTimePicker/validation.md | 22 +- WindowsForms/DateTimePicker/watermark.md | 12 +- 11 files changed, 246 insertions(+), 202 deletions(-) diff --git a/WindowsForms/DateTimePicker/Appearance.md b/WindowsForms/DateTimePicker/Appearance.md index 8a414c14d..5b172080f 100644 --- a/WindowsForms/DateTimePicker/Appearance.md +++ b/WindowsForms/DateTimePicker/Appearance.md @@ -19,7 +19,7 @@ The BackColor, ForeColor, and BorderColor of the control can be customized by us * ForeColor - To change the foreground color of date-time text in DateTimeEdit. * WatermarkForeColor - To change the color to draw the Watermark Text that displays in DateTimeEdit when the Value is null. * BorderColor - To change the border color of DateTimeEdit. -* DisabledBackColor - To change the border color of DateTimeEdit in disabled or readonly state. +* DisabledBackColor - To change the background color of DateTimeEdit in disabled or readonly state. * DisabledForeColor - To change the foreground color of date-time text in disabled or readonly state. * FocusedBorderColor - To change the border color of DateTimeEdit in focused state. * HoverBorderColor - To change the border color of DateTimeEdit in mouse hover state. @@ -29,14 +29,16 @@ The following code snippets illustrates the customization. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - sfDateTimeEdit1.Style.BorderColor = Color.Red; +sfDateTimeEdit1.Style.BorderColor = Color.Red; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - sfDateTimeEdit1.Style.BorderColor = Color.Red +sfDateTimeEdit1.Style.BorderColor = Color.Red {% endhighlight %} @@ -55,39 +57,41 @@ The BackColor and ForeColor of drop-down icon to open the calendar can be custom * HoverForeColor - To change the foreground color of dropdown icon in mouse hover state. * PressedForeColor - To change the foreground color of dropdown icon in pressed state. -The following code snippets illustrates the same. +The following code snippets illustrate the same. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - //Setting the DropDown Fore color +//Setting the DropDown Fore color - this.dateTimeEdit.Style.DropDown.ForeColor = Color.Purple; - this.dateTimeEdit.Style.DropDown.HoverForeColor = Color.Yellow; - this.dateTimeEdit.Style.DropDown.PressedForeColor = Color.Green; +this.dateTimeEdit.Style.DropDown.ForeColor = Color.Purple; +this.dateTimeEdit.Style.DropDown.HoverForeColor = Color.Yellow; +this.dateTimeEdit.Style.DropDown.PressedForeColor = Color.Green; - //Setting the DropDown Back color +//Setting the DropDown Back color - this.sfDateTimeEdit1.Style.DropDown.BackColor = Color.Aqua; - this.sfDateTimeEdit1.Style.DropDown.HoverBackColor = Color.Gray; - this.sfDateTimeEdit1.Style.DropDown.PressedBackColor = Color.Orange; +this.sfDateTimeEdit1.Style.DropDown.BackColor = Color.Aqua; +this.sfDateTimeEdit1.Style.DropDown.HoverBackColor = Color.Gray; +this.sfDateTimeEdit1.Style.DropDown.PressedBackColor = Color.Orange; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - 'Setting the DropDown Fore color +'Setting the DropDown Fore color - Me.dateTimeEdit.Style.DropDown.ForeColor = Color.Purple - Me.dateTimeEdit.Style.DropDown.HoverForeColor = Color.Yellow - Me.dateTimeEdit.Style.DropDown.PressedForeColor = Color.Green +Me.dateTimeEdit.Style.DropDown.ForeColor = Color.Purple +Me.dateTimeEdit.Style.DropDown.HoverForeColor = Color.Yellow +Me.dateTimeEdit.Style.DropDown.PressedForeColor = Color.Green - 'Setting the DropDown Back color +'Setting the DropDown Back color - Me.sfDateTimeEdit1.Style.DropDown.BackColor = Color.Aqua - Me.sfDateTimeEdit1.Style.DropDown.HoverBackColor = Color.Gray - Me.sfDateTimeEdit1.Style.DropDown.PressedBackColor = Color.Orange +Me.sfDateTimeEdit1.Style.DropDown.BackColor = Color.Aqua +Me.sfDateTimeEdit1.Style.DropDown.HoverBackColor = Color.Gray +Me.sfDateTimeEdit1.Style.DropDown.PressedBackColor = Color.Orange {% endhighlight %} @@ -106,14 +110,16 @@ Note: The recommended size for the custom image is 16x16 pixels. If the image is {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - this.dateTimeEdit.DateTimeIcon = Image.FromFile(@"Images/calendar.png"); +this.dateTimeEdit.DateTimeIcon = Image.FromFile(@"Images/calendar.png"); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - Me.dateTimeEdit.DateTimeIcon = Image.FromFile(@"Images/calendar.png"); +Me.dateTimeEdit.DateTimeIcon = Image.FromFile(@"Images/calendar.png"); {% endhighlight %} @@ -128,42 +134,28 @@ The drop-down button in the SfDateTimeEdit allows you to open the pop-up calenda {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - //Enable the DropDown Button -<<<<<<< HEAD +//Enable the DropDown Button - this.dateTimeEdit.ShowDropDown = true; +this.dateTimeEdit.ShowDropDown = true; - //Disable the DropDown Button +//Disable the DropDown Button -======= - - this.dateTimeEdit.ShowDropDown = true; - - //Disable the DropDown Button - ->>>>>>> 664175cf483e78a9bac155018dbdc92b8216b891 - this.dateTimeEdit.ShowDropDown = false; +this.dateTimeEdit.ShowDropDown = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - 'Enable the DropDown Button +'Enable the DropDown Button -<<<<<<< HEAD - Me.dateTimeEdit.ShowDropDown = true +Me.dateTimeEdit.ShowDropDown = true - 'Disable the DropDown Button +'Disable the DropDown Button - Me.dateTimeEdit.ShowDropDown = false -======= - Me.dateTimeEdit.ShowDropDown = true - - 'Disable the DropDown Button - - Me.dateTimeEdit.ShowDropDown = false ->>>>>>> 664175cf483e78a9bac155018dbdc92b8216b891 +Me.dateTimeEdit.ShowDropDown = false {% endhighlight %} @@ -175,34 +167,36 @@ The drop-down button in the SfDateTimeEdit allows you to open the pop-up calenda The ForeColor of up-down icon in the `SfDateTimeEdit` can be customized by the following `Style` properties. The following `style` properties of the SfDateTimeEdit can be used to change the color of up-down icon in different states: -* UpDownForeColor - To change the foreground color of updown icon in DateTimeEdit. -* UpDownHoverForeColor - To change the foreground color of updown icon in mouse hover state. -* UpDownBackColor - To change the background color of updown icon in DateTimeEdit. -* UpDownHoverBackColor - To change the background color of updown icon in mouse hover state. +* UpDownForeColor - To change the foreground color of up-down icon in DateTimeEdit. +* UpDownHoverForeColor - To change the foreground color of up-down icon in mouse hover state. +* UpDownBackColor - To change the background color of up-down icon in DateTimeEdit. +* UpDownHoverBackColor - To change the background color of up-down icon in mouse hover state. -The following code snippets illustrates the same. +The following code snippets illustrate the same. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - //Setting the UpDown Fore color +//Setting the UpDown Fore color - this.dateTimeEdit.Style.UpDownForeColor = Color.HotPink; - this.dateTimeEdit.Style.UpDownHoverForeColor = Color.Blue; - this.dateTimeEdit.Style.UpDownBackColor = Color.LightGray; - this.dateTimeEdit.Style.UpDownHoverBackColor = Color.Yellow; +this.dateTimeEdit.Style.UpDownForeColor = Color.HotPink; +this.dateTimeEdit.Style.UpDownHoverForeColor = Color.Blue; +this.dateTimeEdit.Style.UpDownBackColor = Color.LightGray; +this.dateTimeEdit.Style.UpDownHoverBackColor = Color.Yellow; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - 'Setting the UpDown Fore color +'Setting the UpDown Fore color - Me.dateTimeEdit.Style.UpDownForeColor = Color.HotPink - Me.dateTimeEdit.Style.UpDownHoverForeColor = Color.Blue - Me.dateTimeEdit.Style.UpDownBackColor = Color.LightGray - Me.dateTimeEdit.Style.UpDownHoverBackColor = Color.Yellow +Me.dateTimeEdit.Style.UpDownForeColor = Color.HotPink +Me.dateTimeEdit.Style.UpDownHoverForeColor = Color.Blue +Me.dateTimeEdit.Style.UpDownBackColor = Color.LightGray +Me.dateTimeEdit.Style.UpDownHoverBackColor = Color.Yellow {% endhighlight %} @@ -217,26 +211,28 @@ The up-down allows you to change the value by increment or decrement of values o {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - //Enable the UpDown Button +//Enable the UpDown Button - this.dateTimeEdit.ShowUpDown = true; +this.dateTimeEdit.ShowUpDown = true; - //Disable the UpDown Button +//Disable the UpDown Button - this.dateTimeEdit.ShowUpDown = false; +this.dateTimeEdit.ShowUpDown = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - 'Enable the UpDown Button +'Enable the UpDown Button - Me.dateTimeEdit.ShowUpDown = true +Me.dateTimeEdit.ShowUpDown = true - 'Disable the UpDown Button +'Disable the UpDown Button - Me.dateTimeEdit.ShowUpDown = false +Me.dateTimeEdit.ShowUpDown = false {% endhighlight %} @@ -246,19 +242,21 @@ The up-down allows you to change the value by increment or decrement of values o ## Customize drop-down calendar appearance -The drop-down calendar of the SfDateTimeEdit can be obtained from the [MonthCalendar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MonthCalendar) property. All the [customization with calendar](/windowsforms/calendar/appearance) will be reflected in drop-down calendar of the SfDateTimeEdit. The following code snippets illustrates how to change the visibility of footer in the drop-down calendar of the SfDateTimeEdit: +The drop-down calendar of the SfDateTimeEdit can be obtained from the [MonthCalendar](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MonthCalendar) property. All the [customization with calendar](/windowsforms/calendar/appearance) will be reflected in drop-down calendar of the SfDateTimeEdit. The following code snippets illustrate how to change the visibility of footer in the drop-down calendar of the SfDateTimeEdit: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - dateTimeEdit.MonthCalendar.ShowFooter = false; +dateTimeEdit.MonthCalendar.ShowFooter = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - dateTimeEdit.MonthCalendar.ShowFooter = false +dateTimeEdit.MonthCalendar.ShowFooter = false {% endhighlight %} @@ -273,20 +271,22 @@ The size of the drop-down calendar can be customized by using the [DropDownSize] {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - //Setting DropDownSize +//Setting DropDownSize - this.dateTimeEdit.DropDownSize = new Size(294, 293); - this.dateTimeEdit.Width = 294; +this.dateTimeEdit.DropDownSize = new Size(294, 293); +this.dateTimeEdit.Width = 294; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - 'Setting DropDownSize +'Setting DropDownSize - Me.dateTimeEdit.DropDownSize = New Size(294, 293) - Me.dateTimeEdit.Width = 294 +Me.dateTimeEdit.DropDownSize = New Size(294, 293) +Me.dateTimeEdit.Width = 294 {% endhighlight %} @@ -301,10 +301,11 @@ Week numbers can be displayed by setting [ShowWeekNumbers](https://help.syncfusi {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - //Setting ShowWeekNumbers +//Setting ShowWeekNumbers - sfDateTimeEdit1.MonthCalendar.ShowWeekNumbers = true; +sfDateTimeEdit1.MonthCalendar.ShowWeekNumbers = true; {% endhighlight %} @@ -314,7 +315,7 @@ Week numbers can be displayed by setting [ShowWeekNumbers](https://help.syncfusi ## Themes -SfDateTimeEdit offers four built in themes for professional representation as follows. +SfDateTimeEdit offers four built-in themes for professional representation as follows. * Office2016Colorful * Office2016White @@ -330,46 +331,46 @@ Theme can be applied to SfDateTimeEdit by following the below steps: **Syncfusion.Office2016Theme.WinForms** assembly should be added as reference to set theme for SfDateTimeEdit in any application: -Before apply theme to SfDateTimeEdit, required theme assembly should be loaded as follows. +Before applying theme to SfDateTimeEdit, required theme assembly should be loaded as follows. {% tabs %} {% highlight C# %} - - using Syncfusion.WinForms.Controls; - - static class Program +using Syncfusion.WinForms.Input; +using Syncfusion.WinForms.Controls; + +static class Program +{ + /// + /// The main entry point for the application. + /// + + static void Main() { - /// - /// The main entry point for the application. - /// - - static void Main() - { - SfSkinManager.LoadAssembly(typeof(Office2016Theme).Assembly); - Application.EnableVisualStyles(); - Application.SetCompatibleTextRenderingDefault(false); - Application.Run(new Form1()); - } + SfSkinManager.LoadAssembly(typeof(Office2016Theme).Assembly); + Application.EnableVisualStyles(); + Application.SetCompatibleTextRenderingDefault(false); + Application.Run(new Form1()); } +} {% endhighlight %} {% highlight VB %} - - Imports Syncfusion.WinForms.Controls - - Friend Module Program - ''' - ''' The main entry point for the application. - ''' - Sub Main() - SfSkinManager.LoadAssembly(GetType(Office2016Theme).Assembly) - Application.EnableVisualStyles() - Application.SetCompatibleTextRenderingDefault(False) - Application.Run(New Form1()) - End Sub - End Module +Imports Syncfusion.WinForms.Input +Imports Syncfusion.WinForms.Controls + +Friend Module Program + ''' + ''' The main entry point for the application. + ''' + Sub Main() + SfSkinManager.LoadAssembly(GetType(Office2016Theme).Assembly) + Application.EnableVisualStyles() + Application.SetCompatibleTextRenderingDefault(False) + Application.Run(New Form1()) + End Sub +End Module {% endhighlight %} @@ -386,18 +387,20 @@ This option helps to set the Office2016Colorful Theme. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - // Office2016Colorful +// Office2016Colorful - this.dateTimeEdit.ThemeName = "Office2016Colorful"; +this.dateTimeEdit.ThemeName = "Office2016Colorful"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - ' Office2016Colorful +' Office2016Colorful - Me.dateTimeEdit.ThemeName = "Office2016Colorful" +Me.dateTimeEdit.ThemeName = "Office2016Colorful" {% endhighlight %} @@ -412,27 +415,20 @@ This option helps to set the Office2016White Theme. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - // Office2016White +// Office2016White -<<<<<<< HEAD - this.dateTimeEdit.ThemeName = "Office2016White"; -======= - this.dateTimeEdit.ThemeName = "Office2016White"; ->>>>>>> 664175cf483e78a9bac155018dbdc92b8216b891 +this.dateTimeEdit.ThemeName = "Office2016White"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - ' Office2016White - -<<<<<<< HEAD -======= - ' Office2016White +' Office2016White ->>>>>>> 664175cf483e78a9bac155018dbdc92b8216b891 - Me.dateTimeEdit.ThemeName = "Office2016White" +Me.dateTimeEdit.ThemeName = "Office2016White" {% endhighlight %} @@ -447,22 +443,20 @@ This option helps to set the Office2016DarkGray Theme. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - // Office2016DarkGray +// Office2016DarkGray -<<<<<<< HEAD - this.dateTimeEdit.ThemeName = "Office2016DarkGray"; -======= - this.dateTimeEdit.ThemeName = "Office2016DarkGray"; ->>>>>>> 664175cf483e78a9bac155018dbdc92b8216b891 +this.dateTimeEdit.ThemeName = "Office2016DarkGray"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - ' Office2016DarkGray +' Office2016DarkGray - Me.dateTimeEdit.ThemeName = "Office2016DarkGray" +Me.dateTimeEdit.ThemeName = "Office2016DarkGray" {% endhighlight %} @@ -477,22 +471,20 @@ This option helps to set the Office2016Black Theme. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; - // Office2016Black +// Office2016Black -<<<<<<< HEAD - this.dateTimeEdit.ThemeName = "Office2016Black"; -======= - this.dateTimeEdit.ThemeName = "Office2016Black"; ->>>>>>> 664175cf483e78a9bac155018dbdc92b8216b891 +this.dateTimeEdit.ThemeName = "Office2016Black"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input - ' Office2016Black +' Office2016Black - Me.dateTimeEdit.ThemeName = "Office2016Black" +Me.dateTimeEdit.ThemeName = "Office2016Black" {% endhighlight %} diff --git a/WindowsForms/DateTimePicker/DateRange.md b/WindowsForms/DateTimePicker/DateRange.md index de6ebf9fa..b53640ccb 100644 --- a/WindowsForms/DateTimePicker/DateRange.md +++ b/WindowsForms/DateTimePicker/DateRange.md @@ -9,13 +9,13 @@ documentation: ug # DateRange in Windows Forms DateTimePicker (SfDateTimeEdit) -Prevents user from setting a date and time within a specified range can be achieved by using [MinDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MinDateTime) and [MaxDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MaxDateTime) properties of the SfDateTimeEdit. +The user can be prevented from setting a date and time outside a specified range by using the [MinDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MinDateTime) and [MaxDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MaxDateTime) properties of the SfDateTimeEdit. ## Change the value The date and time of the SfDateTimeEdit can be changed by the [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Value) property. The value can be set to null when the [AllowNull](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_AllowNull) is true. The default mode of the DateTimeEditing only allows you to change the selected value to null; the mask mode will not allow you to change the value to null. The value can also be edited by selecting the `DateTimeField` and editing the value. This value will be validated when the control lost its focus or the enter key is pressed. -The [ValueChanged](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html) event will be invoked when the change is occurred in the `Value` property of the SfDateTimeEdit. If you need to do any custom actions while value changed, that can be done at the ValueChanged event. +The [ValueChanged](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html) event will be invoked when the change is occurred in the `Value` property of the SfDateTimeEdit. If you need to do any custom actions while the value changes, that can be done at the ValueChanged event. ### Change value by DateTimeText @@ -23,17 +23,18 @@ The value of the SfDateTimeEdit can also be changed by the [DateTimeText](https: ## Minimum DateTime -The [MinDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MinDateTime) helps you to restrict the DateTime value which is lesser than the specific DateTime value. If the `Value` of SfDateTimeEdit is less than `MinDateTime`, then the value property will be reset to MinDateTime. The `MinDateTime` should be lesser than the `MaxDateTime` of the SfDateTimeEdit. When the MinDateTime is set, if the new `MinDateTime` value is greater than the `MaxDateTime`, then the MaxDateTime will be reset to the MinDateTime. +The [MinDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MinDateTime) helps you to restrict the DateTime value which is lesser than the specific DateTime value. If the `Value` of SfDateTimeEdit is less than `MinDateTime`, then the `Value` property will be reset to MinDateTime. The `MinDateTime` should be lesser than the `MaxDateTime` of the SfDateTimeEdit. When the MinDateTime is set, if the new `MinDateTime` value is greater than the `MaxDateTime`, then the MaxDateTime will be reset to the MinDateTime. ## Maximum DateTime -The [MaxDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MaxDateTime) helps you to restrict the DateTime value that is set greater than the specific DateTime value. If the `Value` of SfDateTimeEdit is greater than `MaxDateTime`, then the value property will be reset to MaxDateTime. The `MaxDateTime` should be greater than `MinDateTime` of the SfDateTimeEdit. When the MaxDateTime is set, if the `MinDateTime` property is greater than the new `MaxDateTime`, then the MinDateTime will be reset to the MaxDateTime. +The [MaxDateTime](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_MaxDateTime) helps you to restrict the DateTime value that is set greater than the specific DateTime value. If the `Value` of SfDateTimeEdit is greater than `MaxDateTime`, then the `Value` property will be reset to MaxDateTime. The `MaxDateTime` should be greater than `MinDateTime` of the SfDateTimeEdit. When the MaxDateTime is set, if the `MinDateTime` property is greater than the new `MaxDateTime`, then the MinDateTime will be reset to the MaxDateTime. Sometimes, the value should be restricted in between some particular date range. For example, consider a project for the hotel reservation system. The “In DateTime” has to be lesser than the “Out DateTime” and vice versa. So “In DateTime” has to be set as minimum DateTime and “Out DateTime” has to be set as maximum DateTime in the `SfDateTimeEdit` control. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -48,6 +49,7 @@ dateTimeEdit.MaxDateTime = new DateTime(2018, 2, 22); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit @@ -72,6 +74,7 @@ The [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Inpu {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; private void DateTimeEdit_ValueChanged(object sender, EventArgs e) { @@ -81,6 +84,7 @@ private void DateTimeEdit_ValueChanged(object sender, EventArgs e) {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Private Sub DateTimeEdit_ValueChanged(ByVal sender As Object, ByVal e As EventArgs) diff --git a/WindowsForms/DateTimePicker/DateTimeDisplayPattern.md b/WindowsForms/DateTimePicker/DateTimeDisplayPattern.md index 59e3fd755..76dfbd15c 100644 --- a/WindowsForms/DateTimePicker/DateTimeDisplayPattern.md +++ b/WindowsForms/DateTimePicker/DateTimeDisplayPattern.md @@ -22,18 +22,19 @@ The `SfDateTimeEdit` control supports the following DateTime format: * FullDateTime * MonthDay * Custom -* ShortableDateTime -* UniversalShortableDateTime +* SortableDateTime +* UniversalSortableDateTime * RFC1123 * YearMonth ![date time edit pattern](datetimepattern-images/allpattern.png) -The different display formats of the DateTime can be set by the [DateTimePattern](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimePattern) property. The following code snippet illustrates how to set the format as LongDate: +The different display formats of the DateTime can be set by using the [DateTimePattern](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimePattern) property. The following code snippet illustrates how to set the format as LongDate: {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -46,6 +47,7 @@ dateTimeEdit.DateTimePattern = DateTimePattern.LongDate; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit @@ -66,21 +68,22 @@ dateTimeEdit.DateTimePattern = DateTimePattern.LongDate The custom pattern can be displayed in the `SfDateTimeEdit` control by using the [Format](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Format) property. Refer to the following list to create the custom format for the `SfDateTimeEdit`: * d: Day of the month. -* ddd: Short name of day of the week. +* ddd: Abbreviated day of the week name. * dddd: Full name of day of the week. * M: The month, from 1 to 12. -* MMM: Short name of Month. -* MMMM: Long name of the Month. -* yy: Last two digit of year. -* yyyy: Full Year. +* MMM: Short name of month. +* MMMM: Long name of the month. +* yy: Last two digits of the year. +* yyyy: Full year. * hh: Hour. * mm: Minutes. * ss: Seconds. -* tt: The AM/PM Meridiem. +* tt: The AM/PM indicator. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -97,6 +100,7 @@ dateTimeEdit.Format = "MM/dd/yy hh:mm:ss"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit diff --git a/WindowsForms/DateTimePicker/Editing-Support.md b/WindowsForms/DateTimePicker/Editing-Support.md index eb88c9ca8..de722fc97 100644 --- a/WindowsForms/DateTimePicker/Editing-Support.md +++ b/WindowsForms/DateTimePicker/Editing-Support.md @@ -16,11 +16,12 @@ The DateTime value of the `SfDateTimeEdit` control can be updated by editing the ## Default editing -The DateTime can be edited in the textbox of the `SfDateTimeEdit` control when the [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) is default. In default editing mode, the value can be assigned in any valid format. Even if the text box text is not in the correct pattern, the SfDateTimeEdit control automatically updates the value in the correct pattern on lost focus. i.e, if the date time pattern is LongDate with pattern "dddd, MMMM dd, yyyy" and date is entered as "Mar 28 2017" in the editing text box, the DateTimeText will be automatically converted according to the LongDate pattern while pressing the enter key or on lost focus of the control. +The DateTime can be edited in the textbox of the `SfDateTimeEdit` control when the [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) is default. In default editing mode, the value can be assigned in any valid format. Even if the text box text is not in the correct pattern, the SfDateTimeEdit control automatically updates the value in the correct pattern on lost focus. i.e., if the date time pattern is LongDate with pattern "dddd, MMMM dd, yyyy" and date is entered as "Mar 28 2017" in the editing text box, the DateTimeText will be automatically converted according to the LongDate pattern while pressing the Enter key or on lost focus of the control. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -33,8 +34,9 @@ dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Default; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input -Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input. +Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit Me.Controls.Add(dateTimeEdit) @@ -50,11 +52,12 @@ dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Default ## Mask editing -The mask edit mode provides an easy and reliable way of collecting user input and displaying standard data in a specific format. In mask editing mode, the date will be separated into different fields such as date, month, year, minutes, hours, and seconds. The field can be updated by selecting the field and pressing the up or down arrow to increase or decrease the selected field respectively. +The mask edit mode provides an easy and reliable way of collecting user input and displaying standard data in a specific format. In mask editing mode, the date will be separated into different fields such as date, month, year, minutes, hours, and seconds. The field can be updated by selecting the field and pressing the up or down arrow to increment or decrease the selected field, respectively. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -67,6 +70,7 @@ dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Mask; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit @@ -84,23 +88,25 @@ dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Mask ## ReadOnly -This control supports `ReadOnly` which is used to restrict edit date and time fields in the `SfDateTimeEdit`. By setting the [ReadOnly](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_ReadOnly) to **true**, you can restrict the text editing in the `SfDateTimeEdit` and you can change the value only by clicking up-down buttons or pick the date from the drop-down `SfCalendar`. +This control supports `ReadOnly` which is used to restrict editing of date and time fields in the `SfDateTimeEdit`. By setting the [ReadOnly](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_ReadOnly) to **true**, you can restrict the text editing in the `SfDateTimeEdit` and you can change the value only by clicking the up-down buttons or picking the date from the drop-down `SfCalendar`. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; -//Enable the User interactions +//Enable the ReadOnly to restrict editing -this.dateTimeEdit.ReadOnly = false; +this.dateTimeEdit.ReadOnly = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input -'Enable the User interactions +'Enable the ReadOnly to restrict editing -Me.dateTimeEdit.ReadOnly = false +Me.dateTimeEdit.ReadOnly = true {% endhighlight %} diff --git a/WindowsForms/DateTimePicker/Getting-Started.md b/WindowsForms/DateTimePicker/Getting-Started.md index 6643dcf26..c10ad3c84 100644 --- a/WindowsForms/DateTimePicker/Getting-Started.md +++ b/WindowsForms/DateTimePicker/Getting-Started.md @@ -49,14 +49,14 @@ The following steps describe how to create an **SfDateTimeEdit** control program {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; using Syncfusion.WinForms.Input; {% endhighlight %} {% highlight VB %} - -Imports Syncfusion.WinForms.Input +Imports Syncfusion.WinForms.Input {% endhighlight %} @@ -70,6 +70,7 @@ Imports Syncfusion.WinForms.Input {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; SfDateTimeEdit sfDateTimeEdit = new SfDateTimeEdit(); @@ -78,8 +79,9 @@ this.Controls.Add(sfDateTimeEdit); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input -Dim SfDateTimeEdit As New SfDateTimeEdit() +Dim sfDateTimeEdit As New SfDateTimeEdit() Me.Controls.Add(sfDateTimeEdit) @@ -96,6 +98,7 @@ In a real-time appointment scenario, the appointment is open only for a limited {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -110,6 +113,7 @@ dateTimeEdit.MaxDateTime = new DateTime(2018, 2, 27); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As New Syncfusion.WinForms.Input.SfDateTimeEdit() @@ -129,22 +133,24 @@ dateTimeEdit.MaxDateTime = New DateTime(2018, 2, 27) ## Editing mode -The date-time value in the DateTimeEdit can be edited by two ways as follows. +The date-time value in the DateTimeEdit can be edited in two ways as follows. * Default Editing * Mask Editing -Editing modes can be changed using the [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) property of SfDateTimEdit. The following code example demonstrates how to change the date-time editing mode. +Editing modes can be changed using the [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) property of SfDateTimeEdit. The following code example demonstrates how to change the date-time editing mode. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Mask; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Mask @@ -156,11 +162,12 @@ dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Mask ## Allow null value -The **SfDateTimEdit** allows you to set [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Value) to null in the mask mode of DateTimeEditing when [AllowNull](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_AllowNull) is set to true. +The **SfDateTimeEdit** allows you to set [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Value) to null in the mask mode of DateTimeEditing when [AllowNull](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_AllowNull) is set to true. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Mask; @@ -171,6 +178,7 @@ dateTimeEdit.Watermark = "Choose a date"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input dateTimeEdit.DateTimeEditingMode = DateTimeEditingMode.Mask @@ -182,7 +190,7 @@ dateTimeEdit.Watermark = "Choose a date" {% endtabs %} -![SfDateTimEdit allows null value](watermark-images/watermark.png) +![SfDateTimeEdit allows null value](watermark-images/watermark.png) ## Custom format @@ -191,6 +199,7 @@ The custom pattern can be displayed in the **SfDateTimeEdit** control using the {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; dateTimeEdit.Value = new DateTime(2018, 2, 5); @@ -203,6 +212,7 @@ dateTimeEdit.Format = "MM/dd/yy hh:mm:ss"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input dateTimeEdit.Value = New DateTime(2018, 2, 5) @@ -220,11 +230,12 @@ dateTimeEdit.Format = "MM/dd/yy hh:mm:ss" ## Configure up-down -You can edit value of DateTimeEdit using the up-down button by setting the [ShowUpDown](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_ShowUpDown) property to `true`. The up-down button appears only when [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) is set to mask. +You can edit the value of DateTimeEdit using the up-down button by setting the [ShowUpDown](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_ShowUpDown) property to `true`. The up-down button appears only when [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) is set to mask. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; //Enable the UpDown Button @@ -233,6 +244,7 @@ this.dateTimeEdit.ShowUpDown = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input 'Enable the UpDown Button @@ -251,6 +263,7 @@ You can get the current week number in `SfDateTimeEdit` control by changing the {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; SfDateTimeEdit sfdateTimeEdit1 = new SfDateTimeEdit(); CultureInfo info = new CultureInfo("en-EN"); @@ -260,6 +273,7 @@ sfdateTimeEdit1.Culture = info; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim sfdateTimeEdit1 As SfDateTimeEdit = New SfDateTimeEdit() Dim info As CultureInfo = New CultureInfo("en-EN") diff --git a/WindowsForms/DateTimePicker/Globalization.md b/WindowsForms/DateTimePicker/Globalization.md index 5e84ae9f0..80e5a25b3 100644 --- a/WindowsForms/DateTimePicker/Globalization.md +++ b/WindowsForms/DateTimePicker/Globalization.md @@ -14,6 +14,7 @@ The `SfDateTimeEdit` control provides globalization support that allows you to d {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; System.Threading.Thread.CurrentThread.CurrentCulture = new System.Globalization.CultureInfo("pt-BR"); @@ -22,6 +23,7 @@ System.Threading.Thread.CurrentThread.CurrentUICulture = new System.Globalizatio {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input System.Threading.Thread.CurrentThread.CurrentCulture = New System.Globalization.CultureInfo("pt-BR") @@ -33,11 +35,12 @@ System.Threading.Thread.CurrentThread.CurrentUICulture = New System.Globalizatio ## Change culture -By default, the `SfDateTimeEdit` supports system's current culture. Based on the usage, the culture of `SfDateTimeEdit` can be changed by using the [Culture](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Culture) property. The date and time information displayed in the `SfDateTimeEdit` can be changed based on culture changes. +By default, the `SfDateTimeEdit` supports the system's current culture. The culture of the `SfDateTimeEdit` can be changed by using the [Culture](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Culture) property. The date and time information displayed in the `SfDateTimeEdit` can be changed based on culture changes. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -50,6 +53,7 @@ dateTimeEdit.Culture = new CultureInfo("en-US"); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit @@ -68,6 +72,7 @@ dateTimeEdit.Culture = New CultureInfo("en-US") {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -80,6 +85,7 @@ dateTimeEdit.Culture = new CultureInfo("fr-FR"); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As New Syncfusion.WinForms.Input.SfDateTimeEdit() diff --git a/WindowsForms/DateTimePicker/Overview.md b/WindowsForms/DateTimePicker/Overview.md index ad494a6a2..cc239b462 100644 --- a/WindowsForms/DateTimePicker/Overview.md +++ b/WindowsForms/DateTimePicker/Overview.md @@ -1,7 +1,7 @@ --- layout: post title: Overview of SfDateTimeEdit control | Windows Forms | Syncfusion -description: SfDateTimeEdit allows user to edit the DateTime in the text with the support of minimum and maximum value validation, watermark, etc., +description: SfDateTimeEdit allows the user to edit the DateTime in the text with the support of minimum and maximum value validation, watermark, etc., platform: WindowsForms control: SfDateTimeEdit documentation: ug @@ -15,13 +15,13 @@ The **SfDateTimeEdit** is a control that allows you to edit DateTime in the text ## Key Features -**Editing mode** - Supports the default text editing and mask mode that helps to restrict the date input in formatted values based on a date-time pattern. +**Editing mode** - Supports the default text editing and mask mode that restricts date input to formatted values based on a date-time pattern. -**Date-range support** - Supports the maximum and minimum dates to prevent users from setting a date or time within a specified range. +**Date-range support** - Supports the maximum and minimum dates to prevent users from setting a date or time outside a specified range. **Globalization** - Supports different date-time formats and patterns based on cultures. -**Date validation** - Supports date validation and error messages due to invalid dates or when date range constraints are met. +**Date validation** - Supports date validation and error messages due to invalid dates or when date range constraints are violated. **Accessibility** - Provides touch, keyboard, and mouse support to make applications available to a wide variety of users. @@ -39,15 +39,15 @@ Syncfusion WinForms suite comes up with the following different DateTime control ### SfDateTimeEdit -The [SfDateTimeEdit](https://help.syncfusion.com/windowsforms/datetimepicker/overview) control allows you to edit date-time in the text or mask format with minimum and maximum values validation, watermark, and globalization support. Provides flexible options to display date-time according to the required format. +The [SfDateTimeEdit](https://help.syncfusion.com/windowsforms/datetimepicker/overview) control allows you to edit date-time in the text or mask format with minimum and maximum values validation, watermark, and globalization support. It provides flexible options to display the date-time according to the required format. ### DateTimePickerAdv -[DateTimePickerAdv](https://help.syncfusion.com/windowsforms/classic/datetimepicker/overview) is an advanced DateTimePicker control. Provides an easy way to implement a culture based DateTimePicker in an application. Support for a string to be displayed when the user does not want a specific date selected. +[DateTimePickerAdv](https://help.syncfusion.com/windowsforms/classic/datetimepicker/overview) is an advanced DateTimePicker control. It provides an easy way to implement a culture based DateTimePicker in an application. It displays a string when no specific date is selected. ### SfDateTimeEdit vs DateTimePickerAdv -Both SfDateTimeEdit and DateTimePickerAdv controls are used for the same purpose. But, the SfDateTimeEdit control offers rich set of features over DateTimePickerAdv. To customize the updown and dropdown buttons, use DateTimePickerAdv. For date range support, watermark, navigation, and date validation, use SfDateTimeEdit. +Both SfDateTimeEdit and DateTimePickerAdv controls are used for the same purpose. But, the SfDateTimeEdit control offers a rich set of features over DateTimePickerAdv. To customize the updown and dropdown buttons, use DateTimePickerAdv. For date range support, watermark, navigation, and date validation, use SfDateTimeEdit. The list of some of the specific API differences between SfDateTimeEdit and DateTimePickerAdv is as follows. @@ -93,7 +93,7 @@ MinDateTime MinValue -Sets the time less than specific date-time. +Sets the minimum selectable date-time. @@ -104,7 +104,7 @@ MaxDateTime MaxValue -Sets the time greater than specific date-time. +Sets the maximum selectable date-time. @@ -144,7 +144,7 @@ Support for free style editing with different {{'[mode](https://help.syncfusion. Date validation -Shows error messages on the invalid dates or when date-range constraints are met. To learn more about date validation in SfDateTimeEdit, refer to {{'[here](https://help.syncfusion.com/windowsforms/datetimepicker/validation)'| markdownify }}. +Shows error messages on the invalid dates or when date-range constraints are violated. To learn more about date validation in SfDateTimeEdit, refer to {{'[here](https://help.syncfusion.com/windowsforms/datetimepicker/validation)'| markdownify }}. diff --git a/WindowsForms/DateTimePicker/navigation.md b/WindowsForms/DateTimePicker/navigation.md index 168176b29..2848c7211 100644 --- a/WindowsForms/DateTimePicker/navigation.md +++ b/WindowsForms/DateTimePicker/navigation.md @@ -1,7 +1,7 @@ --- layout: post title: Keyboard and Mouse interaction | SfDateTimeEdit | Syncfusion -description: SfDateTimeEdit control provides an functionality to navigation and value changes through the keyboard and mouse interaction. +description: SfDateTimeEdit control provides functionality for navigation and value changes through the keyboard and mouse interaction. platform: WindowsForms control: SfDateTimeEdit documentation: ug @@ -9,13 +9,13 @@ documentation: ug # Navigation in Windows Forms DateTimePicker (SfDateTimeEdit) -The `SfDateTimeEdit` provides navigation and `Value` changes through the keyboard and mouse interaction in mask mode of the `DateTimeEditMode`, and also provides free style text editing support for date and time information. The `SfDateTimeEdit` allows you to change the [SelectedField](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_SelectedField) by using Right and Left arrows through keyboard interaction and this can be restricted by setting the [InterceptArrowKeys](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_InterceptArrowKeys) to `false`. +The `SfDateTimeEdit` provides navigation and `Value` changes through the keyboard and mouse interaction in mask mode of the `DateTimeEditingMode`, and also provides free style text editing support for date and time information. The `SfDateTimeEdit` allows you to change the [SelectedField](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_SelectedField) by using Right and Left arrows through keyboard interaction and this can be restricted by setting the [InterceptArrowKeys](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_InterceptArrowKeys) to `false`. ## Navigate to drop-down calendar The drop-down calendar control to pick the date `Value` for `SfDateTimeEdit` can be opened by Alt+Down arrow combinations. The drop-down calendar can be closed by Alt+Up and Alt+Down key combinations if the drop-down calendar is already opened. The state of drop-down calendar can be obtained from [ShowDropDown](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_ShowDropDown) of the SfDateTimeEdit. -The drop-down calendar provides key board support to change the selected date by using the keyboard. The date from different month, year, or decade can be selected by navigating to next view on pressing Ctrl+Up and navigate back to the old view on pressing Ctrl+Down key combinations. The selection in views can be changed by Right and Left arrows. +The drop-down calendar provides keyboard support to change the selected date by using the keyboard. The date from a different month, year, or decade can be selected by navigating to the next view on pressing Ctrl+Up and navigate back to the old view on pressing Ctrl+Down key combinations. The selection in views can be changed by Right and Left arrows. ### Handle drop-down calendar programmatically @@ -24,12 +24,14 @@ The drop-down calendar can be opened by [ShowPopup](https://help.syncfusion.com/ {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; dateTimeEdit.ShowPopup(); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input dateTimeEdit.ShowPopup() @@ -42,12 +44,14 @@ The drop-down calendar can be closed by the [ClosePopup](https://help.syncfusion {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; dateTimeEdit.ClosePopup(); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input dateTimeEdit.ClosePopup() @@ -61,13 +65,14 @@ In `Mask` edit mode, the `Value` of `SfDateTimeEdit` can be changed through Enter key is pressed, so that the control lost its focus or the date is picked from the drop-down calendar. +The `SfDateTimeEdit` control validates the DateTime value when the Enter key is pressed, when the control loses its focus, or when a date is picked from the drop-down calendar. ## Validation reset option -The [ValidationOption](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_ValidationOption) that helps you to decide how the value will be changed when the validation is failed. If the validation is failed, the value will reset with previous date-time [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Value) or `MinValue` or `MaxValue`. If the validating event is not handled then the validation will be done based on the `ValidationOption` of the SfDateTimeEdit. +The [ValidationOption](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_ValidationOption) property determines how the value changes when the validation fails. If the validation fails, the value will reset to the previous date-time [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Value) or `MinValue` or `MaxValue`. If the validating event is not handled, then the validation will be done based on the `ValidationOption` of the SfDateTimeEdit. The validation results can be obtained based on the input provided to `Value` or `DateTimeText` of the SfDateTimeEdit. If the provided input has invalid date-time format or value that meets minimum or maximum value constraint, then the validation results will be failed. -* **Reset**: A control that maintains the previous value before validating. If the validation is failed then the value will be reset with the previous value. +* **Reset**: A control that maintains the previous value before validating. If the validation fails, then the value will be reset to the previous value. -* **MinValue**: Resets value with the `MinValue`, when the validation is failed. +* **MinValue**: Resets the value to `MinValue`, when the validation fails. -* **MaxValue**: Resets value with the `MaxValue`, when the validation is failed. +* **MaxValue**: Resets the value to `MaxValue`, when the validation fails. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; -Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); +SfDateTimeEdit dateTimeEdit = new SfDateTimeEdit(); this.Controls.Add(dateTimeEdit); @@ -42,8 +43,9 @@ dateTimeEdit.ValidationOption = ValidationResetOption.MinValue; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input -Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit +Dim dateTimeEdit As SfDateTimeEdit = New SfDateTimeEdit Me.Controls.Add(dateTimeEdit) @@ -65,7 +67,7 @@ The given value can be treated as a date/time value. It can be validated based o ## Handle validation -The `ValidatingEventArgs` provides data for the [Validating](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html) event of the SfDateTimeEdit control. By handling the `Validating` event, it is possible to find the cause for validation failure with error message in the `ValidatingEventArgs`. +The `ValidatingEventArgs` provides data for the [Validating](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html) event of the SfDateTimeEdit control. By handling the `Validating` event, it is possible to find the cause for validation failure with the error message in the `ValidatingEventArgs`. * **IsError**: Indicates whether the entered date and time is valid or invalid. @@ -74,6 +76,7 @@ The `ValidatingEventArgs` provides data for the [Validating](https://help.syncfu {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; // Invoking Validating event @@ -96,10 +99,11 @@ private void DateTimeEdit_Validating(object sender, ValidatingEventArgs e) {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input ' Invoking Validating event -Me.dateTimeEdit.Validating = (Me.dateTimeEdit.Validating + DateTimeEdit_Validating) +AddHandler Me.dateTimeEdit.Validating, AddressOf DateTimeEdit_Validating Private Sub DateTimeEdit_Validating(ByVal sender As Object, ByVal e As ValidatingEventArgs) diff --git a/WindowsForms/DateTimePicker/watermark.md b/WindowsForms/DateTimePicker/watermark.md index 392ddaae5..5b3fc7360 100644 --- a/WindowsForms/DateTimePicker/watermark.md +++ b/WindowsForms/DateTimePicker/watermark.md @@ -13,13 +13,14 @@ The `SfDateTimeEdit` control allows you to set the [Value](https://help.syncfusi ## Null value -The `SfDateTimeEdit` control accepts null values only when the [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) is default. The NullValue support in the `SfDateTimeEdit` control can be enabled by setting the [AllowNull](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_AllowNull) property to true. If the value is null and the editing text box is empty then the `Watermark` will be displayed as the text in the `SfDateTimeEdit` control. +The `SfDateTimeEdit` control accepts null values only when the [DateTimeEditingMode](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_DateTimeEditingMode) is default. The null value support in the `SfDateTimeEdit` control can be enabled by setting the [AllowNull](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_AllowNull) property to true. If the value is null and the editing text box is empty then the `Watermark` will be displayed as the text in the `SfDateTimeEdit` control. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; -Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); +SfDateTimeEdit dateTimeEdit = new SfDateTimeEdit(); this.Controls.Add(dateTimeEdit); @@ -30,8 +31,9 @@ dateTimeEdit.Value = null; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input -Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit +Dim dateTimeEdit As SfDateTimeEdit = New SfDateTimeEdit Me.Controls.Add(dateTimeEdit) @@ -47,11 +49,12 @@ dateTimeEdit.Value = Nothing ## Change watermark -The watermark is a help content that is used to display in the `SfDateTimeEdit` control when the [AllowNull](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_AllowNull) property is true and the [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Value) property is set to null. The `Watermark` text will be displayed only when the control lost its focus. The context of the watermark text can be assigned by setting the `Watermark` of the SfDateTimeEdit. +The watermark is help content that displays in the `SfDateTimeEdit` control when the [AllowNull](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_AllowNull) property is true and the [Value](https://help.syncfusion.com/cr/windowsforms/Syncfusion.WinForms.Input.SfDateTimeEdit.html#Syncfusion_WinForms_Input_SfDateTimeEdit_Value) property is set to null. The `Watermark` text will be displayed only when the control loses its focus. The content of the watermark text can be assigned by setting the `Watermark` of the SfDateTimeEdit. {% tabs %} {% highlight C# %} +using Syncfusion.WinForms.Input; Syncfusion.WinForms.Input.SfDateTimeEdit dateTimeEdit = new Syncfusion.WinForms.Input.SfDateTimeEdit(); @@ -66,6 +69,7 @@ dateTimeEdit.Watermark = "Choose a date"; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.WinForms.Input Dim dateTimeEdit As Syncfusion.WinForms.Input.SfDateTimeEdit = New Syncfusion.WinForms.Input.SfDateTimeEdit From e6af5562153bab6f91252305c1997c2496bc8b40 Mon Sep 17 00:00:00 2001 From: GokulSF4339 Date: Wed, 22 Jul 2026 23:52:37 +0530 Subject: [PATCH 36/36] Task(1036752): Updated UG revamp work for WF Clock control. --- ...ance-and-Structure-of-the-Clock-Control.md | 22 +- ...ng-Custom-Renderer-to-the-Clock-Control.md | 73 ++++--- WindowsForms/clock/Digital-Clock.md | 189 +++++++++--------- WindowsForms/clock/Getting-Started.md | 22 +- WindowsForms/clock/Overview.md | 8 +- 5 files changed, 175 insertions(+), 139 deletions(-) diff --git a/WindowsForms/clock/Appearance-and-Structure-of-the-Clock-Control.md b/WindowsForms/clock/Appearance-and-Structure-of-the-Clock-Control.md index 67880e630..b63e29c93 100644 --- a/WindowsForms/clock/Appearance-and-Structure-of-the-Clock-Control.md +++ b/WindowsForms/clock/Appearance-and-Structure-of-the-Clock-Control.md @@ -15,11 +15,12 @@ The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms ### Customizing color to the Clock -The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control has individual property to set color for [gradient back color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_StartGradientBackColor), [hour hands color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_HourHandColor), [minutes color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_MinuteHandColor), and [border color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_BorderColor). +The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control has individual properties to set colors for [gradient back color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_StartGradientBackColor), [hour hands color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_HourHandColor), [minutes color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_MinuteHandColor), and [border color](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_BorderColor). {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; this.clock1.BorderColor = Color.Violet; @@ -38,6 +39,7 @@ this.clock1.StartGradientBackColor = Color.Black; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools Me.clock1.BorderColor = Color.Violet @@ -51,7 +53,7 @@ Me.clock1.MinuteHandColor = Color.LightSeaGreen Me.clock1.SecondHandColor = Color.LightSteelBlue -Me.clock1.StartGradientBackColor +Me.clock1.StartGradientBackColor = Color.Black {% endhighlight %} @@ -62,7 +64,7 @@ Me.clock1.StartGradientBackColor ## Appearance setting -The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control allows you to customize the thickness of the hand and minute line. It also allows you to enable or disable the AM/PM, borders, minute, and second hand. The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control gives a transparent appearance. +The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control allows you to customize the thickness of the hands and minute line. It also allows you to enable or disable the AM/PM, borders, minute, and second hand. The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control supports a transparent appearance. ### Customization of hands thickness @@ -71,6 +73,7 @@ Clock control allows you to adjust the thickness of hands and minute line. {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; this.clock1.HourHandThickness = 7; @@ -83,6 +86,7 @@ this.clock1.MinuteThickness = 4; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools Me.clock1.HourHandThickness = 7 @@ -107,6 +111,7 @@ The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; this.clock1.ShowAMorPM = true; @@ -119,6 +124,7 @@ this.clock1.ShowSecondHand = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools Me.clock1.ShowAMorPM = True @@ -136,17 +142,19 @@ Me.clock1.ShowSecondHand = False ## Transparent support -Clock control supports transparent back ground. +Clock control supports a transparent background. {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; this.clock1.IsTransparent = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools Me.clock1.IsTransparent = True @@ -160,12 +168,13 @@ Me.clock1.IsTransparent = True ### How to show a fixed time in the Clock control -The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control usually displays the current time on the machine where it is hosted. To freeze the clock to display a fixed time, the Boolean property [StopTimer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_StopTimer) can be used. Then, using the Clock control’s [Now](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_Now) property, the desired time can be displayed or the default time will be displayed. +The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control usually displays the current time on the machine where it is hosted. To freeze the clock to display a fixed time, the Boolean property [StopTimer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_StopTimer) can be used. Then, using the Clock control's [Now](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_Now) property, the desired time can be displayed; otherwise, the default time will be shown. {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; //Gets or sets the value to freeze or unfreeze time in the clock. @@ -174,8 +183,9 @@ this.clock1.StopTimer = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -//Gets or sets the value to freeze or unfreeze time in the clock. +'Gets or sets the value to freeze or unfreeze time in the clock. Me.clock1.StopTimer = True diff --git a/WindowsForms/clock/Applying-Custom-Renderer-to-the-Clock-Control.md b/WindowsForms/clock/Applying-Custom-Renderer-to-the-Clock-Control.md index e393aabbe..eeccd94c5 100644 --- a/WindowsForms/clock/Applying-Custom-Renderer-to-the-Clock-Control.md +++ b/WindowsForms/clock/Applying-Custom-Renderer-to-the-Clock-Control.md @@ -7,14 +7,16 @@ control: Clock-Control-for-Windows-Forms documentation: ug --- -# Applying Custom Renderer to the Clock Control in Windows Forms Clock +# Applying Custom Renderer to the Clock Control in Windows Forms ## Customization of rendering by overriding the method -[Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control enables you to customize the [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control by applying the custom renderer. +The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control can be customized by applying a custom renderer. {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; + CustomRenderer renderer = new CustomRenderer(); this.clock1.Renderer = renderer; public class CustomRenderer : ClockRenderer @@ -60,38 +62,45 @@ public class CustomRenderer : ClockRenderer } {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools + Private renderer As New CustomRenderer() Me.clock1.Renderer = renderer -public class CustomRenderer : ClockRenderer -public override void DrawInterior(Graphics g, Single thickness, PointF startPoint, PointF endPoint, Color color, String sender) -If sender = "SecondsHand" Then -g.SmoothingMode = SmoothingMode.AntiAlias -Dim p As New Pen(color, thickness + thickness) -p.StartCap = LineCap.SquareAnchor -p.EndCap = LineCap.ArrowAnchor -g.DrawLine(p, startPoint, endPoint) -p.Dispose() -ElseIf sender = "MinutesHand" Then -g.SmoothingMode = SmoothingMode.AntiAlias -Dim p As New Pen(color, thickness + thickness) -p.StartCap = LineCap.SquareAnchor -p.EndCap = LineCap.ArrowAnchor -g.DrawLine(p, startPoint, endPoint) -p.Dispose() -ElseIf sender = "HoursHand" Then -g.SmoothingMode = SmoothingMode.AntiAlias -Dim p As New Pen(color, thickness + thickness) -p.StartCap = LineCap.SquareAnchor -p.EndCap = LineCap.ArrowAnchor -g.DrawLine(p, startPoint, endPoint) -p.Dispose() -Else -g.SmoothingMode = SmoothingMode.AntiAlias -Dim p As New Pen(color, 5) -p.DashStyle = DashStyle.Dot -g.DrawLine(p, startPoint, endPoint) -p.Dispose() -End If + +Public Class CustomRenderer + Inherits ClockRenderer + + Public Overrides Sub DrawInterior(ByVal g As Graphics, ByVal thickness As Single, ByVal startPoint As PointF, ByVal endPoint As PointF, ByVal color As Color, ByVal sender As String) + If sender = "SecondsHand" Then + g.SmoothingMode = SmoothingMode.AntiAlias + Dim p As New Pen(color, thickness + thickness) + p.StartCap = LineCap.SquareAnchor + p.EndCap = LineCap.ArrowAnchor + g.DrawLine(p, startPoint, endPoint) + p.Dispose() + ElseIf sender = "MinutesHand" Then + g.SmoothingMode = SmoothingMode.AntiAlias + Dim p As New Pen(color, thickness + thickness) + p.StartCap = LineCap.SquareAnchor + p.EndCap = LineCap.ArrowAnchor + g.DrawLine(p, startPoint, endPoint) + p.Dispose() + ElseIf sender = "HoursHand" Then + g.SmoothingMode = SmoothingMode.AntiAlias + Dim p As New Pen(color, thickness + thickness) + p.StartCap = LineCap.SquareAnchor + p.EndCap = LineCap.ArrowAnchor + g.DrawLine(p, startPoint, endPoint) + p.Dispose() + Else + g.SmoothingMode = SmoothingMode.AntiAlias + Dim p As New Pen(color, 5) + p.DashStyle = DashStyle.Dot + g.DrawLine(p, startPoint, endPoint) + p.Dispose() + End If + End Sub +End Class {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/clock/Digital-Clock.md b/WindowsForms/clock/Digital-Clock.md index d233499ec..7f6b569c5 100644 --- a/WindowsForms/clock/Digital-Clock.md +++ b/WindowsForms/clock/Digital-Clock.md @@ -9,19 +9,21 @@ documentation: ug # Digital Clock in Windows Forms Clock -The DigitalClock is implemented as an extension to the existing [Windows Forms Clock](https://www.syncfusion.com/winforms-ui-controls/clock) control in the UI controls, but offers a richer UI experience than the existing clock and is capable of displaying the time as digital text. +The DigitalClock is implemented as an extension to the existing [Windows Forms Clock](https://www.syncfusion.com/winforms-ui-controls/clock) control. It offers a richer UI experience than the existing clock and is capable of displaying the time as digital text. You can use the DigitalClock in your application by simply switching the [ClockType](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ClockType) of the existing [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control as described in the following sample code: {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; this.clock1.ClockType = Syncfusion.Windows.Forms.Tools.ClockTypes.Digital; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools Me.clock1.ClockType = Syncfusion.Windows.Forms.Tools.ClockTypes.Digital @@ -35,24 +37,26 @@ The DigitalClock offers a wide range of options to customize its appearance. It ### Frames -To enable the background frames, the DigitalClock should be enabled with the property [ShowClockFrame](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowClockFrame) set to `true`. +To enable the background frames, set the [ShowClockFrame](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowClockFrame) property to `true`. #### Rectangular frame {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = true; +this.clock1.ShowClockFrame = true; - this.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.RectangularFrame; +this.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.RectangularFrame; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools - Me.clock1.ShowClockFrame = true - Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.RectangularFrame +Me.clock1.ShowClockFrame = True +Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.RectangularFrame {% endhighlight %} @@ -65,17 +69,19 @@ To enable the background frames, the DigitalClock should be enabled with the pro {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = true; +this.clock1.ShowClockFrame = true; - this.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.CircularFrame; +this.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.CircularFrame; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -Me.clock1.ShowClockFrame = true -Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.CircularFrame +Me.clock1.ShowClockFrame = True +Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.CircularFrame {% endhighlight %} @@ -90,17 +96,19 @@ Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.CircularFram {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = true; +this.clock1.ShowClockFrame = true; - this.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.SquareFrame; +this.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.SquareFrame; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -Me.clock1.ShowClockFrame = true -Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.SquareFrame +Me.clock1.ShowClockFrame = True +Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.SquareFrame {% endhighlight %} @@ -110,24 +118,26 @@ Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.SquareFrame ### Shapes -To enable background shapes in the [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control, the [ShowClockFrame](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowClockFrame) property should be disabled so that the control can support rendering the background shapes. +To enable background shapes in the [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control, set the [ShowClockFrame](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowClockFrame) property to `false` to enable the background shapes. #### Rectangular shape {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = false; +this.clock1.ShowClockFrame = false; - this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Rectangle; +this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Rectangle; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -Me.clock1.ShowClockFrame = False -Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.CircularFrame +Me.clock1.ShowClockFrame = False +Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Rectangle {% endhighlight %} @@ -142,17 +152,19 @@ Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockFrames.CircularFram {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = false; +this.clock1.ShowClockFrame = false; - this.clock2.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.RoundedRectangle; +this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.RoundedRectangle; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -Me.clock1.ShowClockFrame = False -Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockShapes.CircularFrame +Me.clock1.ShowClockFrame = False +Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.RoundedRectangle {% endhighlight %} @@ -167,17 +179,19 @@ Me.clock1.ClockFrame = Syncfusion.Windows.Forms.Tools.ClockShapes.CircularFram {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = false; +this.clock1.ShowClockFrame = false; - this.clock2.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Circle; +this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Circle; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -Me.clock1.ShowClockFrame = false -Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Circle +Me.clock1.ShowClockFrame = False +Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Circle {% endhighlight %} @@ -192,17 +206,19 @@ Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Circle {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = false; +this.clock1.ShowClockFrame = false; - this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Square; +this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Square; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -Me.clock1.ShowClockFrame = false -Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Square +Me.clock1.ShowClockFrame = False +Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Square {% endhighlight %} @@ -217,17 +233,19 @@ Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.Square {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowClockFrame = false; +this.clock1.ShowClockFrame = false; - this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.RoundedSquare; +this.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.RoundedSquare; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools -Me.clock1.ShowClockFrame = false -Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.RoundedSquare +Me.clock1.ShowClockFrame = False +Me.clock1.ClockShape = Syncfusion.Windows.Forms.Tools.ClockShapes.RoundedSquare {% endhighlight %} @@ -244,16 +262,18 @@ The foreground color for the DigitalClock can be changed using the [ForeColor](h {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ForeColor = System.Drawing.Color.Yellow; +this.clock1.ForeColor = System.Drawing.Color.Yellow; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools - Me.clock1.ForeColor = System.Drawing.Color.Yellow +Me.clock1.ForeColor = System.Drawing.Color.Yellow {% endhighlight %} @@ -269,22 +289,22 @@ The background color for the DigitalClock can be changed using the [BackgroundCo {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; +this.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption; - - this.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption; - - this.clock1.ForeColor = System.Drawing.Color.Yellow; +this.clock1.ForeColor = System.Drawing.Color.Yellow; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools - Me.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption +Me.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption - Me.clock1.ForeColor = System.Drawing.Color.Yellow +Me.clock1.ForeColor = System.Drawing.Color.Yellow {% endhighlight %} @@ -299,26 +319,26 @@ The border color for the control will be reflected only when the control is assi {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; +this.clock1.BorderColor = System.Drawing.Color.Yellow; +this.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption; - this.clock1.BorderColor = System.Drawing.Color.Yellow; - - this.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption; - - this.clock1.ForeColor = System.Drawing.Color.Yellow; +this.clock1.ForeColor = System.Drawing.Color.Yellow; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools - Me.clock1.BorderColor = System.Drawing.Color.Yellow +Me.clock1.BorderColor = System.Drawing.Color.Yellow - Me.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption +Me.clock1.BackgroundColor = System.Drawing.SystemColors.ActiveCaption - Me.clock1.ForeColor = System.Drawing.Color.Yellow +Me.clock1.ForeColor = System.Drawing.Color.Yellow {% endhighlight %} @@ -330,21 +350,23 @@ The border color for the control will be reflected only when the control is assi ### Show or hide days of the week -To display or hide the week days and current date in the DigitalClock, the [DisplayDates](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_DisplayDates) property can be used. +To display or hide the weekdays and current date in the DigitalClock, the [DisplayDates](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_DisplayDates) property can be used. {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.DisplayDates = true; +this.clock1.DisplayDates = true; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools - Me.clock1.DisplayDates = True +Me.clock1.DisplayDates = True {% endhighlight %} @@ -364,58 +386,50 @@ To display or hide the hour designator (AM and PM) in the DigitalClock, the [Sho {% tabs %} -{% highlight C# %} +{% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowHourDesignator = false; +this.clock1.ShowHourDesignator = false; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools - Me.clock1.ShowHourDesignator = false +Me.clock1.ShowHourDesignator = False {% endhighlight %} {% endtabs %} - - ![Hide the hour designator](Overview_images/Overview_img113.png) - - ![Show the hour designator](Overview_images/Overview_img114.png) ### Custom time Clock -To enable the custom time, the DigitalClock should be enabled with the property [ShowCustomTimeClock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowCustomTimeClock) set as `true`. +To enable the custom time, set the [ShowCustomTimeClock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowCustomTimeClock) property to `true`. #### Input formats -To enable the custom time, the clock control should be enabled with the [ShowCustomTimeClock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowCustomTimeClock) property set as `true`, and the custom time should be in DateTime format. +To enable the custom time, set the [ShowCustomTimeClock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html#Syncfusion_Windows_Forms_Tools_Clock_ShowCustomTimeClock) property to `true`, and the custom time should be in DateTime format. {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - this.clock1.ShowCustomTimeClock = true; - - this.clock1.CustomTime = new System.DateTime(2013, 9, 14, 10, 10, 15, 0); - - +this.clock1.ShowCustomTimeClock = true; +this.clock1.CustomTime = new System.DateTime(2013, 9, 14, 10, 10, 15, 0); {% endhighlight %} - - - - {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools - Me.clock1.ShowCustomTimeClock = true - - Me.clock1.CustomTime = New Date(2013, 9, 14, 10, 10, 15, 0) +Me.clock1.ShowCustomTimeClock = True +Me.clock1.CustomTime = New Date(2013, 9, 14, 10, 10, 15, 0) {% endhighlight %} @@ -423,8 +437,6 @@ To enable the custom time, the clock control should be enabled with the [ShowCus ![Custom time Clock](Overview_images/Overview_img115.png) - - #### Applying custom renderer to the DigitalClock control The following code sample can be utilized for applying a custom renderer to the DigitalClock. @@ -432,29 +444,29 @@ The following code sample can be utilized for applying a custom renderer to the {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; - DigitalRenderer render = new DigitalRenderer(); - - this.clock1.DigitalRenderer = render; - - public class DigitalRenderer : DigitalClockRenderer +DigitalRenderer render = new DigitalRenderer(); - { +this.clock1.DigitalRenderer = render; - public override void DrawDigitalClockFrame(Graphics g, Image newImage, Clock clock) +public class DigitalRenderer : DigitalClockRenderer - { +{ - Image image =Image.FromFile(@"D:\CustomClock.PNG"); + public override void DrawDigitalClockFrame(Graphics g, Image newImage, Clock clock) + { - base.DrawDigitalClockFrame(g, image, clock); + Image image =Image.FromFile(@"D:\CustomClock.PNG"); - } + base.DrawDigitalClockFrame(g, image, clock); } +} {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools Dim render As DigitalRenderer = New DigitalRenderer Me.clock1.DigitalRenderer = render @@ -467,7 +479,6 @@ Public Class DigitalRenderer     End Sub End Class - {% endhighlight %} {% endtabs %} diff --git a/WindowsForms/clock/Getting-Started.md b/WindowsForms/clock/Getting-Started.md index 78e1cb80f..37a29f8d7 100644 --- a/WindowsForms/clock/Getting-Started.md +++ b/WindowsForms/clock/Getting-Started.md @@ -14,19 +14,19 @@ This section provides a quick overview for working with the [Clock](https://help Refer to the [Control dependencies](https://help.syncfusion.com/windowsforms/control-dependencies#clock) section to get the list of assemblies or details of NuGet package that needs to be added as a reference to use the control in any application. -Click [NuGet Packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to learn how to install nuget packages in a Windows Forms application. +Click [NuGet Packages](https://help.syncfusion.com/windowsforms/installation/install-nuget-packages) to learn how to install NuGet packages in a Windows Forms application. ## Creating Application with Clock -In this walk through, users will create WinForms application that contains [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control. +In this walkthrough, users will create a WinForms application that contains [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control. ### Creating the Project -Create new Windows Forms Project in Visual Studio to display [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) with data objects. +Create a new Windows Forms project in Visual Studio to display [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) with data objects. ### Adding Clock control via designer 1. Create a new Windows Forms project in Visual Studio. -2. The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control can be added to an application by dragging it from the toolbox to a designer view. The following dependent assemblies will be added automatically: +2. The [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control can be added to an application by dragging it from the toolbox to the designer view. The following dependent assemblies will be added automatically: * Syncfusion.Grid.Base * Syncfusion.Grid.Windows @@ -57,12 +57,10 @@ To add the control manually in C#, follow the given steps: {% capture codesnippet1 %} {% tabs %} {% highlight C# %} - using Syncfusion.Windows.Forms.Tools; - + {% endhighlight %} {% highlight VB %} - Imports Syncfusion.Windows.Forms.Tools {% endhighlight %} @@ -70,17 +68,19 @@ Imports Syncfusion.Windows.Forms.Tools {% endcapture %} {{ codesnippet1 | OrderList_Indent_Level_1 }} -4. Create an instance of the [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control instance, and add it to the form. +4. Create an instance of the [Clock](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Tools.Clock.html) control, and add it to the form. {% capture codesnippet2 %} {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; Clock clock1 = new Clock(); this.Controls.Add(clock1); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools Dim clock1 As New Clock() Me.Controls.Add(clock1) @@ -99,12 +99,14 @@ You can change the analog clock to digital clock by setting the [ClockType](http {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; clock1.ClockType = Syncfusion.Windows.Forms.Tools.ClockTypes.Digital; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools clock1.ClockType = Syncfusion.Windows.Forms.Tools.ClockTypes.Digital @@ -119,12 +121,14 @@ For Analog Clock, {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; clock1.ClockType = Syncfusion.Windows.Forms.Tools.ClockTypes.Analog; {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools clock1.ClockType = Syncfusion.Windows.Forms.Tools.ClockTypes.Analog @@ -140,12 +144,14 @@ To enable custom time, the Clock control should be enabled by setting the [ShowC {% tabs %} {% highlight C# %} +using Syncfusion.Windows.Forms.Tools; clock1.ShowCustomTimeClock = true; clock1.CustomTime = new System.DateTime(2019, 7, 3, 16, 50, 1, 0); {% endhighlight %} {% highlight VB %} +Imports Syncfusion.Windows.Forms.Tools clock1.ShowCustomTimeClock = True clock1.CustomTime = New System.DateTime(2019, 7, 3, 16, 50, 1, 0) diff --git a/WindowsForms/clock/Overview.md b/WindowsForms/clock/Overview.md index 7459f7867..838f62218 100644 --- a/WindowsForms/clock/Overview.md +++ b/WindowsForms/clock/Overview.md @@ -15,10 +15,10 @@ Essential Tools for Windows Forms supports [Clock](https://help.syncfusion.com/c ## Key features -* **Clock types** - Provide different types of clock. The types are Analog and Digital. +* **Clock types** - Provides different types of clocks. The types are Analog and Digital. -* **Shapes** - Provide different shapes of clock. The shapes are Rectangle, RoundedRectangle, Circle, Square, and RoundedSquare. +* **Shapes** - Provides different clock shapes. The shapes are Rectangle, RoundedRectangle, Circle, Square, and RoundedSquare. -* **Custom time** - Enables custom time. The control should be enabled by setting the `ShowCustomTimeClock` property to `true`. +* **Custom time** - Enables custom time display. The control should be enabled by setting the `ShowCustomTimeClock` property to `true`. -* **Frames** - Provide different set of frames. The frames are, RectangularFrame, CircleFrame, and SquareFrame. +* **Frames** - Provides different sets of frames. The frames are RectangularFrame, CircularFrame, and SquareFrame.