Please enable JavaScript to view this site.

Navigation: Advanced topics > Events > Table events > List page

Custom Query

Scroll Prev Next More

Deprecated

This function is deprecated. While the existing code keeps working, we recommend switching to SQL Views.

Description

The ListQuery event is executed before the List page is processed. Use this event when the data set is more complicated than the result of an SQL query.

 
Here is the article that shows how to use ListFetchArray and ListQuery events together: How to display data returned by stored procedure

Syntax

ListQuery(searchObj,orderBy,howOrderBy,masterTable,masterKeysReq,selectedRecord,pageSize,myPage,pageObject)

Arguments

searchObj

an instance of the class which performs search.

orderBy

an array with field order.

howOrderBy

an array with sort type for 'orderBy' array.

masterTable

a master table name.

masterKeysReq

an array of keys.

selectedRecord

an array of selected records on the Print page, null on the List page.

pageSize

a number of records per page.

myPage

the current page number.

pageObject

an object representing the current page. For more information, see RunnerPage class.

Return value

The function returns a data array or false.

Applies to pages

List, Print.

See also:

Event: ListGetRowCount

Connecting to the database

How to display data returned by stored procedure

About Search API

SQL query screen

About SQLQuery class