TextImageLine Struct
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.
Immutable information about a line of text from an ITextImage.
public value class TextImageLine : IEquatable<Microsoft::VisualStudio::Text::TextImageLine>
public struct TextImageLine : IEquatable<Microsoft.VisualStudio.Text.TextImageLine>
type TextImageLine = struct
Public Structure TextImageLine
Implements IEquatable(Of TextImageLine)
- Inheritance
-
TextImageLine
- Implements
Constructors
TextImageLine(ITextImage, Int32, Span, Int32) |
Fields
Extent |
The extent of the line, excluding any line break characters. |
Image |
The ITextImage in which the line appears. |
Invalid | |
LineBreakLength |
Length of line break characters (always falls in the range [0..2]). |
LineNumber |
The 0-origin line number of the line. |
Properties
End |
The position 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 position 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). |
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. |
Start |
The position of the first character in the line. |
Methods
Equals(Object) | |
Equals(TextImageLine) | |
GetHashCode() | |
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. |
ToString() |
Operators
Equality(TextImageLine, TextImageLine) | |
Inequality(TextImageLine, TextImageLine) |