Table of Contents

TTMSFNCFilterViewCustomItemList.AddCustomControl Method

Registers a user control as a filter item and returns the created item.

API unit family: TMSFNCFilterView Declaring type: TTMSFNCFilterViewCustomItemList

Syntax

function AddCustomControl(AControl: TControl; AValue: TTMSFNCValue; AFilterFieldName: string; AFilterFieldType: TTMSFNCFilterBuilderDataType = fdtAutomatic; AExpressionOperator: TTMSFNCFilterBuilderExpressionOperator= feoEqual; AAddToFilter: Boolean = True; AAddToItems: TTMSFNCFilterStructureItems = nil): TTMSFNCFilterViewCustomItem;

Parameters

Name Description
AControl The control whose value provides the filter expression value.
AValue Initial filter value.
AFilterFieldName Name of the data field to filter on.
AFilterFieldType Data type of the field; defaults to automatic detection.
AExpressionOperator Comparison operator to apply; defaults to equal.
AAddToFilter When True, the item is immediately added to the active filter.
AAddToItems Optional parent filter structure items collection; nil uses the root.