<< Click to display table of contents >> TCustomRichViewEdit.GetCheckpointAtCaret |
Returns checkpoint at the position of caret.
function GetCheckpointAtCaret: TCheckpointData;
(introduced in version 10)
This method returns checkpoint only if the caret is at the beginning of item, otherwise it returns nil.
The following table compares this method with GetCurrentCheckpoint.
Caret Position |
GetCheckpointAtCaret |
|
---|---|---|
In the middle of text item |
returns nil |
returns checkpoint for this item |
At the beginning of item and at the beginning of line |
returns checkpoint for this item |
returns checkpoint for this item |
At the beginning of item and in the middle of line |
returns checkpoint for this item |
returns checkpoint for the previous item |
At the end of item and at the end of line |
returns nil |
returns checkpoint for this item |
This method is used in conjunction with InsertCheckpoint and RemoveCheckpointAtCaret. The alternative set of methods is: SetCurrentCheckpointInfo, GetCurrentCheckpoint and RemoveCurrentCheckpoint.
See also: