Метод ITextSelection::EndKey (tom.h)

Статья
08/26/2023

Имитирует функциональные возможности клавиши End.

Синтаксис

HRESULT EndKey(
  long Unit,
  long Extend,
  long *pDelta
);

Параметры

Unit

Тип: long

Единица использования. Это может быть один из следующих вариантов.

Значение	Значение
tomLine	В зависимости от расширения точка вставки или активный конец перемещается в конец последней строки выделения. Это значение по умолчанию.
tomStory	В зависимости от расширения точка вставки или активный конец перемещается в конец последней строки в истории.
tomColumn	В зависимости от расширения точка вставки или активный конец перемещается в конец последнего столбца в выделенном фрагменте. Это доступно, только если подсистема TOM поддерживает таблицы.
tomRow	В зависимости от расширения она перемещает либо точку вставки, либо активный конец в конец последней строки в выделенном фрагменте. Это доступно, только если подсистема TOM поддерживает таблицы.

Extend

Тип: long

Флаг, указывающий, как изменить выделение. Если параметр Extend равен нулю (или tomMove), метод сворачивает выделение до точки вставки. Если параметр Extend имеет значение 1 (или tomExtend), метод перемещает активный конец и оставляет другой. Значение по умолчанию равно нулю.

pDelta

Тип: long*

Указатель на переменную, которая получает количество символов, которые перемещается точка вставки или активный конец. Этот параметр может быть нулевым.

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

Тип: HRESULT

Метод возвращает значение HRESULT . Если метод завершается успешно, он возвращает S_OK. Если метод завершается сбоем, он возвращает один из следующих кодов ошибок. Дополнительные сведения о кодах ошибок COM см. в разделе Обработка ошибок в COM.

Код возврата	Описание
E_INVALIDARG	Единица измерения не является ни tomLine, ни tomStory.
S_FALSE	Сбой по какой-то другой причине.

Параметр Расширить до tomExtend (или ненулевое значение) соответствует нажатию клавиши SHIFT. Если задать для параметра Unit значение tomLine, то клавиша CTRL не нажата. Для параметра Unit для tomStory нажато сочетание клавиш CTRL. Параметры pDelta получают количество символов, перемещаемых точкой вставки или активным концом.

Методы ITextSelection::HomeKey и ITextSelection::EndKey используются для имитации стандартного поведения ключа Home/End.

Значение tomLine имитирует поведение клавиш Home или End без нажатия клавиш CTRL, в то время как tomStory имитирует поведение клавиши CTRL. Аналогичным образом tomMove имитирует поведение клавиш Home или End без нажатия клавиши SHIFT, а tomExtend имитирует поведение клавиши SHIFT. Таким образом EndKey(tomStory) , выделение преобразуется в точку вставки в конце связанной истории, в то время как EndKey(tomStory, tomExtend) активный конец выделенного фрагмента перемещается в конец истории и оставляет другой конец, где он был.

Методы HomeKey и EndKey — это логические методы, такие как методы Move* , а не направленные методы. Таким образом, они зависят от языка, который используется. Например, в арабском тексте HomeKey перемещается в правый конец строки, а в тексте на английском языке — влево. Таким образом, HomeKey и EndKey отличаются от методов MoveLeft и MoveRight . Кроме того, обратите внимание, что метод EndKey сильно отличается от свойства End , которое находится cp в конце выделенного фрагмента. HomeKey и EndKey также отличаются от методов StartOf и EndOf тем, что они простираются от активного конца, в то время как StartOf расширяется с Start, а EndOf — с end.

Требования


Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	tom.h
DLL	Msftedit.dll