TTMSFNCFilterView.AddCustomItemControl Method

Adds a custom control as a filter item under the specified filter item collection.

API unit family: TMSFNCFilterView Declaring type: TTMSFNCFilterView Inherited from: TTMSFNCCustomFilterView

Overloads

Overload 1

Adds a custom control as a filter item under the specified filter item collection.

function AddCustomItemControl(AControl:TControl; AValue: TTMSFNCValue; AFilterFieldName: string; AFilterFieldType: TTMSFNCFilterBuilderDataType; AExpressionOperator: TTMSFNCFilterBuilderExpressionOperator; AAddToFilter: Boolean; AAddToItems: TTMSFNCFilterStructureItems): TTMSFNCFilterStructureItem; overload;

Parameters

Name	Description
AControl	Custom control to register as a filter item.
AValue	Filter value associated with the control.
AFilterFieldName	Field name used by the generated filter item.
AFilterFieldType	Field data type used to interpret the value.
AExpressionOperator	Operator used by the generated expression.
AAddToFilter	When True, the generated item is added to the filter structure.
AAddToItems	Filter item collection that receives the generated item.

Returns

The generated filter structure item.

Overload 2

Adds a custom control as a filter item under the root or a custom group control.

function AddCustomItemControl(AControl:TControl; AValue: TTMSFNCValue; AFilterFieldName: string; AFilterFieldType: TTMSFNCFilterBuilderDataType = fdtAutomatic; AExpressionOperator: TTMSFNCFilterBuilderExpressionOperator = feoEqual; AAddToFilter: Boolean = True; AGroupControl: TControl = nil): TTMSFNCFilterStructureItem; overload;

Parameters

Name	Description
AControl	Custom control to register as a filter item.
AValue	Filter value associated with the control.
AFilterFieldName	Field name used by the generated filter item.
AFilterFieldType	Field data type used to interpret the value.
AExpressionOperator	Operator used by the generated expression.
AAddToFilter	When True, the generated item is added to the filter structure.
AGroupControl	Optional custom group control that receives the item.

Returns

The generated filter structure item.