ITextSelection::HomeKey メソッド (tom.h)
ホーム キーの機能を一般化します。
構文
HRESULT HomeKey(
long Unit,
long Extend,
long *pDelta
);
パラメーター
Unit
型: long
ホーム キー操作で使用するユニット。 次のいずれかの値を受け取ることができます。
Extend
型: long
選択範囲を変更する方法を示すフラグ。 Extend が 0 (または tomMove) の場合、 メソッドは選択範囲を挿入ポイントまで折りたたみます。 Extend が 1 (または tomExtend) の場合、メソッドはアクティブな終了を移動し、もう一方の端だけを残します。 既定値はゼロです。
pDelta
種類: long*
挿入ポイントまたはアクティブな末尾が移動される文字数を受け取る変数へのポインター。 このパラメーターには、null を指定できます。
戻り値
種類: HRESULT
メソッドは HRESULT 値を返します。 メソッドが成功すると、 S_OKが返されます。 メソッドが失敗した場合は、次のいずれかのエラー コードが返されます。 COM エラー コードの詳細については、「COM でのエラー処理」を参照してください。
| リターン コード | 説明 |
|---|---|
|
Unit は tomLine でも tomStory でもありません。 |
|
何らかの理由で失敗しました。 |
注釈
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 メソッドは、選択範囲の先頭にある cp である Start プロパティとは大きく異なります。 HomeKey と EndKey は 、StartOf メソッドと EndOf メソッドとは異なり、アクティブな終了から拡張されるのに対し、 StartOf は Start から拡張され 、EndOf は End から拡張されます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | tom.h |
| [DLL] | Msftedit.dll |
関連項目
概念
リファレンス