Skip to main content

TcxDBDataFilterCriteria Members

A filter criteria object which works with TDataSet.

Constructors

Name Description
Create(TcxCustomDataController) Creates an instance of the TcxDataFilterCriteria class. Inherited from TcxDataFilterCriteria.

Properties

Name Description
Active Specifies if the filter criteria apply to a container control. Inherited from TcxDataFilterCriteria.
AutoDataSetFilter Specifies if the data controller automatically applies filter criteria changes to the connected dataset.
CompareByDisplayValues Determines if criteria conditions are compared using their values or display values. Inherited from TcxFilterCriteria.
DataController
DateTimeFormat Specifies the pattern for formatting date/time values. Inherited from TcxFilterCriteria.
FilterCaption Determines the text representation of the filter criteria when displayed in the filter status bar. Inherited from TcxFilterCriteria.
FilterText Specifies filter criteria for a grid control. Inherited from TcxFilterCriteria.
IgnoreOrigin Specifies whether to use the TField.FiledName or the TField.Origin property to represent a field in the FilterText property.
MaxValueListCount Limits the number of rows in the dropdown list, which contains values to set a filter condition for a specific item. Inherited from TcxFilterCriteria.
Options Specifies options controlling filtering and the display of filter text. Inherited from TcxFilterCriteria.
PercentWildcard Specifies the character used to represent any number of symbols in the filter condition of the foLike type. Inherited from TcxFilterCriteria.
Root Specifies the list of filter conditions (simple or aggregate) combined by a logical operator. Inherited from TcxFilterCriteria.
StoreItemLinkNames Specifies whether item names are used to identify items in the filter criteria stored in a memory stream. Inherited from TcxFilterCriteria.
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. Inherited from TcxFilterCriteria.
TranslateBetween Specifies whether the BETWEEN and ‘NOT BETWEEN’ operators in a filter condition are replaced with comparison and logical operators. Inherited from TcxFilterCriteria.
TranslateIn Specifies whether the IN and ‘NOT IN’ operators in a filter condition are replaced with comparison and logical operators. Inherited from TcxFilterCriteria.
TranslateLike Specifies whether the ‘NOT LIKE’ operator in a filter condition is replaced with the inverted logical expression of the LIKE operator. Inherited from TcxFilterCriteria.
UnderscoreWildcard Specifies the symbol used to represent any single character in the filter condition of the foLike type. Inherited from TcxFilterCriteria.

Methods

Name Description
AddExpressionItem(TcxFilterCriteriaItemList,TObject,TcxFilterOperatorKind,string,string) Adds a calculated expression to a filter condition. Inherited from TcxFilterCriteria.
AddExpressionItem(TcxFilterCriteriaItemList,TObject,string,string,string) Inherited from TcxFilterCriteria.
AddItem(TcxFilterCriteriaItemList,TObject,TcxFilterOperatorKind,Variant,string) Adds a new simple filter condition to the specified filter condition list. Inherited from TcxFilterCriteria.
AddItem(TcxFilterCriteriaItemList,TObject,string,Variant,string) Inherited from TcxFilterCriteria.
Assign(TPersistent,Boolean) Copies the Source filter condition to the current TcxFilterCriteria object. Inherited from TcxFilterCriteria.
Assign(TPersistent) Inherited from TPersistent.
AssignEvents(TPersistent) Inherited from TcxFilterCriteria.
AssignItems(TcxFilterCriteria,Boolean) Inherited from TcxFilterCriteria.
AssignTo(TPersistent) Inherited from TPersistent.
BeginUpdate Prevents the TcxFilterCriteria object from updating until the CancelUpdate or EndUpdate method is called. Inherited from TcxFilterCriteria.
CancelUpdate Enables updating the TcxFilterCriteria object after the BeginUpdate method is called. Inherited from TcxFilterCriteria.
Changed Inherited from TcxFilterCriteria.
Clear Removes filter conditions of the TcxFilterCriteria object. Inherited from TcxFilterCriteria.
CreateValueList Inherited from TcxDataFilterCriteria.
EndUpdate Enables updating the TcxFilterCriteria object after the BeginUpdate method has been called. Inherited from TcxFilterCriteria.
EqualItems(TcxFilterCriteria,Boolean) Inherited from TcxFilterCriteria.
Equals(TObject) Inherited from TObject.
FindItemByItemLink(TObject) Inherited from TcxFilterCriteria.
GetHashCode Inherited from TObject.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
IsAutoDataSetFilter
IsEmpty Inherited from TcxFilterCriteria.
IsFiltering Specifies whether filtering is in effect. Inherited from TcxDataFilterCriteria.
LoadFromStream(TStream) Restores the filter settings from a stream. Inherited from TcxFilterCriteria.
ReadData(TStream) Inherited from TcxFilterCriteria.
Refresh Inherited from TcxFilterCriteria.
RemoveItemByField(TcxCustomDataField) Removes all filter conditions for a specific item identified by an internal data field. Inherited from TcxDataFilterCriteria.
RemoveItemByItemLink(TObject) Removes all filter conditions for a specific grid item. Inherited from TcxFilterCriteria.
RestoreDefaults Restores options and wildcards to their default values. Inherited from TcxFilterCriteria.
SaveToStream(TStream) Stores the filter settings in a stream. Inherited from TcxFilterCriteria.
ToString Inherited from TObject.
ValueIsNull(Variant) Inherited from TcxFilterCriteria.
WriteData(TStream,Byte) Inherited from TcxFilterCriteria.
WriteData(TStream) Inherited from TcxFilterCriteria.

Events

Name Description
OnBeforeChange Occurs after changing filter criteria, but before updating data in the corresponding data controller.
OnChanged This event fires after filter criteria have changed. Inherited from TcxFilterCriteria.
OnFormatFilterTextValue Enables you to format the values within the filter string that is applied to a dataset.
OnGetValueList Occurs before displaying a dropdown list of values for a filter condition. Inherited from TcxDataFilterCriteria.
See Also