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.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Grid

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	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Property Paths

You can access this nested property as listed below:

Object Type	Path to FilterBySortField
GridColumn	.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.