TCustomRichViewEdit.InsertCheckpoint

<< Нажмите, чтобы показать Содержание >>

TCustomRichViewEdit.InsertCheckpoint

Добавляет закладку в позицию каретки.

function InsertCheckpoint(const ATag: TRVTag;

  const AName: TRVUnicodeString;

  ARaiseEvent: Boolean): Boolean;

Этот метод похож на SetCurrentCheckpointInfo, но добавляет закладку точно в позицию каретки.

Если каретка находится в начале элемента документа, этот метод вызывает SetCheckpointInfoEd для добавления закладки к данному элементу.

Если каретка находится в середине текстового элемента, метод разделяет этот элемент в позиции каретки и вызывает SetCheckpointInfoEd для добавления закладки к элементу, расположенному справа.

Если каретка находится в конце абзаца, метод перемещает её в начало следующего абзаца и вызывает SetCheckpointInfoEd для добавления закладки к первому элементу абзаца (или ко второму элементу, если первый является маркером списка).

Если каретка находится в конце документа, метод не выполняет никаких действий.

Этот метод используется совместно с методами GetCheckpointAtCaret и RemoveCheckpointAtCaret. Методы GetCurrentCheckpoint и RemoveCurrentCheckpoint в данном случае использовать нельзя, поскольку закладка, добавленная этим методом, не обязательно принадлежит текущему элементу (обычно текущим является элемент слева от каретки).

Параметры:

ATag тег закладки.

AName имя закладки. Не должно содержать символов #00, #01 и #02.

ARaiseEvent флажок генерации события, см. OnCheckpointVisible

Тип метода: editstyle редактирование документа

Возвращаемое значение:

True, если закладка была добавлена (добавление может быть неуспешным из-за защиты документа, режима только для чтения, или если каретка в конце документа).

См. также:

Изменение свойств элементов документа;

Закладки;

Теги.