ITextSelection：：HomeKey 方法 (tom.h)

發行項
03/13/2024

一般化 Home 鍵的功能。

語法

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

參數

Unit

類型： long

主鍵作業中使用的單位。它可以採用下列其中一個值。

值	意義
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 中的錯誤處理。

傳回碼	Description
E_INVALIDARG	Unit 不是 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 屬性相當不同，這是選取範圍開頭的 cp。 HomeKey 和 EndKey 也不同於 StartOf 和 EndOf 方法，因為它們會從使用中端延伸，而 StartOf 則從 Start 和 EndOf 延伸。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	tom.h
Dll	Msftedit.dll