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

'Usage
 
Dim instance As GcTextBoxEditingControl
Dim index As Integer
Dim value As Integer
 
value = instance.GetLineFromCharIndex(index)

public virtual int GetLineFromCharIndex( 
   int index
)

Parameters

index

The character index position to search

Return Value

This method enables you to determine the line number based on the character index specified in the index parameter of the method. The first line of text in the control returns the value zero. The GetLineFromCharIndex method returns the physical line number where the indexed character is located within the control.

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. 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. For example, after calling the Find method to search for text, you can obtain the character index to where the search results are found. You can call this method with the character index returned by the Find method to determine which line the word was found.

Reference

GcTextBoxEditingControl Class
GcTextBoxEditingControl Members