rvico TRichView Reference | TRichView

TCustomRichView.AddCheckpoint

Top  Previous  Next

Adds a checkpoint to the end of document.

function AddCheckpoint(const CpName: TRVUnicodeString = '';
  RaiseEvent: Boolean = False; const CpTag: TRVTag = RVEMPTYTAG): Integer;

Checkpoints are not items, but the methods for appending checkpoints are similar to methods for appending items. This checkpoint will be associated with the next appended item.

Parameters:

CpName – name of checkpoint. It must not contain #0, #1 and #2 characters.

RaiseEvent – "raise event" flag, see OnCheckpointVisible

Tagtag of checkpoint.

Return value:

Index of the added checkpoint

Methods type: viewerstyle viewer-style.

See also methods:

SetCheckpointInfo;

RemoveCheckpoint.

See also methods of TRichViewEdit:

SetCheckpointInfoEd;

SetCurrentCheckpointInfo.

See also:

Methods for appending items;

Checkpoints;

Tags.


Related deprecated methods:

function AddNamedCheckpointExTag(const CpName: TRVUnicodeString;

  RaiseEvent: Boolean; const Tag: TRVTag): Integer;

function AddCheckpoint: Integer;

function AddCheckpointTag(const Tag: TRVTag): Integer;

function AddNamedCheckpoint(const CpName: TRVUnicodeString): Integer;

function AddNamedCheckpointEx(const CpName: TRVUnicodeString;

  RaiseEvent: Boolean): Integer;

These methods provide subset of functionality of AddCheckpoint.


TRichView © trichview.com