TTMSFNCFilterBuilderFilter Class

Root filter group that represents the complete filter for a filter builder.

API unit family: TMS.TMSFNCFilterBuilder Inherits from: TTMSFNCFilterBuilderGroup

Syntax

TTMSFNCFilterBuilderFilter = class(TTMSFNCFilterBuilderGroup)

Properties

Name	Description
DataBoolean	When True, custom Boolean data associated with the group is set. (inherited from TTMSFNCFilterBuilderGroup)
DataInteger	Gets or sets custom integer data associated with the group. (inherited from TTMSFNCFilterBuilderGroup)
DataObject	Gets or sets custom object data associated with the group. (inherited from TTMSFNCFilterBuilderGroup)
DataPointer	Gets or sets custom pointer data associated with the group. (inherited from TTMSFNCFilterBuilderGroup)
DataString	Gets or sets custom string data associated with the group. (inherited from TTMSFNCFilterBuilderGroup)
Expressions	Gets or sets the expressions in this group. (inherited from TTMSFNCFilterBuilderGroup)
FilterText	Gets the group as formatted filter text. (inherited from TTMSFNCFilterBuilderGroup)
GroupOperator	Gets or sets the logical operator used to combine child expressions and groups. (inherited from TTMSFNCFilterBuilderGroup)
Groups	Gets or sets the nested groups in this group. (inherited from TTMSFNCFilterBuilderGroup)
IsInverted	When True, the combined result of this group is negated. Set from a NOT that precedes the group in the filter text, and written back as a NOT prefix when the text is regenerated. Default is False. (inherited from TTMSFNCFilterBuilderGroup)

Methods

Name	Description
AddANDGroup	Adds a nested group that combines children with AND. (inherited from TTMSFNCFilterBuilderGroup)
AddExpression	Adds an empty expression to the group. (inherited from TTMSFNCFilterBuilderGroup)
AddGroup	Adds a nested group. (inherited from TTMSFNCFilterBuilderGroup)
AddORGroup	Adds a nested group that combines children with OR. (inherited from TTMSFNCFilterBuilderGroup)
Clear	Removes all nested groups and expressions from the group. (inherited from TTMSFNCFilterBuilderGroup)
DoGetFilterBuilder	Raises the event that resolves the owning filter builder. (inherited from TTMSFNCFilterBuilderGroup)
GetBuilder	Returns the filter builder that owns this group. (inherited from TTMSFNCFilterBuilderGroup)
GetGroupOperatorText	Returns the textual operator used by this group. (inherited from TTMSFNCFilterBuilderGroup)
ValidateFilter	Validates one input row against the group. (inherited from TTMSFNCFilterBuilderGroup)

Events

Name	Description
OnGetFilterBuilder	Occurs when the group needs to resolve its owning filter builder. (inherited from TTMSFNCFilterBuilderGroup)