[Expand]General Information
[Collapse]WinForms Controls
  .NET Core Support
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Behaviors
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.DragDrop
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Filtering
  [Expand]DevExpress.Utils.Layout
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.MVVM
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Base
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.ToolbarForm
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Docking
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGantt
  [Expand]DevExpress.XtraGantt.Localization
  [Expand]DevExpress.XtraGantt.Scheduling
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Converter
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Extensions
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.GoogleCalendar
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraTreeMap.Printing
  [Collapse]DevExpress.XtraVerticalGrid
   [Expand]BaseOptionsView Class
    FindMode Enumeration
    HitInfoTypeEnum Enumeration
    LayoutViewStyle Enumeration
    MultiSelectMode Enumeration
   [Expand]PGridOptionsBehavior Class
   [Expand]PGridOptionsView Class
   [Expand]PropertyDescriptionControl Class
   [Expand]PropertyGridControl Class
    PropertySort Enumeration
    RowChangeTypeEnum Enumeration
    RowDragEffect Enumeration
    RowDragSource Enumeration
    ScrollVisibility Enumeration
    ShowButtonModeEnum Enumeration
    TreeButtonStyle Enumeration
    TreeButtonType Enumeration
   [Expand]VGridAppearanceCollection Class
   [Expand]VGridControl Class
   [Collapse]VGridControlBase Class
     VGridControlBase Members
     VGridControlBase Constructor
    [Collapse]VGridControlBase Properties
      ActiveEditor Property
      ActiveEditorViewInfo Property
      Appearance Property
      BandCount Property
      BandMinWidth Property
      BandsInterval Property
      BandWidth Property
      BorderStyle Property
      CanShowEditor Property
      CustomizationForm Property
      CustomizationFormBounds Property
      EditingValue Property
      EmptyAreaHelper Property
      FilterCriteria Property
      FilterString Property
      FindFilterText Property
      FindPanelVisible Property
      FixedBottomRows Property
      FixedTopRows Property
      FocusedRecord Property
      FocusedRecordCellIndex Property
      FocusedRecordModified Property
      FocusedRow Property
      GridDisposing Property
      HasRowErrors Property
      HtmlImages Property
      ImageList Property
      IsPrintingAvailable Property
      LayoutVersion Property
      LeftVisibleBand Property
      LeftVisibleRecord Property
      LeftVisibleRecordPixel Property
      LookAndFeel Property
      MaxRowAutoHeight Property
      NotFixedRows Property
      OptionsBehavior Property
      OptionsFind Property
      OptionsHint Property
      OptionsLayout Property
      OptionsMenu Property
      OptionsSelectionAndFocus Property
      OptionsView Property
      RecordCount Property
      RecordMinWidth Property
      RecordsInterval Property
      RecordsIterator Property
      RecordWidth Property
      RowHeaderMinWidth Property
      RowHeaderWidth Property
      RowHeaderWidthChangeStep Property
      Rows Property
      RowsIterator Property
      ScrollsStyle Property
      ScrollVisibility Property
      SelectedManager Property
      ShowButtonMode Property
      State Property
      TopVisibleRowIndex Property
      TopVisibleRowIndexPixel Property
      TreeButtonStyle Property
      UseDirectXPaint Property
      UseDisabledStatePainter Property
      ViewInfo Property
      VisibleRows Property
    [Expand]VGridControlBase Events
    [Expand]VGridControlBase Methods
   [Expand]VGridHitInfo Class
   [Expand]VGridOptionsBehavior Class
   [Expand]VGridOptionsFilter Class
   [Expand]VGridOptionsHint Class
   [Expand]VGridOptionsLayout Class
   [Expand]VGridOptionsView Class
    VGridState Enumeration
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

VGridControlBase.FilterString Property

Gets or sets the filter criteria applied to the control in text format.

Namespace:DevExpress.XtraVerticalGrid
Assembly:DevExpress.XtraVerticalGrid.v19.2.dll

Expanded Syntax

Property value

Type: String
A string that specifies the filter criteria applied to the control.
The default is null.

Expanded Remarks

See the Filter Strings section below to learn how to build filter expressions in text formats.

When you set the FilterString property, the specified filter string is parsed to create a corresponding DevExpress.Data.Filtering.CriteriaOperator object. The created DevExpress.Data.Filtering.CriteriaOperator object is then assigned to the FilterCriteria property.

Similarly, when you set the FilterCriteria property, the FilterString property is set to the text representation of the specified filter criteria.

Expanded Filter Strings

The simplest text filter expression has the following notation: "[FieldName] = Value". This selects records that have a Value in the column with the specified field name.

In filter expressions, you can use various comparison operators that are dependent upon the types of field names. For instance, if a FieldName is of the numeric or string type, you can use these operators: >, <, <>. For fields of the string type, you can also use the 'like' operator to implement a partial string comparison. The following table covers available comparison operators.

Comparison Operator

Description

Example

=

Equal to.

The operator can be applied to numeric, date-time, string and Boolean values.

[ProductID] = 999

>

Greater than.

The operator can be applied to numeric, date-time and string values.

[ProductName] > 'Uncle'

<

Less than.

The operator can be applied to numeric, date-time and string values.

[UnitsInStock] < 100

>=

Greater than or equal to.

The operator can be applied to numeric, date-time and string values.

[BirthDate] >= #01/01/1980#

<=

Less than or equal to.

The operator can be applied to numeric, date-time and string values.

[CreatedDate] <= #10/2/2006#

<>

Not equal to.

The operator can be applied to numeric, date-time, string and Boolean values.

[Priority] <> 'Low'

LIKE

Operator 'LIKE'.

The operator is used for a partial string comparison. It returns TRUE if the value being tested matches the specified pattern.

You can use the '%' and '_' symbols as wildcards in patterns. The '%' wildcard substitutes any number of characters. The '_' character is used to represent any single character.

[ProductName] LIKE '%Sauce%'

NOT LIKE

Operator 'NOT LIKE'.

The operator is used for partial string comparison. It returns TRUE if the value being tested doesn't match the specified pattern. See the description of the LIKE operator for more information.

[IssueSubject] NOT LIKE 'Help:%'

IS NULL

Checks whether the value being tested is the NULL value.

[Region] IS NULL

IS NOT NULL

Checks whether the value being tested is not the NULL value.

[Region] IS NOT NULL

String constants must be enclosed within single quote characters. If a single quote character needs to be included as a literal to a filter, it must be doubled. Example:

[ProductID] LIKE 'Uncle Bob''s%'

Date-time constants must be wrapped with the '#' characters and represented using a culture-independent (invariant) format. The invariant culture is based on the English culture, but some of the idiosyncratic English formats have been replaced by more globally-accepted formats. Below are some of the culture-independent formats for representing date-time values.

MM/dd/yyyy    07/30/2008

dd MMM yyyy    30 JUL 2008

yyyy-MM-dd    2008-07-30

yyyy-MM-ddTHH:mm:ss    2008-07-30T22:59:59

yyyy-MM-dd HH:mm:ssZ    2008-07-30 15:59:59Z

Example:

[CreatedDate] <= #07/30/2008#

To learn more about invariant cultures, refer to MSDN.

If the '%', '_' or '[' character must be used as a literal in a pattern for the LIKE operator, enclose it with square brackets ('[]'). Example:

[Note] LIKE '%[_]%'

Filter expressions can contain multiple clauses combined by logical AND, AND NOT, OR and OR NOT operators. Clauses can be grouped using parentheses. Example:

[Type] = 'Request' AND NOT ([Status] = 'Fixed' OR [Status] = 'Rejected')

Expanded See Also

Is this topic helpful?​​​​​​​