Class GridFilterRowCellRenderer<D, E>
The GridFilterRowCellRenderer is a abstract class to load UIEelents in FilterRowCell.
Inheritance
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid.RowFilter
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public abstract class GridFilterRowCellRenderer<D, E> : GridVirtualizingCellRenderer<D, E>, IGridCellRenderer, IDisposable, IGridFilterRowRenderer where D : FrameworkElement, new()
where E : FrameworkElement, new()
Type Parameters
Name |
---|
D |
E |
Constructors
GridFilterRowCellRenderer()
Declaration
protected GridFilterRowCellRenderer()
Properties
FilterRowCell
Gets or sets the corresponding GridFilterRowCell.
Declaration
protected IGridFilterRowCell FilterRowCell { get; }
Property Value
Type |
---|
IGridFilterRowCell |
Methods
ApplyFilters(List<FilterPredicate>, String)
Apply the filter to the corresponding column with given FilterPredicates.
Declaration
protected void ApplyFilters(List<FilterPredicate> filterPredicates, string filterText)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<FilterPredicate> | filterPredicates | The list of FilterPredicate that want to be apply in a particular column. |
System.String | filterText | The text that want to displayed in FilterRowCell of a particular column. |
BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
Starts an edit operation on a current cell.
Declaration
public override bool BeginEdit(RowColumnIndex cellRowColumnIndex, FrameworkElement cellElement, GridColumn column, object record)
Parameters
Type | Name | Description |
---|---|---|
RowColumnIndex | cellRowColumnIndex | Specifies the row and column index of the cell to start an edit operation. |
Microsoft.UI.Xaml.FrameworkElement | cellElement | Specifies the UIElement of the cell to start an edit operation. |
GridColumn | column | The corresponding column to edit the cell. |
System.Object | record | The corresponding record to edit the cell. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if the current cell starts an editing; otherwise, false. |
Overrides
GetFilterPredicates(Object)
Gets the list of FilterPredicates for the corresponding column.
Declaration
protected List<FilterPredicate> GetFilterPredicates(object filterValue)
Parameters
Type | Name | Description |
---|---|---|
System.Object | filterValue | Value that want to be filter in corresponding column. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<FilterPredicate> | Returns the list of FilterPredicates that have been generated for the particular column. |
GetFilterText(List<FilterPredicate>)
Gets the FilterText that want to be displayed in particular FilterRow Cell.
Declaration
public virtual string GetFilterText(List<FilterPredicate> filterPredicates)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<FilterPredicate> | filterPredicates | The list of FilterPredicates that have been created to the particular column. |
Returns
Type |
---|
System.String |
GetMultiSelectFilterPredicates(List<FilterRowElement>, List<FilterRowElement>)
Gets the list of FilterPredicates for the corresponding column.
Declaration
protected List<FilterPredicate> GetMultiSelectFilterPredicates(List<FilterRowElement> filterValues, List<FilterRowElement> totalItems)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<FilterRowElement> | filterValues | The list of values that want to be filter in the particular column. |
System.Collections.Generic.List<FilterRowElement> | totalItems | The list of items which is loaded in ComboBox control. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<FilterPredicate> | Returns the list of FilterPredicates that have been generated for the particular column. |
InitializeCellStyle(DataColumnBase, Object)
Method which is used to Initialize the custom style for FilterRow cell by using FilterRowCellStyle property.
Declaration
protected override void InitializeCellStyle(DataColumnBase dataColumn, object record)
Parameters
Type | Name | Description |
---|---|---|
DataColumnBase | dataColumn | DataColumn Which holds GridColumn, RowColumnIndex and GridCell |
System.Object | record |
Overrides
OnClearFilter(DataColumnBase)
Invoked when filter cleared programmatically to update the cell
Declaration
protected virtual void OnClearFilter(DataColumnBase dataColumn)
Parameters
Type | Name | Description |
---|---|---|
DataColumnBase | dataColumn | DataColumn of FilterRowCell. |
OnFilterRowConditionChanged(String)
Process the filtering when the FilterRowCondition is changed in corresponding column.
Declaration
public virtual void OnFilterRowConditionChanged(string filterRowCondition)
Parameters
Type | Name | Description |
---|---|---|
System.String | filterRowCondition | The new FilterRowCondition that have been changed. |
OnInitializeDisplayElement(DataColumnBase, D, Object)
Called when [initialize display element].
Declaration
public override void OnInitializeDisplayElement(DataColumnBase dataColumn, D uiElement, object dataContext)
Parameters
Type | Name | Description |
---|---|---|
DataColumnBase | dataColumn | DataColumn Which holds GridColumn, RowColumnIndex and GridCell |
D | uiElement | Corresponding Renderer Element |
System.Object | dataContext | The data context. |
Overrides
OnInitializeEditElement(DataColumnBase, E, Object)
Called when [initialize edit element].
Declaration
public override void OnInitializeEditElement(DataColumnBase dataColumn, E uiElement, object dataContext)
Parameters
Type | Name | Description |
---|---|---|
DataColumnBase | dataColumn | DataColumn which holds GridColumn, RowColumnIndex and GridCell |
E | uiElement | Corresponding Renderer Element |
System.Object | dataContext | The data context. |
Overrides
OnPrepareUIElements()
Creates the FilterRowCell.
Declaration
protected override FrameworkElement OnPrepareUIElements()
Returns
Type |
---|
Microsoft.UI.Xaml.FrameworkElement |
Overrides
ProcessMultipleFilters(List<Object>, List<Object>)
Process filtering operation with the given filter values in the particular column.
Declaration
public virtual void ProcessMultipleFilters(List<object> filterValues, List<object> totalItems)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<System.Object> | filterValues | The list of Values that want to be filter in particular column. |
System.Collections.Generic.List<System.Object> | totalItems | The list of items which is loaded in ComboBox. |
ProcessSingleFilter(Object)
Process filtering operation with the given filter value for the particular column.
Declaration
public virtual void ProcessSingleFilter(object filterValue)
Parameters
Type | Name | Description |
---|---|---|
System.Object | filterValue | Value that want to be filter in particular column. |
Explicit Interface Implementations
IGridFilterRowRenderer.ClearFilter(DataColumnBase)
Declaration
void IGridFilterRowRenderer.ClearFilter(DataColumnBase dataColumn)
Parameters
Type | Name | Description |
---|---|---|
DataColumnBase | dataColumn |