Skip to main content

TcxFilterCriteria Members

The base class for grid filtering facilities.

Properties

Name Description
CompareByDisplayValues Determines if criteria conditions are compared using their values or display values.
DateTimeFormat Specifies the pattern for formatting date/time values.
FilterCaption Determines the text representation of the filter criteria when displayed in the filter status bar.
FilterText Specifies filter criteria for a grid control.
MaxValueListCount Limits the number of rows in the dropdown list, which contains values to set a filter condition for a specific item.
Options Specifies options controlling filtering and the display of filter text.
PercentWildcard Specifies the character used to represent any number of symbols in the filter condition of the foLike type.
Root Provides access to the root list of filter criteria combined by logical operators.
StoreItemLinkNames Specifies whether item names are used to identify items in the filter criteria stored in a memory stream.
SupportedLike Specifies whether the LIKE, ‘NOT LIKE’, CONTAINS, ‘NOT CONTAINS’, ‘BEGINS WITH’, and ‘ENDS WITH’ operators are available to end-users within the Filter Builder dialog.
TranslateBetween Specifies whether the BETWEEN and ‘NOT BETWEEN’ operators in a filter condition are replaced with comparison and logical operators.
TranslateIn Specifies whether the IN and ‘NOT IN’ operators in a filter condition are replaced with comparison and logical operators.
TranslateLike Specifies whether the ‘NOT LIKE’ operator in a filter condition is replaced with the inverted logical expression of the LIKE operator.
UnderscoreWildcard Specifies the symbol used to represent any single character in the filter condition of the foLike type.

Methods

Name Description
AddExpressionItem(TcxFilterCriteriaItemList,TObject,TcxFilterOperatorKind,string,string) Adds a calculated expression to a filter condition.
AddExpressionItem(TcxFilterCriteriaItemList,TObject,string,string,string)
AddItem(TcxFilterCriteriaItemList,TObject,TcxFilterOperatorKind,Variant,string) Adds a new simple filter condition to the specified filter condition list.
AddItem(TcxFilterCriteriaItemList,TObject,string,Variant,string)
Assign(TPersistent,Boolean) Copies the Source filter condition to the current TcxFilterCriteria object.
Assign(TPersistent) Inherited from TPersistent.
AssignEvents(TPersistent)
AssignItems(TcxFilterCriteria,Boolean)
AssignTo(TPersistent) Inherited from TPersistent.
BeginUpdate Postpones all filter criteria calculations and corresponding UI redraw operations until an EndUpdate procedure call.
CancelUpdate Enables updating the TcxFilterCriteria object after the BeginUpdate method is called.
Changed
Clear Removes filter conditions of the TcxFilterCriteria object.
EndUpdate Applies all pending changes after a BeginUpdate procedure call.
EqualItems(TcxFilterCriteria,Boolean)
Equals(TObject) Inherited from TObject.
FindItemByItemLink(TObject)
GetHashCode Inherited from TObject.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
IsEmpty
LoadFromStream(TStream) Restores the filter settings from a stream.
ReadData(TStream)
Refresh
RemoveItemByItemLink(TObject) Removes all filter conditions for a specific grid item.
RestoreDefaults Restores options and wildcards to their default values.
SaveToStream(TStream) Stores the filter settings in a stream.
ToString Inherited from TObject.
ValueIsNull(Variant)
WriteData(TStream,Byte)
WriteData(TStream)

Events

Name Description
OnChanged This event fires after filter criteria have changed.
See Also