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

Статья
03/09/2024

Обобщает функциональные возможности ключа Home.

Синтаксис

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

Параметры

Unit

Тип: long

Единица измерения для использования в операции с ключом Home. Он может принимать одно из следующих значений.

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

Extend

Тип: long

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

pDelta

Тип: long*

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

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

Тип: HRESULT

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

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

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

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

Требования

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