TTMSFNCCustomFilterView.AddCustomItemControl Method
Adds a custom control as a filter item under the specified filter item collection.
API unit family: TMSFNCFilterView
Declaring type: 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;
TTMSFNCFilterStructureItem* __fastcall AddCustomItemControl(Fmx::Controls::TControl* AControl, const TTMSFNCValue &AValue, System::UnicodeString AFilterFieldName, TTMSFNCFilterBuilderDataType AFilterFieldType, TTMSFNCFilterBuilderExpressionOperator AExpressionOperator, bool AAddToFilter, TTMSFNCFilterStructureItems* AAddToItems)/* 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;
TTMSFNCFilterStructureItem* __fastcall AddCustomItemControl(Fmx::Controls::TControl* AControl, const TTMSFNCValue &AValue, System::UnicodeString AFilterFieldName, TTMSFNCFilterBuilderDataType AFilterFieldType = (TTMSFNCFilterBuilderDataType)(0x0), TTMSFNCFilterBuilderExpressionOperator AExpressionOperator = (TTMSFNCFilterBuilderExpressionOperator)(0x3), bool AAddToFilter = true, Fmx::Controls::TControl* AGroupControl = (Fmx::Controls::TControl*)(0x0))/* 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.