getTotalRecordCount (Client API reference)

Returns the total number of records that match the filter criteria of the view, not limited by the number visible in a single page.

  • When the Dynamics 365 for Outlook client isn't connected to the server, this number is limited to those records that the user has selected to take offline.
  • For Dynamics 365 mobile clients, this method will return the number of records in the subgrid.

Grid types supported

Read-only and editable grids

Syntax

let filteredRecordCount = gridContext.getGrid().getTotalRecordCount();

Return Value

Type: Number

Description: Total number of records that match the filter criteria of the view.

Remarks

To get the gridContext, see Getting the grid context.

See Collections (Client API reference) for information on the methods available to access data in a collection.