Skip to content

Documentation(1042850): Need to add Prompt library for the Asp core and mvc Platform. #1585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
VijayakumarRSF4470 wants to merge 3 commits into from
Closed

Documentation(1042850): Need to add Prompt library for the Asp core and mvc Platform. #1585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45a9100
1042850: Need to add Prompt library for the Windows forms Platform.
VijayakumarSF4470 Jul 21, 2026
9083259
Merge branch 'development' into ES-1041550-PromptLibraryWinForm
VijayakumarRSF4470 Aug 5, 2026
c77a9e3
1041550: Updated correction in prompt library.
VijayakumarSF4470 Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@ String platform='Windows Forms';
checkout scm


def page = 1
while(true)
{
def branchCommit = 'https://api.github.com/repos/syncfusion-content/'+env.githubSourceRepoHttpUrl.split('/')[env.githubSourceRepoHttpUrl.split('/').size() - 1]+'/pulls/' + env.pullRequestId + '/files?per_page=100^&page='+ page
def branchCommit = 'https://api.github.com/repos/syncfusion-content/'+env.githubSourceRepoHttpUrl.split('/')[env.githubSourceRepoHttpUrl.split('/').size() - 1]+'/pulls/' + env.pullRequestId + '/files'
String branchCommitDetails = bat returnStdout: true, script: 'curl -H "Accept: application/vnd.github.v3+json" -u SyncfusionBuild:' + env.GithubBuildAutomation_PrivateToken + " " + branchCommit

def ChangeFiles= branchCommitDetails.split('"filename": ');
Expand All @@ -30,15 +27,7 @@ String platform='Windows Forms';
{
def ChangeFile= ChangeFiles[i].split(',')[0].replace('"', '')
Content += env.WORKSPACE + "\\Spell-Checker\\" + ChangeFile + "\r\n";
}

// Last page
if((ChangeFiles.size() - 1) < 100)
{
break
}
page++
}
}

if (Content) {
writeFile file: env.WORKSPACE+"/cireports/content.txt", text: Content
Expand Down
3 changes: 2 additions & 1 deletion WindowsForms-toc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
<li><a href="/windowsforms/skills/ui-builder-skill">UI Builder Skill</a></li>
</ul>
</li>
<li><a href="/windowsforms/mcp">MCP</a></li>
<li><a href="/windowsforms/mcp">MCP</a></li>
<li><a href="/windowsforms/prompt-library">Prompt Library</a></li>
</ul>
</li>
<li>Installation<ul>
Expand Down
12 changes: 6 additions & 6 deletions WindowsForms/Add-Syncfusion-Controls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,13 +150,13 @@ The following steps direct you to create the Syncfusion<sup>®</sup> Windows For

![Add-Syncfusion-Control_images5](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-5.png)

4. Once the Project Configuration Wizard is done, the Syncfusion<sup>®</sup> Windows Forms project is created with the required references and forms.
4. Once the Project Configuration Wizard is done, the Syncfusion<sup>®</sup> Windows Forms project is created with required references and forms.

![Add-Syncfusion-Control_images6](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-6.png)

![Add-Syncfusion-Control_images7](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-7.png)

5. Then, Syncfusion<sup>®</sup> licensing registration required message box will be shown as follow, if you have installed the trial setup or NuGet packages since Syncfusion<sup>®</sup> introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio<sup>®</sup> release. Please navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) which is shown in the licensing message box to generate and register the Syncfusion<sup>®</sup> license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio<sup>®</sup>.
5. Then, Syncfusion<sup>®</sup> licensing registration required message box will be shown as follow, if you are installed the trial setup or NuGet packages since Syncfusion<sup>®</sup> introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio<sup>®</sup> release. Please navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) which is shown in the licensing message box to generate and register the Syncfusion<sup>®</sup> license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio<sup>®</sup>.

![Add-Syncfusion-Control_images8](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-8.png)

Expand Down Expand Up @@ -191,7 +191,7 @@ This is a combo box where you can choose the application’s platform. For now i

#### Version

Syncfusion's Installed Build Versions are listed for Syncfusion<sup>®</sup> Essential Studio<sup>®</sup> v13.1.0.21 and later, for the installed Windows Forms platform.
Syncfusion’s Installed Build Versions are listed for Syncfusion<sup>®</sup> Essential Studio<sup>®</sup> v13.1.0.21 and later, for the installed Windows Forms platform.

#### Template Gallery

Expand All @@ -201,13 +201,13 @@ When Add button is clicked, then the selected item template is added to the proj

![Add-Syncfusion-Control_images5](Add-Syncfusion-Control_images\Syncfusion-Item-Template-Gallery-5.png)

5. Then, Syncfusion<sup>®</sup> licensing registration required message box will be shown as follow, if you have installed the trial setup or NuGet packages since Syncfusion<sup>®</sup> introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio<sup>®</sup> release. Please navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) which is shown in the licensing message box to generate and register the Syncfusion<sup>®</sup> license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio<sup>®</sup>.
5.Then, Syncfusion<sup>®</sup> licensing registration required message box will be shown as follow, if you are installed the trial setup or NuGet packages since Syncfusion<sup>®</sup> introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio<sup>®</sup> release. Please navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) which is shown in the licensing message box to generate and register the Syncfusion<sup>®</sup> license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio<sup>®</sup>.

![Add-Syncfusion-Control_images8](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-8.png)

### Using Visual Studio Add new Item

