Skip to content

Commit 8324f15

Browse files
authored
Merge pull request #4902 from syncfusion-content/BLAZ-910685-doc2
910685: Need to update the documentation for the multicolumn combobox component
2 parents 5f795f7 + 2a6717a commit 8324f15

File tree

3 files changed

+21
-102
lines changed

3 files changed

+21
-102
lines changed

blazor-toc.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3408,6 +3408,24 @@
34083408
<li> <a href="/blazor/multicolumn-combobox/getting-started">Blazor Server and WASM App</a></li>
34093409
</ul>
34103410
</li>
3411+
<li>
3412+
<a href="/blazor/multicolumn-combobox/value-binding">Value Binding</a>
3413+
</li>
3414+
<li>
3415+
<a href="/blazor/multicolumn-combobox/selection">Selection</a>
3416+
</li>
3417+
<li>
3418+
<a href="/blazor/multicolumn-combobox/data-binding">Data Binding</a>
3419+
</li>
3420+
<li>
3421+
<a href="/blazor/multicolumn-combobox/placeholder-and-floatlabel">Placeholder and Floatlabel</a>
3422+
</li>
3423+
<li>
3424+
<a href="/blazor/multicolumn-combobox/filtering">Filtering</a>
3425+
</li>
3426+
<li>
3427+
<a href="/blazor/multicolumn-combobox/custom-value">Custom Value</a>
3428+
</li>
34113429
<li> <a href="/blazor/multicolumn-combobox/popup-setting">Popup Setting</a></li>
34123430
<li><a href="/blazor/multicolumn-combobox/sorting">Sorting</a></li>
34133431
<li> <a href="/blazor/multicolumn-combobox/virtualization">Virtualization</a></li>

blazor/multicolumn-combobox/data-binding.md

Lines changed: 1 addition & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -65,31 +65,6 @@ Index value binding can be accomplished with the `bind-Index` attribute, which s
6565
}
6666
```
6767

68-
<!-- ### DataBound event
69-
70-
The [DataBound]() event triggers when the data source is populated in the popup list.
71-
72-
{% highlight cshtml %}
73-
74-
{% include_relative code-snippet/data-binding/data-bound.razor %}
75-
76-
{% endhighlight %}
77-
78-
79-
### Complex data type
80-
81-
The MultiColumn ComboBox can generate its list items through an array of complex data. For this, the appropriate columns should be mapped to the [TextField](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_TextField) and [ValueField](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_ValueField) property.
82-
83-
In the following example, the `Code.ID` column and `Country.CountryID` column from complex data have been mapped to the [TextField](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_TextField) and [ValueField](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_ValueField) property respectively.
84-
85-
{% highlight cshtml %}
86-
87-
{% include_relative code-snippet/data-binding/complex-data-type.razor %}
88-
89-
{% endhighlight %}
90-
91-
![Blazor ComboBox with Complex data type](./images/data-binding/blazor_combobox_complex-data-type.png) -->
92-
9368
### Expando object binding
9469

9570
Bind the [ExpandoObject](https://learn.microsoft.com/en-us/dotnet/api/system.dynamic.expandoobject?view=net-5.0) data to the MultiColumn ComboBox component. In the following example, the `ExpandoObject` is bound to the collection of vehicles data.
@@ -102,18 +77,6 @@ Bind the [ExpandoObject](https://learn.microsoft.com/en-us/dotnet/api/system.dyn
10277

10378
![Blazor ComboBox with Expando object binding](./images/data-binding/blazor_combobox_expando-object-binding.png)
10479

105-
<!-- ### Observable collection binding
106-
107-
Bind the [ObservableCollection](https://blazor.syncfusion.com/documentation/common/data-binding/data-updates#observable-collection) data to the MultiColumn ComboBox component. In the following example, the `Observable Data` is bound to a collection of colors data.
108-
109-
{% highlight cshtml %}
110-
111-
{% include_relative code-snippet/data-binding/observable-collection-binding.razor %}
112-
113-
{% endhighlight %}
114-
115-
![Blazor ComboBox with Observable collection binding](./images/data-binding/blazor_combobox_observable-collection-binding.png) -->
116-
11780
### Dynamic object binding
11881

11982
Bind the [DynamicObject](https://learn.microsoft.com/en-us/dotnet/api/system.dynamic.dynamicobject?view=net-5.0) data to the MultiColumn ComboBox component. In the following example, the `DynamicObject` is bound to the collection of customer data.
@@ -136,8 +99,6 @@ Bind the [ValueTuple](https://learn.microsoft.com/en-us/dotnet/api/system.valuet
13699

137100
{% endhighlight %}
138101

139-
![Blazor ComboBox with ValueTuple data binding](./images/data-binding/blazor_combobox_value-tuple-data-binding.png)
140-
141102
## Binding remote data
142103

143104
The MultiColumn ComboBox loads the data from remote data services through the [DataSource](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_DataSource) property.
@@ -158,16 +119,6 @@ The [OnActionBegin](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Mult
158119

159120
{% endhighlight %}
160121

161-
<!-- ### OnActionComplete event
162-
163-
The [OnActionComplete](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_OnActionComplete) event triggers after data is fetched successfully from the remote server.
164-
165-
{% highlight cshtml %}
166-
167-
{% include_relative code-snippet/data-binding/action-complete.razor %}
168-
169-
{% endhighlight %} -->
170-
171122
### OnActionFailure event
172123

173124
The [OnActionFailure](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_OnActionFailure) event triggers when the data fetch request from the remote server fails.
@@ -202,39 +153,6 @@ The [Web API Adaptor](https://blazor.syncfusion.com/documentation/data/adaptors#
202153

203154
![Blazor ComboBox with Web API Adaptor](./images/data-binding/blazor_combobox_web-api-adaptor.png)
204155

205-
<!-- ### Custom adaptor
206-
207-
The [SfDataManager](https://help.syncfusion.com/cr/aspnetcore-blazor/Syncfusion.Blazor.Data.SfDataManager.html) has custom adaptor support which allows you to perform manual operations on the data. This can be utilized for implementing customize data binding and editing operations in the MultiColumn ComboBox component.
208-
209-
For implementing custom data binding in the MultiColumn ComboBox, the `DataAdaptor` class is used. This abstract class acts as a base class for the custom adaptor.
210-
211-
The `DataAdaptor` abstract class has both synchronous and asynchronous method signatures, which can be overridden in the custom adaptor. Following are the method signatures present in this class.
212-
213-
```csharp
214-
public abstract class DataAdaptor
215-
{
216-
/// <summary>
217-
/// Performs data Read operation synchronously.
218-
/// </summary>
219-
public virtual object Read(DataManagerRequest dataManagerRequest, string key = null)
220-
221-
/// <summary>
222-
/// Performs data Read operation asynchronously.
223-
/// </summary>
224-
public virtual Task<object> ReadAsync(DataManagerRequest dataManagerRequest, string key = null)
225-
}
226-
```
227-
228-
In custom Adaptor, the data binding operation can be performed in the MultiColumn ComboBox component by providing the custom adaptor class and overriding the Read or ReadAsync method of the DataAdaptor abstract class.
229-
230-
The following sample code demonstrates implementing custom data binding using custom adaptor.
231-
232-
{% highlight cshtml %}
233-
234-
{% include_relative code-snippet/data-binding/custom-adaptor.razor %}
235-
236-
{% endhighlight %} -->
237-
238156
### Offline mode
239157

240158
To avoid post back for every action, set the MultiColumn ComboBox to load all data on initialization and make the actions process on the client-side. To enable this behavior, use the `Offline` property of `DataManager`.
@@ -368,18 +286,6 @@ Now, configure the MultiColumn ComboBox using the [SfDataManager](https://blazor
368286

369287
{% highlight cshtml %}
370288

371-
{% include_relative code-snippet/data-binding/-comboboxwith-web-api-adaptor.razor %}
289+
{% include_relative code-snippet/data-binding/combobox-with-web-api-adaptor.razor %}
372290

373291
{% endhighlight %}
374-
375-
<!-- ## Adding new items
376-
377-
Add the new item in the popup with the help of [AddItemsAsync]() public method. This method will add a mentioned item in the MultiColumn ComboBox popup without affecting the data source items.
378-
379-
{% highlight cshtml %}
380-
381-
{% include_relative code-snippet/data-binding/add-new-item.razor %}
382-
383-
{% endhighlight %}
384-
385-
![Blazor ComboBox with adding new Item](./images/data-binding/blazor_combobox_add-new-item.gif) -->

blazor/multicolumn-combobox/filtering.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ In the following example, `EndsWith` filter type has been mapped to the `FilterT
5555

