OptionsColumnFilter.FilterBySortField Property

Gets or sets whether the column’s Filter Dropdown List displays values of the GridColumn.FieldNameSortGroup field or values of the GridColumn.FieldName field.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public virtual DefaultBoolean FilterBySortField { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
Public Overridable Property FilterBySortField As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	**Default**	A DefaultBoolean value.

Available values:

Name	Description
True	Corresponds to a Boolean value of true.
False	Corresponds to a Boolean value of false.
Default	The value is determined by the current object’s parent object setting (e.g., a control setting).

Property Paths

You can access this nested property as listed below:

Object Type	Path to FilterBySortField
GridColumn	.OptionsFilter.FilterBySortField
LayoutViewColumn	.OptionsFilter.FilterBySortField
BandedGridColumn	.OptionsFilter.FilterBySortField

Remarks

If the FilterBySortField property is set to Default or False, the column’s Filter Dropdown List displays values of the field specified by the GridColumn.FieldName property.

If the FilterBySortField property is set to True, the column’s Filter Dropdown List displays values of the field specified by the GridColumn.FieldNameSortGroup property. In addition, if there exists a grid column whose field name matches the field name specified by the GridColumn.FieldNameSortGroup property, this column’s in-place editor will be used for the current column in the Auto Filter Row, custom filter dialog and Filter Editor.