TextBoxBase.GetLineFromCharIndex(Int32) メソッド

定義

コントロールのテキスト内で、指定の文字位置からの行数を取得します。Retrieves the line number from the specified character position within the text of the control.

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

検索する文字インデックスの位置。The character index position to search.

戻り値

文字インデックスを含む行の 0 から始まる行番号。The zero-based line number in which the character index is located.

注釈

このメソッドを使用すると、メソッドのindexパラメーターに指定された文字インデックスに基づいて行番号を決定できます。This method enables you to determine the line number based on the character index specified in the index parameter of the method. コントロールのテキストの最初の行は、値0を返します。The first line of text in the control returns the value zero. メソッドGetLineFromCharIndexは、インデックス付き文字がコントロール内に配置されている物理的な行番号を返します。The GetLineFromCharIndex method returns the physical line number where the indexed character is located within the control. たとえば、コントロール内のテキストの最初の論理行の部分が次の行に折り返される場合、メソッドGetLineFromCharIndexは、指定した文字インデックス位置にある文字が2番目の物理行にラップされている場合、1を返します。For example, if a portion of the first logical line of text in the control wraps to the next line, the GetLineFromCharIndex method returns 1 if the character at the specified character index has wrapped to the second physical line. WordWrapfalse設定されている場合、行の一部は次の行に折り返されず、メソッドは指定された文字インデックスに対して0を返します。If WordWrap is set to false, no portion of the line wraps to the next, and the method returns 0 for the specified character index. このメソッドを使用すると、特定の文字インデックスが含まれている行を特定できます。You can use this method to determine which line a specific character index is located within. たとえば、 Findメソッドを呼び出してテキストを検索した後、検索結果が見つかる場所の文字インデックスを取得できます。For example, after calling the Find method to search for text, you can obtain the character index to where the search results are found. Findメソッドによって返された文字インデックスを使用してこのメソッドを呼び出し、単語が見つかった行を特定できます。You can call this method with the character index returned by the Find method to determine which line the word was found.

注意

indexパラメーターで指定された文字インデックスが、コントロール内に含まれる使用可能な行数を超えている場合は、最後の行番号が返されます。If the character index specified in the index parameter is beyond the available number of lines contained within the control, the last line number is returned.

適用対象

こちらもご覧ください