Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
7c9548b
docs(common):Create common article for descriptors
NansiYancheva Oct 8, 2024
0049a35
Update components/gantt/gantt-tree/filter/overview.md
NansiYancheva Oct 14, 2024
995d049
revamp by adding all descriptors
NansiYancheva Oct 15, 2024
3eab836
revamp main and refer related articles
NansiYancheva Oct 18, 2024
7a4d238
update common article
NansiYancheva Oct 21, 2024
5308b44
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 21, 2024
1aa3130
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 21, 2024
de0bd4d
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 21, 2024
990e0ed
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 21, 2024
00ffc44
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 21, 2024
718ae0d
Update components/filter/overview.md
NansiYancheva Oct 21, 2024
c6b287e
update after review
NansiYancheva Oct 21, 2024
754fe04
update after support review
NansiYancheva Oct 22, 2024
efa5736
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
ae7ed26
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
1065253
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
dfcd925
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
94fa2e2
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
ca6a715
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
0352538
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
58ba27c
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
5844650
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
6db2252
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
7caa380
Update common-features/data-binding/descriptors.md
NansiYancheva Oct 22, 2024
0e3247b
update after tech writer review
NansiYancheva Oct 22, 2024
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
18 changes: 18 additions & 0 deletions common-features/composite-filter-descriptor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Composite Filter Descriptor
page_title: Composite Filter Descriptor
description: Discover the CompositeFilterDescriptor properties and how to access the filter descriptor value.
slug: common-features-composite-filter-descriptor
tags: telerik,blazor,compositefilterdescriptor
published: True
position: 8
---

# Composite Filter Descriptor

