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; const ATag: TRVTag;

  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, activate inplace-editor, select the proper item in the cell (SelSelectionBounds), and call SetCheckpointInfoEd of this inplace-editor. Alternatively, you can use SetCurrentCheckpointInfo.

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 (unlike SetCheckpointInfo).

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.

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


TRichView © trichview.com