GetCharIndexFromPosition メソッド (GcTextBox)

指定した位置の一番近くにある文字のインデックスを取得します。

構文

Public Overridable Function GetCharIndexFromPosition( _
   ByVal point As Point _
) As Integer

public virtual int GetCharIndexFromPosition( 
   Point point
)

指定した位置の0から始まる文字インデックスを表すInt32値。

解説

pointパラメータに指定した位置の一番近くにある文字のインデックスを返します。文字のインデックスは、コントロール内のテキスト (空白を含む) の 0 から始まるインデックスです。

pointパラメータに指定した位置がコントロールのクライアント領域上にある場合は、インデックス値が返されます。

pointパラメータに指定した位置がコントロールのクライアント領域外にある場合は、-1が返されます。

このメソッドを使用し、マウスの位置座標をこのメソッドに渡すことによって、ユーザーがテキスト内でマウスを配置している位置を判断できます。これは、ユーザーがコントロールのテキスト内の単語にマウスポインタを配置したときにタスクを実行する場合などに役立ちます。

近くにある文字を取得するには、 GetCharFromPosition メソッドを使用します。

参照