The [`CompositeFilterDescriptor`](/blazor-ui/api/Telerik.DataSource.CompositeFilterDescriptor) exposes two properties:
* [`FilterDescriptors`](/blazor-ui/api/telerik.datasource.compositefilterdescriptor#Telerik_DataSource_CompositeFilterDescriptor_FilterDescriptors)—The property represents a [`FilterDescriptorCollection`](/blazor-ui/api/Telerik.DataSource.FilterDescriptorCollection). The `FilterDescriptorCollection` contains [`IFilterDescriptor`](/blazor-ui/api/Telerik.DataSource.IFilterDescriptor) instances. 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:
* The `Member`—The field where the user filters. Each filter descriptor describes also the `MemberType`, that represents the type of the field.
* The `Operator`—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%}).
* The `Value`—The user input to filter by.
* [`LogicalOperator`](/blazor-ui/api/telerik.datasource.compositefilterdescriptor#Telerik_DataSource_CompositeFilterDescriptor_LogicalOperator)—It can be either AND or OR. The logical operator applies between the filter descriptor instances.
2 changes: 1 addition & 1 deletion components/filter/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The Blazor Filter provides parameters that allow you to configure the component:
| Parameter | Type | Description |
| ----------- | ----------- | ----------- |
| `Class` | `string` | The class that will be rendered on the outermost element. |
| `Value` | `CompositeFilterDescriptor` | Sets the value of the filter component. |
| `Value` | [`CompositeFilterDescriptor`]({%slug common-features-composite-filter-descriptor%}) | Sets the value of the filter component. |

## Filter Reference and Methods

Expand Down
11 changes: 7 additions & 4 deletions components/gantt/gantt-tree/filter/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ You can filter more than one column at a time, and all filter rules will be appl

## Filter Descriptors

The Gantt filter state is stored in [CompositeFilterDescriptors](/blazor-ui/api/Telerik.DataSource.CompositeFilterDescriptor). The below information is important if you want to [get or change the Gantt filters programmatically]({%slug gantt-state%}).
The filtering criteria for each filtered field is stored in an individual [`CompositeFilterDescriptor`]({%slug common-features-composite-filter-descriptor%}). The below information is important if you want to [get or change the Gantt filters programmatically]({%slug gantt-state%}).

Each `CompositeFilterDescriptor` contains a [**collection** of `FilterDescriptor`s](/blazor-ui/api/Telerik.DataSource.FilterDescriptorCollection). All descriptors in the collection are applied with an *AND* or an *OR* `LogicalOperator`.
When the filtering is initiated, the `CompositeFilterDescriptor` properties get different values, depending on the filter mode:

* [Filter Row]({%slug gantt-filter-row%}) - each `CompositeFilterDescriptor` targets a specific field. By default, one filter can be applied to a field using the Filter Row operator. The filter value is stored in the first `FilterDescriptor` instance of the `CompositeFilterDescriptor` for that field.
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

* [Filter Menu]({%slug gantt-filter-menu%}) - each `CompositeFilterDescriptor` targets a specific field. Filter values from the separate filter operators in the menu are stored in different `FilterDescriptor` instances of the dedicated `CompositeFilterDescriptor` for that field.
| Filter Mode | FilterDescriptors Property Value | LogicalOperator Property Value |
| --- | --- | --- |
| FilterMenu | Two filter descriptor instances per each filtered field. Each filter descriptor instance gets the user input as `Value`. If there is no user input in one of the input fields in the menu then this filter descriptor instance `Value` is null. | Depending on the user choice. |
| 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 |


## Customize The Filter Editors
Expand Down
15 changes: 8 additions & 7 deletions components/grid/filter/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,17 @@ The filter menu can display a [list of checkboxes]({%slug grid-checklist-filter%

## Filter Descriptors

The Grid filter state is stored in [`CompositeFilterDescriptors`](/blazor-ui/api/Telerik.DataSource.CompositeFilterDescriptor). Use the following information if you want to [get or change the Grid filters programmatically]({%slug grid-state%}).
The filtering criteria for each filtered field is stored in an individual [`CompositeFilterDescriptor`]({%slug common-features-composite-filter-descriptor%}). Use the following information if you want to [get or change the Grid filters programmatically]({%slug grid-state%}).

Each `CompositeFilterDescriptor` includes a collection of filter descriptors, where all descriptors in the collection are applied with an AND or OR logical operator.
When the filtering is initiated, the `CompositeFilterDescriptor` properties get different values, depending on the filter mode:

* [Filter Row]({%slug grid-filter-row%})—Each `CompositeFilterDescriptor` targets a specific field. By default, one filter can be applied to a field using the Filter Row operator, with the filter value stored in the first filter descriptor instance for that field.

* [Filter Menu]({%slug grid-filter-menu%})—Each `CompositeFilterDescriptor` targets a specific field. The filter values from separate filter operators in the menu are stored in different filter descriptor instances within the `CompositeFilterDescriptor` for that field.

* [SearchBox]({%slug grid-searchbox%})—A `CompositeFilterDescriptor` is created in the state when the user types in the search box. By default, it targets all string fields, adding a dedicated filter descriptor instance for each string field. Each filter descriptor contains the filter value typed in the search box.
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

| Filter Mode | FilterDescriptors Property Value | LogicalOperator Property Value |
| --- | --- | --- |
| FilterMenu | Two filter descriptor instances per each filtered field. Each filter descriptor instance gets the user input as `Value`. If there is no user input in one of the input fields in the menu then this filter descriptor instance `Value` is null. | Depending on the user choice. |
| 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 |
| SearchBox | Filter descriptor instances for all string fields. Each filter descriptor instance gets the user input as `Value`. | OR |

## Custom Filtering

Expand Down
2 changes: 1 addition & 1 deletion components/grid/state.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The Grid state is a generic [class `GridState<TItem>`](/blazor-ui/api/Telerik.Bl
| `InsertedItem` | `TItem`* | The data item that is being added in `Inline` or `Popup` edit mode. [Not applicable for `Incell` editing]({%slug components/grid/editing/incell%}#event-sequence). |
| `OriginalEditItem` | `TItem`* | The original copy of the data item that is currently in edit mode. This `GridState` property holds the unmodified data item values. |
| `Page` | `int?` | The current [page index]({%slug components/grid/features/paging%}). Some user actions reset the page index to 1, such as filtering or changing the page size. |
| `SearchFilter` | `IFilterDescriptor` | The `CompositeFilterDescriptor` that holds the filter descriptors for the [`GridSearchBox`]({%slug grid-searchbox%}). |
| `SearchFilter` | `IFilterDescriptor` | The [`CompositeFilterDescriptor`]({%slug common-features-composite-filter-descriptor%}) that holds the filter descriptors for the [`GridSearchBox`]({%slug grid-searchbox%}). |
| `SelectedItems` | `ICollection<TItem>` | The currently [selected data item(s)]({%slug grid-selection-overview%}). |
| `Skip` | `int?` | The number of scrolled data items when using [virtual row scrolling]({%slug components/grid/virtual-scrolling%}). In other words, this is the number of rows above the currently visible ones. |
| `SortDescriptors` | `ICollection<SortDescriptor>` | The currently applied [sorts]({%slug components/grid/features/sorting%}). |
Expand Down
14 changes: 8 additions & 6 deletions components/treelist/filter/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,17 @@ In addition to the two main filtering modes, the treelist offers two more featur

## Filter Descriptors

The TreeList filter state is stored in [CompositeFilterDescriptors](/blazor-ui/api/Telerik.DataSource.CompositeFilterDescriptor). The below information is important if you want to [get or change the TreeList filters programmatically]({%slug treelist-state%}).
The filtering criteria for each filtered field is stored in an individual [`CompositeFilterDescriptor`]({%slug common-features-composite-filter-descriptor%}). The below information is important if you want to [get or change the TreeList filters programmatically]({%slug treelist-state%}).

Each `CompositeFilterDescriptor` contains a [**collection** of `FilterDescriptor`s](/blazor-ui/api/Telerik.DataSource.FilterDescriptorCollection). All descriptors in the collection are applied with an *AND* or an *OR* `LogicalOperator`.
When the filtering is initiated, the `CompositeFilterDescriptor` properties get different values, depending on the filter mode:

* [Filter Row]({%slug treelist-filter-row%}) - each `CompositeFilterDescriptor` targets a specific field. By default, one filter can be applied to a field using the Filter Row operator. The filter value is stored in the first `FilterDescriptor` instance of the `CompositeFilterDescriptor` for that field.

* [Filter Menu]({%slug treelist-filter-menu%}) - each `CompositeFilterDescriptor` targets a specific field. Filter values from the separate filter operators in the menu are stored in different `FilterDescriptor` instances of the dedicated `CompositeFilterDescriptor` for that field.
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

* [SearchBox]({%slug treelist-searchbox%}) - one `CompositeFilterDescriptor` is created in the state when the user types in the Searchbox. By default, it targets all `string` fields. A dedicated `FilterDescriptor` instance is added to this `CompositeFilterDescriptor` for each `string` field. Each `FilterDescriptor` instance contains the filter value typed in the Searchbox.
| Filter Mode | FilterDescriptors Property Value | LogicalOperator Property Value |
| --- | --- | --- |
| FilterMenu | Two filter descriptor instances per each filtered field. Each filter descriptor instance gets the user input as `Value`. If there is no user input in one of the input fields in the menu then this filter descriptor instance `Value` is null. | Depending on the user choice. |
| 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 |
| SearchBox | Filter descriptor instances for all string fields. Each filter descriptor instance gets the user input as `Value`. | OR |

## Customize The Filter Editors

Expand Down