TTMSFNCCustomFilterBuilder Class
Base class that implements filter building, parsing, text generation, and validation logic.
API unit family: TMS.TMSFNCFilterBuilder
Inherits from: TPersistent
Syntax
TTMSFNCCustomFilterBuilder = class(TPersistent)
Properties
| Name | Description |
|---|---|
| DataBoolean | When True, custom Boolean data associated with the filter builder is set. |
| DataInteger | Gets or sets custom integer data associated with the filter builder. |
| DataObject | Gets or sets custom object data associated with the filter builder. |
| DataPointer | Gets or sets custom pointer data associated with the filter builder. |
| DataString | Gets or sets custom string data associated with the filter builder. |
Methods
| Name | Description |
|---|---|
| AddDataColumn | Adds a new empty data column to the collection. |
| AddDataColumnsFromFilter | Adds data columns derived from the field names referenced in the current groups and expressions. |
| BeginUpdate | Suspends change notifications while updating the filter structure. |
| ClearFilter | Removes all groups and expressions from the filter. |
| DeleteExpression | Removes an expression from the filter structure. |
| DeleteGroup | Removes a group from the filter structure. |
| EndUpdate | Resumes change notifications after a BeginUpdate call. |
| GetColumnByDisplayName | Returns the data column with the specified display name. |
| GetColumnByName | Returns the data column with the specified internal name. |
| GetExpressionInformation | Parses a single expression string and returns its structural details. |
| GetExpressionText | Generates expression text from a column name, data type, operator, text value, typed value, and inversion flag. |
| GetFormatSettings | Returns the format settings used for parsing and formatting filter values. |
| GetOperatorText | Returns the formatted text for a group operator. |
| ParseExpression | Parses a filter text string and populates the filter structure. |
| PopulateFilter | Replaces the current filter with a new root group built from the given groups and expressions. |
| PopulateFilterExpressions | Replaces the current filter with a new root group built from the given expressions. |
| PopulateFilterGroups | Replaces the current filter with a new root group built from the given groups. |
| ValidateFilterArray | Validates multiple input rows or columns against the current filter. |
| ValidateFilterRow | Validates a single input row against the current filter. |
| isExpressionValid | Checks whether an expression string is structurally valid. |