Skip to main content

GridOptionsFilter Members

Provides access to Data Grid filtering options.

Constructors

Name Description
GridOptionsFilter(GridView) Initializes a new instance of the GridOptionsFilter class with specified settings.

Properties

Name Description
AllowAutoFilterConditionChange Get or sets whether or not end-users can change filtering conditions within the automatic filtering row.
AllowColumnMRUFilterList Gets or sets whether the MRU feature is enabled in column filter dropdowns. Inherited from ColumnViewOptionsFilter.
AllowFilterEditor Gets or sets whether the Filter Editor can be used to build complex filter criteria. Inherited from ColumnViewOptionsFilter.
AllowFilterIncrementalSearch Gets or sets whether incremental searching is supported in columns’ Regular and Checked Filter Dropdown Lists. Inherited from ColumnViewOptionsFilter.
AllowMRUFilterList Gets or sets whether the View’s MRU (Most Recently Used) Filter List is enabled. Inherited from ColumnViewOptionsFilter.
AllowMultiSelectInCheckedFilterPopup Gets or sets whether multiple items can be simultaneously selected (highlighted) in a Checked Filter Dropdown List. Inherited from ColumnViewOptionsFilter.
ColumnFilterPopupMaxRecordsCount Gets or sets the maximum number of records that are scanned to populate column filter dropdowns with unique filter values. Inherited from ColumnViewOptionsFilter.
ColumnFilterPopupMode Gets or sets the default display mode of filter dropdowns for columns in the current View. Inherited from ColumnViewOptionsFilter.
ColumnFilterPopupRowCount Gets or sets the maximum number of items that regular filter dropdowns in columns, can display simultaneously. Inherited from ColumnViewOptionsFilter.
DefaultFilterEditorView Gets or sets how an end-user can edit expressions in the Filter Editor and Format Rule Expression Editor. Inherited from ColumnViewOptionsFilter.
FilterEditorAggregateEditing Gets or sets whether filters can be created against properties that are List objects. Inherited from ColumnViewOptionsFilter.
FilterEditorAllowCustomExpressions Gets or sets whether the Filter Editor allows you to display, create and edit custom expressions—expressions that cannot be converted to Filter Editor nodes. Inherited from ColumnViewOptionsFilter.
FilterEditorUseMenuForOperandsAndOperators Gets or sets whether a menu or combobox editor is used to select operands and operators in a filter editor. This property is not supported when filters are edited in a text form (see ColumnViewOptionsFilter.DefaultFilterEditorView). Inherited from ColumnViewOptionsFilter.
InHeaderSearchMode Gets or sets whether built-in column header search boxes are enabled. They allow users to search for column data or filter against columns.
MaxCheckedListItemCount Obsolete. Gets or sets the maximum number of items in a column’s filter dropdown when the items are displayed as a check list. Inherited from ColumnViewOptionsFilter.
MRUColumnFilterListCount Gets or sets the capacity of the MRU item lists in column filter dropdowns. Inherited from ColumnViewOptionsFilter.
MRUFilterListCount Gets or sets the capacity of the View’s MRU (Most Recently Used) Filter List. Inherited from ColumnViewOptionsFilter.
MRUFilterListPopupCount Gets or sets the maximum number of items the View’s MRU (Most Recently Used) Filter List can display at once, in effect its height. Inherited from ColumnViewOptionsFilter.
ShowAllTableValuesInCheckedFilterPopup Gets or sets whether checked filter dropdown lists must display unique values from all the records in the View’s data source or only from those records that meet the current filter criteria. This option is in effect for checked filter dropdown lists. Inherited from ColumnViewOptionsFilter.
ShowAllTableValuesInFilterPopup Gets or sets whether filter dropdown lists must display unique values from all the records in the View’s data source or only from those records that meet the current filter criteria. This option is in effect for regular and Excel-style Filter Dropdowns. Inherited from ColumnViewOptionsFilter.
ShowCustomFunctions Gets or sets whether to show custom function-based filters. Inherited from ColumnViewOptionsFilter.
ShowInHeaderSearchResults Gets or sets whether to display search results within the column header when InHeaderSearchMode is enabled.
ShowInHeaderSearchTextMode Gets or sets whether to show search text (GridColumn.SearchText) in column header tooltips. This property is in effect if built-in column header search boxes are enabled (see GridView.OptionsFilter.InHeaderSearchMode).
UseNewCustomFilterDialog Gets or sets whether the advanced custom filter dialog is used instead of the standard one. Inherited from ColumnViewOptionsFilter.

Methods

Name Description
Assign(BaseOptions) Copies all settings from the target BaseOptions object to this GridOptionsFilter object.
BeginUpdate() Locks the BaseOptions object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from BaseOptions.
CancelUpdate() Unlocks the BaseOptions object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseOptions.
EndUpdate() Unlocks the BaseOptions object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseOptions.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reset() Resets all options to their default values. Inherited from BaseOptions.
ToString() Returns a string representing the currently enabled options. Inherited from BaseOptions.
See Also