Skip to main content

OptionsColumnFilter Members

Contains filter options for columns.

Constructors

Name Description
OptionsColumnFilter(GridColumn) Initializes a new instance of the OptionsColumnFilter class.

Properties

Name Description
AllowAutoFilter Gets or sets whether the column’s values can be filtered using the auto filter row.
AllowFilter Gets or sets whether the filter button in Grid Views (field filter button in Layout Views) is displayed within the column header.
AllowFilterModeChanging Gets or sets whether a dedicated menu item is available in a column header menu that allows an end-user to change the filter mode for columns.
AllowInHeaderSearch Gets or sets whether a search box is enabled in the current column’s header. This property is in effect if the GridOptionsFilter.InHeaderSearchMode option is set to TextFilter.
AutoFilterCondition Gets or sets the type of the comparison operator used to create filter conditions for the current column via the Automatic Filtering Row.
FilterBySortField Gets or sets whether the column’s Filter Dropdown List displays values of the GridColumn.FieldNameSortGroup field or values of the GridColumn.FieldName field.
FilterPopupMode Gets or sets which filtering options are available in pop-up menus and how they are presented.
ImmediateUpdateAutoFilter Gets or sets whether the column’s filter condition is updated as soon as an end-user modifies the contents of the Auto Filter Row‘s cell.
ImmediateUpdatePopupDateFilterOnCheck

This option is in effect for date-time columns whose filter dropdown list contains an embedded calendar with check boxes to select common date intervals. It specifies whether toggling the check boxes filters grid records immediately.

ImmediateUpdatePopupDateFilterOnDateChange

This option is in effect for date-time columns whose filter dropdown list contains an embedded calendar with check boxes to select common date intervals. It specifies whether selecting a date or date range via the embedded calendar filters grid records immediately.

ImmediateUpdatePopupExcelFilter Gets or sets whether filter conditions immediately apply to data, or only when the filter dropdown closes. This property is in effect for the Excel-style Filter Dropdown.
InHeaderSearchPrompt Gets or sets a grayed out hint displayed in an empty header search box when the search box is activated.
PopupExcelFilterDateTimeValuesTabFilterType Gets or sets whether date-time values are arranged in an outline view or a list in the Excel style pop-up filter menus.
PopupExcelFilterDefaultTab Gets or sets whether the Values or Filters tab opens by default in the Excel-style Filter Dropdown.
PopupExcelFilterEnumFilters Gets or sets whether to show relational operators (equality and inequalities) in the Filters tab of the Excel-style Filter Dropdown (if the current column contains enumeration data).
PopupExcelFilterGrouping Gets or sets data field (column) names separated by a comma, semicolon, space or tab character by which filter values are grouped in the column’s filter menu.
PopupExcelFilterNumericValuesTabFilterType Gets or sets the type of filtering UI used to create filters in the Values tab in the Excel-inspired filter dropdown (if the current column is of a numeric data type).
PopupExcelFilterTextFilters Gets or sets whether to show pattern-matching (e.g., Is Like) and relational (e.g., Greater Than) operators for string values in the Excel style pop-up filter menus.
ShowBlanksFilterItems Gets or sets whether the column’s Filter Dropdown (when presented as a Regular List or Checked List) displays the “(Blanks)” and “(Non Blanks)” filter items.
ShowEmptyDateFilter Gets or sets whether a Filter Dropdown List has the “Show Empty” filter used to select records that contain null values in a date-time column.

Methods

Name Description
Assign(BaseOptions) Copies all the settings from the options object passed as the parameter.
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