<< Click to display table of contents >> TCustomRichViewEdit.SetCurrentCheckpointInfo |
Creates or modifies checkpoint associated with the item at the position of caret.
function SetCurrentCheckpointInfo(const ATag: TRVTag;
const AName: TRVUnicodeString; ARaiseEvent: Boolean): Boolean;
(changed in version 18 and 19)
SetCurrentCheckpointInfo(...) is equivalent to TopLevelEditor.SetCheckpointInfoEd(TopLevelEditor.CurItemNo, ...).
If the item at the position of caret already has a checkpoint (see GetCurrentCheckpoint), its properties are modified; otherwise, a new checkpoint is created.
This method is used in conjunction with GetCurrentCheckpoint and RemoveCurrentCheckpoint. The alternative set of methods is: InsertCheckpoint, GetCheckpointAtCaret and RemoveCheckpointAtCaret.
Parameters.
ATag – tag of checkpoint;
AName – name of the checkpoint, any string without line break (CR, LF) characters.
ARaiseEvent – "raise event" flag; if set, RichView can generate OnCheckpointVisible event for this checkpoint.
Return value:
True if the checkpoint was set. False otherwise (the function may fail because of a protection or a read-only mode).
Method type: editing-style.
See also methods:
▪GetCurrentCheckpoint, RemoveCurrentCheckpoint;
▪InsertCheckpoint, GetCheckpointAtCaret, RemoveCheckpointAtCaret;
See also properties:
See also:
▪"Tags".