RichTextBox.GetLineFromCharIndex(Int32) メソッド

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

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

public:
 override int GetLineFromCharIndex(int index);

public override int GetLineFromCharIndex (int index);

override this.GetLineFromCharIndex : int -> int

Public Overrides Function GetLineFromCharIndex (index As Integer) As Integer

パラメーター

index

Int32

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

戻り値

Int32

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

例

次のコード例では、 メソッドの使用方法を GetLineFromCharIndex 示します。 この例を実行するには、 という名前のコントロール、という名前のボタンButton1、および と という名前RichTextBox1の 2 つのテキスト ボックスTextBox1TextBox2を含むRichTextBoxフォームに、次のコードを貼り付けます。 この例が実行されている場合は、 に TextBox2 検索文字列を入力し、 ボタンをクリックして検索結果を取得します。

// This method demonstrates retrieving line numbers that 
// indicate the location of a particular word
// contained in a RichTextBox. The line numbers are zero-based.
void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Reset the results box.
   TextBox1->Text = "";
   
   // Get the word to search from from TextBox2.
   String^ searchWord = TextBox2->Text;
   int index = 0;
   
   //Declare an ArrayList to store line numbers.
   System::Collections::ArrayList^ lineList = gcnew System::Collections::ArrayList;
   do
   {
      // Find occurrences of the search word, incrementing  
      // the start index. 
      index = RichTextBox1->Find( searchWord, index + 1, RichTextBoxFinds::MatchCase );
      if ( index != -1 )
      {
         lineList->Add( RichTextBox1->GetLineFromCharIndex( index ) );
      }
   }
   while ( (index != -1) );

   // Iterate through the list and display the line numbers in TextBox1.
   System::Collections::IEnumerator^ myEnumerator = lineList->GetEnumerator();
   if ( lineList->Count <= 0 )
   {
      TextBox1->Text = searchWord + " was not found";
   }
   else
   {
      TextBox1->SelectedText = searchWord + " was found on line(s):";
      while ( myEnumerator->MoveNext() )
      {
         TextBox1->SelectedText = myEnumerator->Current + " ";
      }
   }
}

// This method demonstrates retrieving line numbers that 
// indicate the location of a particular word
// contained in a RichTextBox. The line numbers are zero-based.

private void Button1_Click(System.Object sender, System.EventArgs e)
{

    // Reset the results box.
    TextBox1.Text = "";

    // Get the word to search from from TextBox2.
    string searchWord = TextBox2.Text;

    int index = 0;

    //Declare an ArrayList to store line numbers.
    System.Collections.ArrayList lineList = new System.Collections.ArrayList();
    do
    {
        // Find occurrences of the search word, incrementing  
        // the start index. 
        index = RichTextBox1.Find(searchWord, index+1, RichTextBoxFinds.MatchCase);
        if (index!=-1)

            // Find the word's line number and add the line 
            // number to the arrayList. 
        {
            lineList.Add(RichTextBox1.GetLineFromCharIndex(index));
        }
    }
    while((index!=-1));

    // Iterate through the list and display the line numbers in TextBox1.
    System.Collections.IEnumerator myEnumerator = lineList.GetEnumerator();
    if (lineList.Count<=0)
    {
        TextBox1.Text = searchWord+" was not found";
    }
    else
    {
        TextBox1.SelectedText = searchWord+" was found on line(s):";
        while (myEnumerator.MoveNext())
        {
            TextBox1.SelectedText = myEnumerator.Current+" ";
        }
    }
}

' This method demonstrates retrieving line numbers that 
' indicate the location of a particular word
' contained in a RichTextBox. The line numbers are zero-based.

Private Sub Button1_Click(ByVal sender As System.Object, _ 
    ByVal e As System.EventArgs) Handles Button1.Click

    ' Reset the results box.
    TextBox1.Text = ""

    ' Get the word to search from from TextBox2.
    Dim searchWord As String = TextBox2.Text

    Dim index As Integer = 0

    'Declare an ArrayList to store line numbers.
    Dim lineList As New System.Collections.ArrayList
    Do
        ' Find occurrences of the search word, incrementing  
        ' the start index. 
        index = RichTextBox1.Find(searchWord, index + 1, _
            RichTextBoxFinds.MatchCase)
        If (index <> -1) Then

            ' Find the word's line number and add the line 
            'number to the arrayList. 
            lineList.Add(RichTextBox1.GetLineFromCharIndex(index))
        End If
    Loop While (index <> -1)

    ' Iterate through the list and display the line numbers in TextBox1.
    Dim myEnumerator As System.Collections.IEnumerator = _
        lineList.GetEnumerator()
    If lineList.Count <= 0 Then
        TextBox1.Text = searchWord & " was not found"
    Else
        TextBox1.SelectedText = searchWord & " was found on line(s):"
        While (myEnumerator.MoveNext)
            TextBox1.SelectedText = myEnumerator.Current & " "
        End While
    End If

End Sub

注釈

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

場合によっては、 GetLineFromCharIndex パラメーターが無効な値の場合に index 例外をスローしません。 次に例を示します。

• パラメーターが indexMinValue または -1 の場合、 GetLineFromCharIndex 0 を返します。

• パラメーターがindexテキストの長さまたは MaxValueのGetLineFromCharIndex場合は、プロパティの値WordWrapに応じて、テキストの最後の行の数を返します。必ずしも とLines.Length-1同じではありません。

このような場合は、 を呼び出す GetLineFromCharIndex前に入力を検証します。

注意

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

こちらもご覧ください

• GetCharIndexFromPosition(Point)
• GetPositionFromCharIndex(Int32)