Interfacing Technologies Corporation

13.1.2.2.8.6. Method – SetFilter / ClearFilter (FormService)

This sample script demonstrates how to set or clear a filter for a grid on a form, similar to how a search panel operates.

  • sourceControlId – grid control ServerId
  • control – control from formControls
  • filters – list of filters (ClauseItem {string Property; ClauseEnum Clause; object Value})

Syntax

void SetFilter(string sourceControlId, List<‍‍‍ClauseItem‍‍‍> filters)
void SetFilter(IControl control, List<‍‍‍ClauseItem‍‍‍> filters)
void ClearFilter(string sourceControlId)
void ClearFilter(IControl control)

Applicability

This functionality is only available within the control script as it requires access to the formControl object.

Code Samples

// set filter
var filters = new List<‍‍‍ClauseItem‍‍‍>();
filters.Add(new ClauseItem("Quantity", ClauseEnum.Equals, 5));
bpmAppService.BPMSServices.FormService.SetFilter(formControl.Lines, filters);
// clear filter
bpmAppService.BPMSServices.FormService.ClearFilter(formControl.Lines);