Back to Devexpress

OptionsColumnFilter.FilterBySortField Property

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-optionscolumnfilter-349c5965.md

latest3.6 KB
Original Source

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

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

Declaration

csharp
[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public virtual DefaultBoolean FilterBySortField { get; set; }
vb
<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
Public Overridable Property FilterBySortField As DefaultBoolean

Property Value

TypeDefaultDescription
DefaultBooleanDefault

A DefaultBoolean value.

|

Available values:

NameDescriptionReturn Value
True

The value is true.

|

0

| | False |

The value is false.

|

1

| | Default |

The value is specified by a global option or a higher-level object.

|

2

|

Property Paths

You can access this nested property as listed below:

Object TypePath 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.

See Also

FieldNameSortGroup

OptionsColumnFilter Class

OptionsColumnFilter Members

DevExpress.XtraGrid.Columns Namespace