TXTextControl.Line Class

An instance of the Line class represents a single line in a Text Control document.

Introduced: 10.1.

Syntax

[C#]
public class Line
[Visual Basic]
Public Class Line

Properties

Property Description
Baseline Gets the line's baseline position.
Length Gets the number of characters in the line including the break character.
Number Gets the line's number.
Page Gets the number of the page to which the line belongs.
Start Gets the number (one-based) of the first character in the line.
Text Gets the line's text.
TextBounds Gets the bounding rectangle of the text belonging to the line.

Methods

Method Description
Save Overloaded. Saves the line's text with the specified format.

Example

The following example shows how to read the document line by line.

[C#]
textControl1.Text = "Line 1\nLine 2\nLine 3";

foreach (TXTextControl.Line line in textControl1.Lines)
{
	Console.WriteLine("Line #" + line.Number.ToString() + " starts at: " +
		line.Start.ToString() + ". Text: " + line.Text);
}
[Visual Basic]
TextControl1.Text = "Line 1" + vbCrLf + "Line 2" + vbCrLf + "Line 3"

For Each line As TXTextControl.Line In TextControl1.Lines
    Console.WriteLine("Line #" + line.Number.ToString() + " starts at: " + _
            line.Start.ToString() + ". Text: " + line.Text)
Next

See Also