iTextSelection：：HomeKey 方法 (tom.h)

项目
03/13/2024

通用化 Home 键的功能。

语法

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

参数

Unit

类型： long

在 Home 键操作中使用的单位。它可以采用以下值之一。

值	含义
tomLine	根据 Extend，它会将插入点或活动端移动到所选内容中第一行的开头。这是默认值。
tomStory	根据 Extend，它将插入点或活动端移动到文章中第一行的开头。
tomColumn	根据 Extend，它会将插入点或活动端移到所选内容中第一列的开头。仅当 TOM 引擎支持表时，这才可用。
tomRow	根据 Extend，它会将插入点或活动端移到所选内容中第一行的开头。仅当 TOM 引擎支持表时，这才可用。

Extend

类型： long

指示如何更改所选内容的标志。如果 Extend 为零 (或 tomMove) ，该方法会将所选内容折叠到插入点。如果 Extend 为 1 (或 tomExtend) ，该方法将移动活动端并单独保留另一端。默认值为零。

pDelta

类型： long*

指向变量的指针，该变量接收插入点或活动端移动的字符计数。此参数可以为 null。

返回值

类型： HRESULT

方法返回 HRESULT 值。如果该方法成功，则返回 S_OK。如果方法失败，它将返回以下错误代码之一。有关 COM 错误代码的详细信息，请参阅 COM 中的错误处理。

返回代码	说明
E_INVALIDARG	单位既不是 tomLine 也不是 tomStory。
S_FALSE	由于其他原因而失败。

注解

ITextSelection：：HomeKey 和 ITextSelection：：EndKey 方法用于模拟标准 Home/End 键行为。

tomLine 模拟不按 Ctrl 键的 Home 或 End 键行为，而 tomStory 则模拟按下 Ctrl 键的行为。 同样，tomMove 在未按下 Shift 键的情况下模拟 Home 或 End 键行为，而 tomExtend 模拟按下 Shift 键的行为。 因此 HomeKey(tomStory) ，将所选内容转换为关联文章开头的插入点，而 HomeKey (tomStory，tomExtend) 将所选内容的活动结尾移动到故事的开头，并将另一端保留在其所在位置。

HomeKey 和 EndKey 方法是逻辑方法（如 Move 方法），而不是方向方法。因此，它们依赖于所涉及的语言。例如，在阿拉伯语文本中， HomeKey 将移动到行的右端，而在英语文本中，它将向左移动。因此， HomeKey 和 EndKey 方法不同于 ITextSelection：：MoveLeft 和 ITextSelection：：MoveRight 方法。另请注意， HomeKey 方法与 Start 属性大不相同，Start 属性是所选内容开头的 cp。 HomeKey 和 EndKey 也不同于 StartOf 和 EndOf 方法，因为它们从活动端扩展，而 StartOf 从 Start 扩展， EndOf 从 End 扩展。

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2003 [仅限桌面应用]
目标平台	Windows
标头	tom.h
DLL	Msftedit.dll