TextBoxBase.GetLineFromCharIndex(Int32) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 -> intPublic Overridable Function GetLineFromCharIndex (index As Integer) As IntegerParameters
- index
- Int32
The character index position to search.
Returns
The zero-based line number in which the character index is located.
Remarks
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.
Note
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.
