Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

TcxGridItemDataBinding.AddToFilter(TcxFilterCriteriaItemList,TcxFilterOperatorKind,Variant,string,Boolean) Method

Adds a filter condition to the filters list.

#Declaration

Delphi
function AddToFilter(AParent: TcxFilterCriteriaItemList; AOperatorKind: TcxFilterOperatorKind; const AValue: Variant; const ADisplayText: string = ''; AReplaceExistent: Boolean = True): TcxFilterCriteriaItem;

#Parameters

Name Type
AParent TcxFilterCriteriaItemList
AOperatorKind TcxFilterOperatorKind
AValue Variant
ADisplayText string
AReplaceExistent Boolean

#Returns

Type
TcxFilterCriteriaItem

#Remarks

Call this function to add a filter condition to the filter list determined by the AParent parameter. If AParent is NIL, a new filter condition is inserted in the root list provided by the Filter.Root property. This filter condition affects the item determined by the Item property.

The AOperatorKind parameter specifies the filter operator. For the list of available operators, see the TcxFilterOperatorKind type description.

The AValue and ADisplayText parameters specify the values for the Value and DisplayValue properties of the new filter condition. If the AReplaceExistent parameter is True, all filtering conditions for the item are cleared first, otherwise the new filtering condition is appended to them.

See Also