rvico TRichView Reference | TRichView

TCustomRichView.SetCheckpointInfo

Top  Previous  Next

Creates a new checkpoint or modifies the existing checkpoint associated with the ItemNo-th item

procedure SetCheckpointInfo(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, use Cell.GetRVData.SetCheckpointInfo. If this item already has a checkpoint, its properties are modified; otherwise, a new checkpoint is created.

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: viewerstyle viewer-style. It's not necessary to reformat document after it, repainting is enough (repainting is needed if rvoShowCheckpoints in Options).

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:

GetItemCheckpoint;

RemoveCheckpoint.

See also properties:

ItemCount.

See also methods of RichViewEdit:

SetCheckpointInfoEd;

SetCurrentCheckpointInfo.

See also:

Modifying RichView items;

Checkpoints;

Tags.


TRichView © trichview.com