TextBoxBase.GetLineFromCharIndex(Int32) メソッド

  • リファレンス

定義

名前空間:
System.Windows.Forms
アセンブリ:
System.Windows.Forms.dll

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

public:
 virtual int GetLineFromCharIndex(int index);
public virtual int GetLineFromCharIndex (int index);
abstract member GetLineFromCharIndex : int -> int
override this.GetLineFromCharIndex : int -> int
Public Overridable Function GetLineFromCharIndex (index As Integer) As Integer

パラメーター

index
Int32

検索する文字インデックスの位置。

戻り値

Int32

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

注釈

このメソッドを使用すると、 メソッドの パラメーターで指定された文字インデックスに基づいて行番号を index 決定できます。 コントロール内のテキストの最初の行は、値 0 を返します。 メソッドは GetLineFromCharIndex 、インデックス付き文字がコントロール内にある物理行番号を返します。 たとえば、コントロール内のテキストの最初の論理行の一部が次の行に折り返された場合、 GetLineFromCharIndex 指定した文字インデックスの文字が 2 番目の物理行にラップされている場合、メソッドは 1 を返します。 が にfalse設定されている場合WordWrap、行の一部は次の行に折り返されません。メソッドは、指定した文字インデックスに対して 0 を返します。 このメソッドを使用すると、特定の文字インデックスがどの行内にあるかを判断できます。 たとえば、 メソッドを Find 呼び出してテキストを検索した後、検索結果が見つかった場所の文字インデックスを取得できます。 このメソッドは、 メソッドによって Find 返される文字インデックスを使用して呼び出して、単語が見つかった行を特定できます。

注意

パラメーターで index 指定された文字インデックスが、コントロール内に含まれる使用可能な行数を超えている場合は、最後の行番号が返されます。

適用対象

こちらもご覧ください