Class FilterOptionsBuilder<T>

Inheritance

System.Object

FilterOptionsBuilder<T>

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class FilterOptionsBuilder<T>
    where T : class

Type Parameters

Name	Description
T

Constructors

FilterOptionsBuilder(FilterSettings)

Initializes a new instance of the class.

Declaration

public FilterOptionsBuilder(FilterSettings filter)

Parameters

Type	Name	Description
FilterSettings	filter	It displays the filtered records

Methods

BlankValue(Object)

Declaration

public FilterOptionsBuilder<T> BlankValue(object bValue)

Parameters

Type	Name	Description
System.Object	bValue

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

EnableCaseSensitivity()

It sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode

Declaration

public FilterOptionsBuilder<T> EnableCaseSensitivity()

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

EnableCaseSensitivity(Boolean)

It sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode

Declaration

public FilterOptionsBuilder<T> EnableCaseSensitivity(bool casesensitive)

Parameters

Type	Name	Description
System.Boolean	casesensitive	It accepts the boolean value and enables or disables the casesensitive

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

EnableComplexBlankFilter()

It sets the value that indicates to perform the filter operation with empty, null and undefined values.

Declaration

public FilterOptionsBuilder<T> EnableComplexBlankFilter()

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

EnableComplexBlankFilter(Boolean)

It sets the value that indicates to perform the filter operation with empty, null and undefined values.

Declaration

public FilterOptionsBuilder<T> EnableComplexBlankFilter(bool complexBlank)

Parameters

Type	Name	Description
System.Boolean	complexBlank	It accepts the boolean value and enables or disables the filteroperation with empty,null or undefined values or else anyone of the mentioned values.

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

FilterBarMode(FilterBarMode)

This specifies the grid to starts the filter action while typing in the filterBar or after pressing the enter key based on the filterBarMode.

Declaration

public FilterOptionsBuilder<T> FilterBarMode(FilterBarMode filterMode)

Parameters

Type	Name	Description
FilterBarMode	filterMode	It displays the filtered records based on FilterMode options

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

FilteredColumns(Action<FilteredColumnBuilder<T>>)

It sets a value that indicates whether to define the filtered columns details programmatically at initial load

Declaration

public FilterOptionsBuilder<T> FilteredColumns(Action<FilteredColumnBuilder<T>> filterColumn)

Parameters

Type	Name	Description
System.Action<FilteredColumnBuilder<T>>	filterColumn	It displays the list of filteredColumns through lambda expression

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

FilteredColumns(List<FilteredColumn>)

It sets a value that indicates whether to define the filtered columns details programmatically at initial load

Declaration

public FilterOptionsBuilder<T> FilteredColumns(List<FilteredColumn> filterColumn)

Parameters

Type	Name	Description
System.Collections.Generic.List<FilteredColumn>	filterColumn	It displays the list of filtered columns

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

FilterType(FilterType)

This specifies the grid to show the filterBar or filterMenu to the grid records.

Declaration

public FilterOptionsBuilder<T> FilterType(FilterType filterType)

Parameters

Type	Name	Description
FilterType	filterType	It displays the filtered records based on FilterType options

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

IgnoreAccent()

It sets a value that indicates to perform the filter operation with accent in excel styled filter menu mode

Declaration

public FilterOptionsBuilder<T> IgnoreAccent()

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

IgnoreAccent(Boolean)

It sets a value that indicates to perform the filter operation with accent in excel styled filter menu mode

Declaration

public FilterOptionsBuilder<T> IgnoreAccent(bool accent)

Parameters

Type	Name	Description
System.Boolean	accent	It accepts the boolean value and enables or disables the accent

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

MaxFilterChoices(Int32)

It sets a value that indicates the maximum number of filter choices that can be showed in the excel styled filter menu.

Declaration

public FilterOptionsBuilder<T> MaxFilterChoices(int max)

Parameters

Type	Name	Description
System.Int32	max	It accepts the integer value and displays the number of filterchoices that shown in excel filter

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

ShowFilterBarStatus()

This specifies the grid to show the filter text within the grid pager itself.

Declaration

public FilterOptionsBuilder<T> ShowFilterBarStatus()

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

ShowFilterBarStatus(Boolean)

This specifies the grid to show the filter text within the grid pager itself.

Declaration

public FilterOptionsBuilder<T> ShowFilterBarStatus(bool showFilterBarMessage)

Parameters

Type	Name	Description
System.Boolean	showFilterBarMessage	It accepts the boolean value and enables or disables the filter text

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

ShowPredicate()

It sets a value that indicates whether to enable the predicate options in the filtering menu

Declaration

public FilterOptionsBuilder<T> ShowPredicate()

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

ShowPredicate(Boolean)

Gets or sets a value that indicates whether to enable the predicate options in the filtering menu

Declaration

public FilterOptionsBuilder<T> ShowPredicate(bool showPredicate)

Parameters

Type	Name	Description
System.Boolean	showPredicate	It accepts the boolean value and enables or disables the predicate option

Returns

Type	Description
FilterOptionsBuilder<T>	FilterOptionsBuilder

StatusBarWidth(Int32)

Declaration

public FilterOptionsBuilder<T> StatusBarWidth(int width)

Parameters

Type	Name	Description
System.Int32	width

Returns

Type	Description
FilterOptionsBuilder<T>