TTMSFNCFilterBuilder Class

Builds, parses, formats, and validates structured filter expressions.

API unit family: TMS.TMSFNCFilterBuilder Inherits from: TTMSFNCCustomFilterBuilder

Syntax

GeneratedPascalC++

TTMSFNCFilterBuilder = class(TTMSFNCCustomFilterBuilder)

class PASCALIMPLEMENTATION TTMSFNCFilterBuilder : public TTMSFNCCustomFilterBuilder

Properties

Name	Description
DataBoolean	When `True`, custom Boolean data associated with the filter builder is set. (inherited from `TTMSFNCCustomFilterBuilder`)
DataColumn	Returns the column with the specified name, creating it when needed. (inherited from `TTMSFNCCustomFilterBuilder`)
DataColumnDisplayName	Gets or sets the display name for the specified data column. (inherited from `TTMSFNCCustomFilterBuilder`)
DataColumnType	Gets or sets the data type for the specified data column. (inherited from `TTMSFNCCustomFilterBuilder`)
DataColumns	Gets or sets the collection of filterable data columns. (inherited from `TTMSFNCCustomFilterBuilder`)
DataInteger	Gets or sets custom integer data associated with the filter builder. (inherited from `TTMSFNCCustomFilterBuilder`)
DataObject	Gets or sets custom object data associated with the filter builder. (inherited from `TTMSFNCCustomFilterBuilder`)
DataPointer	Gets or sets custom pointer data associated with the filter builder. (inherited from `TTMSFNCCustomFilterBuilder`)
DataString	Gets or sets custom string data associated with the filter builder. (inherited from `TTMSFNCCustomFilterBuilder`)
DisplayFilterText	Gets or sets the user-facing filter text that uses display names. (inherited from `TTMSFNCCustomFilterBuilder`)
Filter	Gets or sets the root filter group. (inherited from `TTMSFNCCustomFilterBuilder`)
FilterText	Gets or sets the filter as text. (inherited from `TTMSFNCCustomFilterBuilder`)
FormatType	Gets or sets the predefined filter text format. (inherited from `TTMSFNCCustomFilterBuilder`)
IsEmpty	Returns `True` when the filter contains no groups or expressions. (inherited from `TTMSFNCCustomFilterBuilder`)
ParseFormat	Gets or sets the parse format used for filter text. (inherited from `TTMSFNCCustomFilterBuilder`)

Methods

Name	Description
AddDataColumn	Adds a new empty data column to the collection. (inherited from `TTMSFNCCustomFilterBuilder`)
AddDataColumnsFromFilter	Adds data columns derived from the field names referenced in the current groups and expressions. (inherited from `TTMSFNCCustomFilterBuilder`)
BeginUpdate	Suspends change notifications while updating the filter structure. (inherited from `TTMSFNCCustomFilterBuilder`)
ClearFilter	Removes all groups and expressions from the filter. (inherited from `TTMSFNCCustomFilterBuilder`)
DeleteExpression	Removes an expression from the filter structure. (inherited from `TTMSFNCCustomFilterBuilder`)
DeleteGroup	Removes a group from the filter structure. (inherited from `TTMSFNCCustomFilterBuilder`)
EndUpdate	Resumes change notifications after a BeginUpdate call. (inherited from `TTMSFNCCustomFilterBuilder`)
GetColumnByDisplayName	Returns the data column with the specified display name. (inherited from `TTMSFNCCustomFilterBuilder`)
GetColumnByName	Returns the data column with the specified internal name. (inherited from `TTMSFNCCustomFilterBuilder`)
GetExpressionInformation	Parses a single expression string and returns its structural details. (inherited from `TTMSFNCCustomFilterBuilder`)
GetExpressionText	Generates expression text from a column name, data type, operator, text value, typed value, and inversion flag. (inherited from `TTMSFNCCustomFilterBuilder`)
GetFormatSettings	Returns the format settings used for parsing and formatting filter values. (inherited from `TTMSFNCCustomFilterBuilder`)
GetOperatorText	Returns the formatted text for a group operator. (inherited from `TTMSFNCCustomFilterBuilder`)
ParseExpression	Parses a filter text string and populates the filter structure. (inherited from `TTMSFNCCustomFilterBuilder`)
PopulateFilter	Replaces the current filter with a new root group built from the given groups and expressions. (inherited from `TTMSFNCCustomFilterBuilder`)
PopulateFilterExpressions	Replaces the current filter with a new root group built from the given expressions. (inherited from `TTMSFNCCustomFilterBuilder`)
PopulateFilterGroups	Replaces the current filter with a new root group built from the given groups. (inherited from `TTMSFNCCustomFilterBuilder`)
ValidateFilterArray	Validates multiple input rows or columns against the current filter. (inherited from `TTMSFNCCustomFilterBuilder`)
ValidateFilterRow	Validates a single input row against the current filter. (inherited from `TTMSFNCCustomFilterBuilder`)
isExpressionValid	Checks whether an expression string is structurally valid. (inherited from `TTMSFNCCustomFilterBuilder`)

Events

Name	Description
OnChanged	Occurs when the filter builder changes. (inherited from `TTMSFNCCustomFilterBuilder`)
OnColumnsChanged	Occurs when the data column collection changes. (inherited from `TTMSFNCCustomFilterBuilder`)
OnExpressionAdded	Occurs when an expression is added to the filter builder. (inherited from `TTMSFNCCustomFilterBuilder`)
OnExpressionTextParsed	Occurs after an expression text fragment is parsed. (inherited from `TTMSFNCCustomFilterBuilder`)
OnFilterTextParsed	Occurs after filter text is parsed into the filter structure. (inherited from `TTMSFNCCustomFilterBuilder`)
OnGetExpressionText	Occurs when expression text is generated and can be customized. (inherited from `TTMSFNCCustomFilterBuilder`)
OnGetFilterText	Occurs when filter text is generated and can be customized. (inherited from `TTMSFNCCustomFilterBuilder`)
OnGetFormatSettings	Occurs when format settings are requested for parsing or formatting values. (inherited from `TTMSFNCCustomFilterBuilder`)
OnGetGroupText	Occurs when group text is generated and can be customized. (inherited from `TTMSFNCCustomFilterBuilder`)
OnParseError	Occurs when parsing fails for any supported parse error reason. (inherited from `TTMSFNCCustomFilterBuilder`)
OnParseErrorInvalidExpression	Occurs when parsing detects an invalid expression. (inherited from `TTMSFNCCustomFilterBuilder`)
OnParseErrorOperatorMismatch	Occurs when parsing detects mixed group operators where one operator is expected. (inherited from `TTMSFNCCustomFilterBuilder`)
OnParseErrorOperatorPosition	Occurs when parsing detects an operator in an invalid position. (inherited from `TTMSFNCCustomFilterBuilder`)
OnParseErrorParenthesis	Occurs when parsing detects mismatched parentheses. (inherited from `TTMSFNCCustomFilterBuilder`)
OnParseFormatChanged	Occurs when the parse format changes. (inherited from `TTMSFNCCustomFilterBuilder`)
OnValidateExpression	Occurs when an expression is validated against an input value. (inherited from `TTMSFNCCustomFilterBuilder`)
OnValidateFilter	Occurs when the complete filter is validated against input data. (inherited from `TTMSFNCCustomFilterBuilder`)
OnValidateGroup	Occurs when a group is validated against input data. (inherited from `TTMSFNCCustomFilterBuilder`)

Used by