TBookmarkedRecordEnumerator.MoveNext function

Member of TBookmarkedRecordEnumeratorpublicIn unit DBGrids

Moves to the next bookmark in the list.

Declaration

pascal

function MoveNext: Boolean

Function result

True when the action has been performed successfully.

Description

MoveNext is a Boolean function used to move the enumerator to the next item in the bookmark list. Move next increments the value in BookmarkIndex, and examines the Options property to see if any actions are required, such as: setting the value of the Current Bookmark before navigation, or disabling controls attached to the dataset.

MoveNext updates the current bookmark and checks the dataset to see if the bookmark is still valid. The return value is False if the record for the bookmark no longer exists in the dataset and Options indicates the enumerator should halt for an invalid bookmark. False is also returned when the value in BookmarkIndex exceeds the number of items in the BookmarkList.

The return value is True when the action has been performed successfully.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.