TRichView Reference | TRichViewEdit

TCustomRichViewEdit.SetCurrentCheckpointInfo

Creates or modifies checkpoint associated with the item at the position of caret.

procedure SetCurrentCheckpointInfo(ATag: Integer; 

  const AName: String; ARaiseEvent: Boolean);

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; it can be an integer value or a pointer to dynamically allocated string (see rvoTagsArePChars in RichView.Options)

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.

Method type: editing-style.

Unicode note: checkpoints names are ANSI strings.

See also methods:

See also properties:

See also: