GetLineFromCharIndex メソッド

コントロールのテキスト内の指定した文字位置から行番号を取得します。

構文

Visual Basic
C#

'Declaration
 
Public Overridable Function GetLineFromCharIndex( _
   ByVal index As Integer _
) As Integer

public virtual int GetLineFromCharIndex( 
   int index
)

パラメータ

index: 検索する文字インデックスの位置を表すInt32値。

戻り値の型

文字インデックスを含む行の0から始まる行番号を表すInt32値。

解説

このメソッドを使用すると、メソッドのindexパラメータで指定された文字インデックスに基づいて行番号を決定できます。コントロールのテキストの最初の行は、0を返します。 GetLineFromCharIndexメソッドは、インデックス付き文字がコントロール内にある物理的な行番号を返します。

たとえば、コントロールのテキストの最初の論理行の一部が次の行に折り返される場合、指定された文字インデックスの文字が2番目の物理行に折り返されると、GetLineFromCharIndexメソッドは1を返します。 WordWrapがfalseに設定されている場合、行のどの部分も次の行に折り返されることはなく、メソッドは指定された文字インデックスに対して0を返します。

このメソッドを使用して、特定の文字インデックスがどの行にあるかを判別できます。たとえば、Findメソッドを呼び出してテキストを検索した後、検索結果が見つかった場所への文字インデックスを取得できます。 Findメソッドによって返された文字インデックスを使用してこのメソッドを呼び出し、単語が見つかった行を判別できます。

参照

GcTextBox クラス
 GcTextBox メンバ