GoToDataRecordCommand.execute(activeRecordIndex) Method

Executes the GoToDataRecordCommand command with the specified parameter.

Declaration

execute(
    activeRecordIndex: number
): boolean

Parameters

Name Type Description
activeRecordIndex number

An integer value specifying index of the next data record.

Returns

Type Description
boolean

true if the command has been successfully executed; false if the command execution has failed.

Remarks

Usage example:

richEdit.commands.goToDataRecord.execute(3);

Use the GoToDataRecordCommand.getState method to get the DataRecordOptions object containing the total number of records and the index of the active record.

See Also