ITextSnapshotLine Interface

Definition

Namespace:

Microsoft.VisualStudio.Text

Assembly:

Microsoft.VisualStudio.Text.Data.dll

Package:

Microsoft.VisualStudio.Text.Data v17.12.215

Immutable information about a line of text from an ITextSnapshot.

public interface class ITextSnapshotLine

public interface class ITextSnapshotLine

__interface ITextSnapshotLine

public interface ITextSnapshotLine

type ITextSnapshotLine = interface

Public Interface ITextSnapshotLine

Remarks

For more information about text snapshot lines, see the section "A Closer Look at the Text Model and the Text View" in Inside the Editor.

This object is immutable.

Properties

End	The SnapshotPoint of the first character past the end of the line, excluding any line break characters (thus will address a line break character, except for the last line in the buffer, in which case it addresses a position past the end of the buffer).
EndIncludingLineBreak	The SnapshotPoint of the first character past the end of the line, including any line break characters (thus will address the first character in the succeeding line, unless this is the last line, in which case it addresses a position past the end of the buffer).
Extent	The extent of the line, excluding any line break characters.
ExtentIncludingLineBreak	The extent of the line, including any line break characters.
Length	Length of the line, excluding any line break characters.
LengthIncludingLineBreak	Length of the line, including any line break characters.
LineBreakLength	Length of line break characters (always falls in the range [0..2]).
LineNumber	The 0-origin line number of the line.
Snapshot	The ITextSnapshot in which the line appears.
Start	The SnapshotPoint of the first character in the line.

Methods

GetLineBreakText()	The string consisting of the line break characters (if any) at the end of the line. Has zero length for the last line in the buffer.
GetText()	The text of the line, excluding any line break characters.
GetTextIncludingLineBreak()	The text of the line, including any line break characters.