TextBoxBase.GetFirstCharIndexFromLine Method (Int32)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves the index of the first character of a given line.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public int GetFirstCharIndexFromLine(
	int lineNumber


Type: System.Int32

The line for which to get the index of its first character.

Return Value

Type: System.Int32

The zero-based index of the first character in the specified line.

Exception Condition

The value of the lineNumber parameter is less than zero.

Line numbering in the text box starts at zero. If the lineNumber parameter is greater than the last line in the text box, GetFirstCharIndexFromLine returns -1.

GetFirstCharIndexFromLine returns the first character index of a physical line. The physical line is the displayed line, not the assigned line. The number of displayed lines can be greater than the number of assigned lines due to word wrap. For example, if you assign two long lines to a RichTextBox control and set Multiline and WordWrap to true, the two long assigned lines result in four physical (or displayed lines).

.NET Framework
Available since 2.0
Return to top