TextBoxBase.GetLineFromCharIndex メソッド

.NET Framework クラス ライブラリ リファレンス

TextBoxBase.GetLineFromCharIndex メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 GetLineFromCharIndex ( _
    index As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As TextBoxBase
Dim index As Integer
Dim returnValue As Integer

returnValue = instance.GetLineFromCharIndex(index)

C#

public virtual int GetLineFromCharIndex (
    int index
)

C++

public:
virtual int GetLineFromCharIndex (
    int index
)

J#

public int GetLineFromCharIndex (
    int index
)

JScript

public function GetLineFromCharIndex (
    index : int
) : int

パラメータ

index

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

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

解説

このメソッドを使用すると、その index パラメータに指定した文字インデックスを基に行番号を確認できます。コントロール内のテキストの最初の行は、値 0 を返します。GetLineFromCharIndex メソッドは、コントロール内でインデックス付き文字が検索された物理的な行番号を返します。たとえば、コントロール内のテキストの最初の論理行の一部が次の行に折り返している場合、指定したインデックス位置にある文字が 2 番目の物理行に折り返していれば、GetLineFromCharIndex メソッドは 1 を返します。WordWrap が false に設定されている場合は、行のどの部分も次行には折り返さず、このメソッドは指定した文字インデックスに対して 0 を返します。このメソッドを使用して、特定の文字インデックスが含まれている行を確認できます。たとえば、Find メソッドを呼び出してテキストを検索し、文字が見つかった位置の文字インデックスを取得できます。Find メソッドで返された文字インデックスを指定してこのメソッドを呼び出すと、文字がどの行で見つかったのかを確認できます。

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
TextBoxBase クラス
TextBoxBase メンバ
System.Windows.Forms 名前空間
GetCharIndexFromPosition
GetCharFromPosition
GetPositionFromCharIndex
GetFirstCharIndexFromLine