RepositoryItemGridLookUpEditBase.PopupFilterMode Property

Gets or sets how records in the dropdown window are filtered when typing text within the edit box.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DXCategory("Data")]
[DefaultValue(PopupFilterMode.Default)]
public PopupFilterMode PopupFilterMode { get; set; }
<DXCategory("Data")>
<DefaultValue(PopupFilterMode.Default)>
Public Property PopupFilterMode As PopupFilterMode

Property Value

Type Default Description
PopupFilterMode

Default

A PopupFilterMode value that specifies the editor's popup filter mode.

Remarks

The GridLookUpEdit and SearchLookUpEdit controls support record filtering, where typing text within the edit box displays only those records in the dropdown that meet the current criteria. The PopupFilterMode property specifies how records are filtered, using the StartsWith or Contains filter. The StartsWith filter selects records whose values of the DisplayMember field start with the typed text. The Contains filter selects records that contain the typed text within the DisplayMember field.

For the GridLookUpEdit control, if text editing is disabled via the RepositoryItemLookUpEditBase.TextEditStyle property, the StartsWith filter is always applied, and changing the PopupFilterMode property is not in effect.

If the PopupFilterMode property is set to Default, the filtering behavior is different for different editors, and is also dependent upon the editor's settings. See PopupFilterMode.Default to learn more.

Note that if the PopupFilterMode property is set to Default for the SearchLookUpEdit control, a search for records is performed against all columns, by default. You can change this behavior by specifying the search columns via the RepositoryItemGridLookUpEditBase.PopupView's DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.FindFilterColumns property. In the StartsWith or Contains modes, the search is performed against the field specified by the RepositoryItemLookUpEditBase.DisplayMember property.

See Also