PageInMatchingRow - cCJGridDataSource

Makes sure that the data row represented by the passed RowId is loaded into the datasource cache

Type: Function
Return Data Type: Integer

Parameters

Parameter	Type	Description
riId	RowID	The RowId of the DataDictionary record to be loaded

Syntax

Function PageInMatchingRow RowID riId Returns Integer

Call Example

Get PageInMatchingRow riId to IntegerVariable

Description

PageInMatchingRow is used to manage cached data. When called, it makes sure that the row identified by the passed RowId is part of the current datasource cache. If it is not, it will clear the cache, load the row and reload the row data around this record.

cCJGrid / cCJGridDataSource

This does nothing. If the data is static, it should be loaded.

cDbCJGrid / cDbCJGridDataSource

This first checks if the RowId can be found in the cache. If found, it returns the row index. If not found, it clears the cache, finds the row by its RowId and then refreshes the cache around this row. It then returns the row index of the row. If the RowId is not found, it returns -1 and the cache is emptied.

If you wish to refresh your cDbCJGrid around a RowId see RefreshDataFromMatchingRow and RefreshDataFromSelectedRow.

You will never send this message and will probably never augment it. If you create a custom datasource class, this interface must be supported.

Return Value

The row number (index) of the row matching this RowId. If the row could not be found or loaded, it returns -1.