rvico TRichView Reference | TRichViewEdit

TCustomRichViewEdit.SetCurrentCheckpointInfo

Top  Previous  Next

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

procedure SetCurrentCheckpointInfo(const ATag: TRVTag

  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.

ATagtag 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.

 

Method type: editstyle editing-style.

unicode Unicode note: names of checkpoints are Unicode strings for Delphi/C++Builder 2009 or newer, and ANSI strings for older versions of Delphi/C++Builder.

 

See also methods:

GetCurrentCheckpoint, RemoveCurrentCheckpoint;

InsertCheckpoint, GetCheckpointAtCaret, RemoveCheckpointAtCaret;

SetCheckpointInfoEd.

See also properties:

CurItemNo.

See also:

Modifying RichView items;

"Checkpoints";

"Tags".


TRichView © trichview.com