Syncfusion<sup>®</sup> Project Template can also be added from the Visual Studio Item Template. Right-click on the Windows Forms Project Add ->New Item. You can refer to the following screenshot for more information.
Syncfusion<sup>®</sup> Project Template can be also add from the Visual Studio Item Template. Right-click on the Windows Forms Project Add ->New Item. You can refer to the following screenshot for more information.

![Add-Syncfusion-Control_images1](Add-Syncfusion-Control_images\Syncfusion-Add-New-Item-1.png)

Expand All @@ -221,6 +221,6 @@ Syncfusion<sup>®</sup> Project Template can also be added from the Visual Studi

![Add-Syncfusion-Control_images4](Add-Syncfusion-Control_images\Syncfusion-Add-New-Item-4.png)

3. Then, Syncfusion<sup>®</sup> licensing registration required message box will be shown as follow, if you have installed the trial setup or NuGet packages since Syncfusion<sup>®</sup> introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio<sup>®</sup> release. Please navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) which is shown in the licensing message box to generate and register the Syncfusion<sup>®</sup> license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio<sup>®</sup>.
3. Then, Syncfusion<sup>®</sup> licensing registration required message box will be shown as follow, if you are installed the trial setup or NuGet packages since Syncfusion<sup>®</sup> introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio<sup>®</sup> release. Please navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) which is shown in the licensing message box to generate and register the Syncfusion<sup>®</sup> license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio<sup>®</sup>.

![Add-Syncfusion-Control_images8](Add-Syncfusion-Control_images\Syncfusion-Project-Template-Gallery-8.png)
27 changes: 23 additions & 4 deletions WindowsForms/Applying-patches/Applying-patches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,44 +11,63 @@ documentation: ug

Syncfusion provides patch installer for major version or service pack version, either to add new features or to fix issues. You have to install the patches in the order you have received.


## Installing the Patch installer

The steps below show how to install a patch.

I> Before installing the patch, ensure that the corresponding Essential Studio version is installed on your machine.

I> Before installing the patch, ensure that corresponding Essential Studio version platform has been installed in your machine.



1. Double-click the Syncfusion Essential Studio patch installer. The Syncfusion Essential Studio Service Pack opens.

![Welcome Wizard](Patches_images/Installing-a-Patch-Setup_img2.png)




2. Click Next. The Assembly Manager screen opens.

![Assembly Manager](Patches_images/Installing-a-Patch-Setup_img3.png)




3. Select the Run Assembly Manager check box to install the assemblies in GAC.

4. Click Next. The Ready To Install screen opens.

![Ready To Install](Patches_images/Installing-a-Patch-Setup_img4.png)




5. Click Install to continue installing.

![Installation Progress](Patches_images/Installing-a-Patch-Setup_img5.png)

N> The patch is installed on your computer, and a dialog box appears when the installation is complete.



![Finish Wizard](Patches_images/Installing-a-Patch-Setup_img7.png)


6. Click Finish. The new assemblies are placed in the Pre-Compiled Assemblies folder. These new assemblies can be referenced in your project.


## Patch Assembly Version Format

In the patch assembly, the **File Version** and **Product Version** will be different. Product Version will be the release version and File Version will be the increment of the release version's **revision** number. For each patch, the File Version will be a different one. You can differentiate between the build and patch assemblies by File Version.

**File Version of the assembly shipped in build:**

![File Version of a patched assembly](Patches_images/Installing-a-Patch-Setup_img8.png)
![Patch Assembly](Patches_images/Installing-a-Patch-Setup_img8.png)

**Product Version of the assembly shipped in patch:**

![Product Version of a patched assembly](Patches_images/Installing-a-Patch-Setup_img9.png)
![Patch Assembly](Patches_images/Installing-a-Patch-Setup_img9.png)


Binary file modified WindowsForms/Applying-patches/Patches_images/Installing-a-Patch-Setup_img9.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 12 additions & 19 deletions WindowsForms/ComboBox/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,26 @@ documentation: ug
---

# Getting Started with Windows Forms ComboBox (SfComboBox)
This section provides a quick overview for working with the ComboBox in WinForms.
This section provides a quick overview for working with combo box in WinForms.

## 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.

To install via NuGet Package Manager Console, run:
```
Install-Package Syncfusion.SfListView.WinForms
```
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.

## Creating Application with SfComboBox control
In this walkthrough, you will create a WinForms application that contains the SfComboBox control.
In this walk through, user will create a WinForms application that contains 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 the 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 designer. The required assembly references will be added automatically.

![GettingStarted_img1](GettingStarted_images/GettingStarted_img1.png)

### Adding Control in Code
To add the control manually, follow these steps:
To add control manually, follow the steps:

1. Add the required assembly references below to the project.
1. Add the below required assembly references to the project,

* Syncfusion.Core.WinForms

Expand All @@ -43,7 +38,7 @@ To add the control manually, follow these steps:
* Syncfusion.SfListView.WinForms


2. Create the SfComboBox control instance and add it to the control collection of the form.
2. Create the SfComboBox control instance and add it to the control collection of Form.

{% capture codesnippet1 %}
{% tabs %}
Expand Down Expand Up @@ -85,7 +80,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 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.
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.

{% tabs %}
{% highlight c# %}
Expand Down Expand Up @@ -116,12 +111,10 @@ 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 the drop-down list.
Auto complete provides three different ways to display suggestions in drop-down list.

They are,

Expand All @@ -131,7 +124,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. 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`).
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.

{% tabs %}
{% highlight c# %}
Expand Down Expand Up @@ -160,6 +153,6 @@ sfComboBox1.ComboBoxMode = ComboBoxMode.MultiSelection

## Selected Items

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

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.
Loading