Skip to main content

Global Event: OnFilterSqlStatementConstructed

  • Updated

Global Event: OnFilterSqlStatementConstructed

The OnFilterSqlStatementConstructed event occurs just before SQL is sent to the Data Source to retrieve data to populate a filter dropdown. This Event could be used to inspect, log or modify the SQL that is being used to populate the dropdown.

Signature

For custom code the arguments array is structured as follows:

args[] contains:

  1. a string representing the filter SQL

For .NET Assemblies the method signature is as follows:

light bulb

Include the WebReports.Api.Data namespace.

string EventHandlerName(SessionInfo sessionInfo, string filtersSql, SqlObject sqlObject)

Expected Return

The OnFilterSqlStatementConstructed Event expects a string value to be returned.

Note

This Event will provide the SQL for the Filter Dropdown Object if that feature is being utilized. See Data Objects for more information on Filter Dropdown Objects.