Skip to content

Commit 3eab836

Browse files
committed
revamp main and refer related articles
1 parent 995d049 commit 3eab836

File tree

24 files changed

+89
-63
lines changed

24 files changed

+89
-63
lines changed

common-features/data-binding/cloud-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: How to data bind Telerik Blazor components to cloud data services s
55
slug: common-features-data-binding-cloud
66
tags: telerik,blazor,binding,databinding,cloud
77
published: True
8-
position: 15
8+
position: 30
99
---
1010

1111
# Databinding to Cloud Services

common-features/descriptors.md renamed to common-features/data-binding/descriptors.md

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,25 @@ description: Discover the FilterDescriptor, SortDescriptor, SearchFilter and Gro
55
slug: common-features-descriptors
66
tags: telerik,blazor,filterdescriptor, sortdescriptor, groupdescriptor, searchfilter
77
published: True
8-
position: 8
8+
position: 10
99
---
1010

11-
# Common
11+
12+
## Components with Descriptors
13+
14+
This article explains how to retrieve the applied filtering, searching, sorting, and grouping criteria in Blazor components. The article applies to components that support these features. The components that offer one or all of the functionalities are:
15+
* The [Filter]({%slug filter-overview%})
16+
* The [Gantt]({%slug gantt-overview%})
17+
* The [TreeList]({%slug treelist-overview%})
18+
* All components that [expose the `OnRead` event]({%slug common-features-data-binding-onread%}#components-with-onread-event).
19+
20+
## Obtain Filtering, Searching, Sorting, Grouping criteria
1221

1322
There are two ways to obtain the applied filtering, searching, sorting, grouping criteria:
1423

15-
* Through the component [`OnRead` event]({%slug common-features-data-binding-onread%}) handler. Use the [`Request` property]({%slug common-features-data-binding-onread%}#event-argument) of the [event argument object](/blazor-ui/api/Telerik.Blazor.Components.ReadEventArgs):
24+
#### Through the OnRead Event
25+
26+
Use the [`Request` property]({%slug common-features-data-binding-onread%}#event-argument) of the [`OnRead` event argument object](/blazor-ui/api/Telerik.Blazor.Components.ReadEventArgs):
1627

1728
````CS
1829
async Task OnReadHandler(...ReadEventArgs args)
@@ -32,8 +43,8 @@ async Task OnReadHandler(...ReadEventArgs args)
3243
}
3344
````
3445

35-
36-
* Through the component state. Use the component state property of the `OnStateChanged` event argument. For example:
46+
#### Through the Component State
47+
Use the component state property of the `OnStateChanged` event argument. For example:
3748

3849
````CS
3950
async Task OnStateChangedHandler(GridStateEventArgs<Product> args)
@@ -56,17 +67,19 @@ async Task OnStateChangedHandler(GridStateEventArgs<Product> args)
5667
}
5768
````
5869

70+
At the bottom of the article you will find full examples.
71+
5972

60-
# Filtering
73+
## Filtering
6174

6275
The filtering criteria for each filtered field is stored in an individual collection of [`IFilterDescriptor`](/blazor-ui/api/Telerik.DataSource.IFilterDescriptor). To access the filtering criteria, cast each `IFilterDescriptor` to [`CompositeFilterDescriptor`](/blazor-ui/api/Telerik.DataSource.CompositeFilterDescriptor).
6376

6477
The `CompositeFilterDescriptor` exposes:
65-
* [`FilterDescriptors`](/blazor-ui/api/telerik.datasource.compositefilterdescriptor#Telerik_DataSource_CompositeFilterDescriptor_FilterDescriptors) property. This property represents another collection of `IFilterDescriptor`. To get the properties of each filter descriptor instance cast the `IFilterDescriptor` to a [`FilterDescriptor`](/blazor-ui/api/telerik.datasource.filterdescriptor). Each `FilterDescriptor` instance gives access to:
78+
* [`FilterDescriptors`](/blazor-ui/api/telerik.datasource.compositefilterdescriptor#Telerik_DataSource_CompositeFilterDescriptor_FilterDescriptors) property. This property represents another collection of `IFilterDescriptor`. To access the filtering criteria cast the `IFilterDescriptor` to a [`FilterDescriptor`](/blazor-ui/api/telerik.datasource.filterdescriptor). Each `FilterDescriptor` instance gives access to:
6679
* The `Member`&mdash;The field where the user filters. Each filter descriptor describes also the `MemberType`, that represents the type of the field.
6780
* The `Operator`&mdash;The [`FilterOperator`](/blazor-ui/api/telerik.datasource.filteroperator) that applies. There are different operators depending on the `MemberType`. Read more about the [filter operators]({%slug common-features-filter-operators%}).
6881
* The `Value`&mdash;The user input to filter by.
69-
* [`LogicalOperator`](/blazor-ui/api/telerik.datasource.compositefilterdescriptor#Telerik_DataSource_CompositeFilterDescriptor_LogicalOperator) property. This property can be either AND or OR. The logical operator applies between the filter descriptor instances.
82+
* [`LogicalOperator`](/blazor-ui/api/telerik.datasource.compositefilterdescriptor#Telerik_DataSource_CompositeFilterDescriptor_LogicalOperator) property. This property can be either AND or OR. This property represents the logical operator applied between the instances in the `FilterDescriptors` collection.
7083

7184
When the filtering is initiated, the `CompositeFilterDescriptor` properties get different values, depending on the filter mode:
7285

@@ -78,24 +91,26 @@ When the filtering is initiated, the `CompositeFilterDescriptor` properties get
7891
| FilterRow | Two filter descriptor instances per each filtered field. The second filter descriptor instance always gets null as `Value`, because there is no second input field. | AND |
7992

8093

81-
# Searching
94+
## Searching
8295

83-
The searching criteria is stored in an individual `IFilterDescriptor`. To access the filtering criteria, cast the `IFilterDescriptor` to `CompositeFilterDescriptor`. The `FilterDescriptors` property of the `CompositeFilterDescriptor` gets filter descriptor instances for all string fields. Each filter descriptor instance gets the user input as `Value`. The value of the `LogicalOperator` property of the `CompositeFilterDescriptor` is OR.
96+
The searching criteria are stored in an individual `IFilterDescriptor`. To access the filtering criteria, cast the `IFilterDescriptor` to `CompositeFilterDescriptor`. The `FilterDescriptors` property of the `CompositeFilterDescriptor` gets filter descriptor instances for all string fields. Each filter descriptor instance gets the user input as `Value`. The value of the `LogicalOperator` property of the `CompositeFilterDescriptor` is OR.
8497

8598

86-
# Sorting
99+
## Sorting
87100

88-
The current sorting criteria is stored in a collection of [`SortDescriptor`](/blazor-ui/api/telerik.datasource.sortdescriptor). Each `SortDescriptor` instance gives access to:
89-
* The `Member`&mdash;The field where the user sorts.
90-
* The `SortDirection`&mdash;The sort direction for this sort descriptor.
101+
The sorting criteria are stored in a collection of [`SortDescriptor`](/blazor-ui/api/telerik.datasource.sortdescriptor). Each `SortDescriptor` instance gives access to:
102+
* The `Member`&mdash;The field where the user sorts.
103+
* The `SortDirection`&mdash;The sort direction for this sort descriptor.
91104

92105

93-
# Grouping
106+
## Grouping
94107

95108
Тhe grouping criteria for each group is stored in an individual collection of [`GroupDescriptor`](/blazor-ui/api/telerik.datasource.groupdescriptor). The `GroupDescriptor` class inherits the `SortDescriptor` class and gives access to the same properties as the `SortDescriptor` class.
96109

97110

98-
# Example with `OnRead` Event
111+
## Examples
112+
113+
#### Obtain the FilterDescriptor, SearchFilter, SortDescriptor, GroupDescriptor in the OnRead Event Handler
99114

100115
````CSHTML
101116
@using Telerik.DataSource
@@ -185,7 +200,8 @@ The current sorting criteria is stored in a collection of [`SortDescriptor`](/bl
185200
}
186201
````
187202

188-
# Example Through the Component State
203+
#### Obtain the FilterDescriptor, SearchFilter, SortDescriptor, GroupDescriptor Through the Component State
204+
189205
````CSHTML
190206
@using System.Text.Json
191207
@using Telerik.DataSource

common-features/filter-operators.md renamed to common-features/data-binding/filter-operators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Supported Filter Operators in the Telerik UI for Blazor component s
55
slug: common-features-filter-operators
66
tags: telerik,blazor,filter,operator
77
published: True
8-
position: 10
8+
position: 15
99
---
1010

1111
# Filter Operators

common-features/data-binding/observable-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ slug: common-features-observable-data
66
tags: telerik,blazor,observable,data,live,INotifyCollectionChanged
77
published: True
88
previous_url: /common-features/observable-data
9-
position: 10
9+
position: 25
1010
---
1111

1212
# Observable Data and Refresh Data

common-features/telerik-datasource-package.md renamed to common-features/data-binding/telerik-datasource-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Details about the Telerik.DataSource NuGet package that come with T
55
slug: common-features-datasource-package
66
tags: telerik,blazor,data,source,package
77
published: True
8-
position: 50
8+
position: 20
99
---
1010

1111
# Telerik DataSource Package

components/autocomplete/events.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ You can use the he [`OnRead` event]({%slug common-features-data-binding-onread%}
124124

125125
You can also call remote data through async operations.
126126

127+
Find out how to [get the applied by the user filtering and grouping criteria]({%slug common-features-descriptors%}).
128+
127129
When using `OnRead`, make sure to set `TItem` and `TValue`.
128130

129131
>caption Custom Data according to the user input in the AutoComplete

components/autocomplete/filter.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ position: 10
1212

1313
The AutoComplete component can filter the available suggestions, according to the current input. In this way users can find the desired value faster. To see the difference in behavior, visit the [Live Demo: AutoComplete Filtering](https://demos.telerik.com/blazor-ui/autocomplete/filtering) page.
1414

15-
To enable filtering, set the `Filterable` parameter to `true`. The filtering is case insensitive. You can also implement custom (server) filtering and set a data source dynamically through the [`OnRead` event]({%slug autocomplete-events%}#onread).
15+
To enable filtering, set the `Filterable` parameter to `true`. The filtering is case insensitive.
16+
17+
You can also use the [`OnRead` event]({%slug autocomplete-events%}#onread) to:
18+
* Get the [applied filtering criteria]({%slug common-features-descriptors%}#through-the-onread-event).
19+
* Implement custom (server) filtering and set a data source dynamically.
1620

1721
## Filter Operator
1822

components/combobox/events.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,8 @@ You can use the [`OnRead` event]({%slug common-features-data-binding-onread%}) t
183183

184184
You can also call remote data through `async` operations.
185185

186+
Find out how to [get the applied by the user filtering and grouping criteria]({%slug common-features-descriptors%}).
187+
186188
When using `OnRead`, make sure to set `TItem` and `TValue`.
187189

188190
>caption Custom Data according to the user input in the ComboBox

components/combobox/filter.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ position: 10
1212

1313
The ComboBox component allows the user to filter the available items by their text, so they can find the one they need faster.
1414

15-
To enable filtering, set the `Filterable` parameter to `true`. The filtering is case insensitive. You can also implement custom (server) filtering and set a data source dynamically through the [`OnRead` event]({%slug components/combobox/events%}#onread).
15+
To enable filtering, set the `Filterable` parameter to `true`. The filtering is case insensitive.
16+
17+
You can also use the [`OnRead` event]({%slug components/combobox/events%}#onread) to:
18+
* Get the [applied filtering criteria]({%slug common-features-descriptors%}#through-the-onread-event).
19+
* Implement custom (server) filtering and set a data source dynamically.
1620

1721
Filtering looks in the `TextField`, and the filter is reset when the dropdown closes.
1822

components/dropdownlist/events.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ You can use the [`OnRead` event]({%slug common-features-data-binding-onread%}) t
103103

104104
* the component initializes
105105
* the user [filters]({%slug components/dropdownlist/filter%})
106-
* the user scrolls with [virtualization]({%slug dropdownlist-virtualization%}) enabled
106+
* the user scrolls with [virtualization]({%slug dropdownlist-virtualization%}) enabled.
107+
108+
Find out how to [get the applied by the user filtering and grouping criteria]({%slug common-features-descriptors%}).
107109

108110
You can also call remote data through `async` operations.
109111

0 commit comments

Comments
 (0)