System.Windows.Forms.TextBoxBase.GetFirstCharIndexFromLine Method

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

Syntax

public int GetFirstCharIndexFromLine (int lineNumber)

Parameters

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

Returns

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

Remarks

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

TextBoxBase.GetFirstCharIndexFromLine(int) 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 System.Windows.Forms.RichTextBox control and set TextBoxBase.Multiline and TextBoxBase.WordWrap to true, the two long assigned lines result in four physical (or displayed lines).

Requirements

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