TCustomRichView.GetNextCheckpoint

<< Click to display table of contents >>

TCustomRichView.GetNextCheckpoint

Returns value identifying the next checkpoint after the given CheckpointData, or nil if CheckpointData is the last checkpoint in  the document.

function GetNextCheckpoint(

  CheckpointData: TCheckpointData): TCheckpointData;

GetFirstCheckpoint + GetNextCheckpoint allow to iterate through all checkpoints in the document.

Checkpoints from subdocuments (table cells) are not included in checkpoints list of the document.

 

Example:

var Tag: TRVTag;

    Name: String;

    CheckpointData: TCheckpointData;

    RaiseEvent: Boolean;

    s: TRVUnicodeString;

begin

  MyListBox.Items.Clear;

  CheckpointData := MyRichView.GetFirstCheckpoint;

  while CheckpointData<>nil do 

  begin

    MyRichView.GetCheckpointInfo(CheckpointData, Tag, Name,

      RaiseEvent);

    s := Format('Name:"%s" Tag:"%s"', [Name, Tag]);

    MyListBox.Items.Add(s);

    CheckpointData := MyRichView.GetNextCheckpoint(CheckpointData);

  end;

end;

This code fills listbox MyListBox with information about checkpoints of MyRichView.

 

See also methods:

GetFirstCheckpoint;

GetLastCheckpoint;

GetPrevCheckpoint;

 

GetCheckpointInfo;

GetCheckpointXY.

See also:

"Checkpoints".