5656
![Blazor MultiColumn ComboBox with Filter Type](./images/filtering/blazor_combobox_filter-type.png)
5757

58-
## Minimum filter length
58+
<!-- ## Minimum filter length
5959
6060
When filtering list items, you can specify a character count limit to trigger a remote request and retrieve filtered data for the DropDownList. This can be achieved through manual validation using the [Filtering event arguments](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.FilteringEventArgs.html) within the [Filtering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.MultiColumnComboBox.SfMultiColumnComboBox-2.html#Syncfusion_Blazor_MultiColumnComboBox_SfMultiColumnComboBox_2_Filtering) event handler.
6161
@@ -65,9 +65,7 @@ In the following example, the remote request does not fetch the search data unti
6565
6666
{% include_relative code-snippet/filtering/minimum-filter-length.razor %}
6767
68-
{% endhighlight %}
69-
70-
![Blazor MultiColumn ComboBox with Minimum filter length](./images/filtering/blazor_combobox_minimum-filter-length.gif)
68+
{% endhighlight %} -->
7169

7270
<!-- ## Multi column filtering
7371
@@ -79,7 +77,6 @@ To enable multi-column support in the built-in Syncfusion Blazor theme files, si
7977
8078
{% endhighlight %}
8179
82-
![Blazor ComboBox with Multi Column filtering](./images/filtering/blazor_combobox_multi-column.png)
8380
8481
You can achieve multiple column(field) filtering by passing the List of [predicates](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.WhereFilter.html#Syncfusion_Blazor_Data_WhereFilter_predicates) to the [And](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.WhereFilter.html#Syncfusion_Blazor_Data_WhereFilter_And_Syncfusion_Blazor_Data_WhereFilter_) or [Or](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.WhereFilter.html#Syncfusion_Blazor_Data_WhereFilter_Or_Syncfusion_Blazor_Data_WhereFilter_) methods of [WhereFilters](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.WhereFilter.html#Syncfusion_Blazor_Data_WhereFilter__ctor).
8582
@@ -89,8 +86,6 @@ You can achieve multiple column(field) filtering by passing the List of [predica
8986
9087
{% endhighlight %}
9188
92-
![Blazor MultiColumn ComboBox with Multi Column filtering](./images/filtering/blazor_combobox_multi-colum-filtering.gif) -->
93-
9489
<!-- ## Case sensitive filtering
9590
9691
The Data items can be filtered with or without case sensitivity using the [DataManager](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.SfDataManager.html). This can be done by passing the fourth optional parameter [IgnoreCase](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.WhereFilter.html#Syncfusion_Blazor_Data_WhereFilter_IgnoreCase) of the [Where clause](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.Query.html#Syncfusion_Blazor_Data_Query_Where_Syncfusion_Blazor_Data_WhereFilter_).

0 commit comments

Comments
 (0)