rvico TRichView Reference | TRichViewEdit

TCustomRichViewEdit.SetCheckpointInfoEd

Top  Previous  Next

An editing-style method for creating new or modifying the existing checkpoint associated with the ItemNo-th item

procedure SetCheckpointInfoEd(ItemNo: Integer; ATag: Integer;

  const AName: String; ARaiseEvent: Boolean);

Parameters

ItemNo – index of the item, from 0 to ItemCount-1. Items of subdocuments (table cells) are not included in the items range of the main document; for items in cells, use Cell.GetRVData.SetCheckpointInfoEd (or use SetCurrentCheckpointInfo). If this item already has a checkpoint, its properties are modified; otherwise, a new checkpoint is created.

ATagtag 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: editstyle editing-style (unlike SetCheckpointInfo).

unicode Unicode note: checkpoints names are ANSI strings.

When possible, use SetCurrentCheckpointInfo instead of this method.

 

See also methods of TCustomRichView:

GetItemCheckpoint;
SetCheckpointInfo.

See also methods:

SetCurrentCheckpointInfo.

See also properties:

ItemCount.

See also:

Modifying RichView items;
"Checkpoints";
"Tags".


RichView © Sergey Tkachenko