ITextViewLine Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Formatting

Assembly:: Microsoft.VisualStudio.Text.UI.dll

Package:: Microsoft.VisualStudio.Text.UI v17.11.260

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.

Represents text that has been formatted for display in a text view.

public interface class ITextViewLine

public interface class ITextViewLine

__interface ITextViewLine

public interface ITextViewLine

type ITextViewLine = interface

Public Interface ITextViewLine

Derived: Microsoft.VisualStudio.Text.Formatting.IFormattedLine

Microsoft.VisualStudio.Text.Formatting.IWpfTextViewLine

Remarks

Most properties and parameters that are doubles correspond to coordinates or distances in the text rendering coordinate system. In this coordinate system, x = 0.0 corresponds to the left edge of the drawing surface onto which text is rendered (x = view.ViewportLeft corresponds to the left edge of the viewport), and y = view.ViewportTop corresponds to the top edge of the viewport. The x-coordinate increases from left to right, and the y-coordinate increases from top to bottom.

The horizontal and vertical axes of the view behave differently. When the text in the view is formatted, only the visible lines are formatted. As a result, a viewport cannot be scrolled horizontally and vertically in the same way.

A viewport is scrolled horizontally by changing the left coordinate of the viewport so that it moves with respect to the drawing surface.

A view can be scrolled vertically only by performing a new layout.

Doing a layout in the view may cause the ViewportTop property of the view to change. For example, scrolling down one line will not translate any of the visible lines. Instead it will simply change the view's ViewportTop property (causing the lines to move on the screen even though their y-coordinates have not changed).

Distances in the text rendering coordinate system correspond to logical pixels. If the text rendering surface is displayed without any scaling transform, then 1 unit in the text rendering coordinate system corresponds to one pixel on the display.

Properties

Baseline	Gets the distance from the top of the text to the baseline text on the line.
Bottom	Gets the position of the bottom edge of this line in the text rendering coordinate system.
Change	Gets the change to this rendered textline between the current layout and the previous layout.
DefaultLineTransform	Gets the default LineTransform used to render this line.
DeltaY	Gets the change in the top of this rendered textline between between the value of Top in the current layout and the value of Top in the previous layout.
End	Gets the position of the first character past the end of the line, excluding any line break characters. In most cases this property references a line break character, except for the last line in the buffer, in which case it contains a position past the end of the buffer.
EndIncludingLineBreak	Gets the position of the first character past the end of the line, including any line break characters In most cases this property references the first character in the following line, unless this is the last line, in which case it contains a position past the end of the buffer.
EndOfLineWidth	Gets the distance from the right edge of the last character in this line to the end of the space of this line. This may include padding for line break characters or for end of file characters.
Extent	Gets the extent of the line, excluding any line break characters.
ExtentAsMappingSpan	Gets the IMappingSpan that corresponds to the Extent of the line.
ExtentIncludingLineBreak	Gets the extent of the line, including any line break characters.
ExtentIncludingLineBreakAsMappingSpan	Gets the IMappingSpan that corresponds to ExtentIncludingLineBreak.
Height	Gets the distance between the top and bottom edge of this line.
IdentityTag	Gets a tag that can be used to track the identity of an ITextViewLine across layouts in the view.
IsFirstTextViewLineForSnapshotLine	Determines whether this ITextViewLine is the first line in the list of lines formatted for a particular ITextSnapshotLine.
IsLastTextViewLineForSnapshotLine	Determines whether this ITextViewLine is the last line in the list of lines formatted for a particular ITextSnapshotLine.
IsValid	Determines whether this text view line is still valid.
Left	Gets the position of the left edge of this line in the text rendering coordinate system.
Length	Gets the length of the line, excluding any line break characters.
LengthIncludingLineBreak	Gets the length of the line, including any line break characters.
LineBreakLength	Gets the length of the line break sequence (for example, "\r\n") that appears at the end of this line.
LineTransform	Gets the LineTransform used to render this line.
Right	Gets the position of the right edge of this line in the text rendering coordinate system.
Snapshot	Gets the ITextSnapshot on which this map is based.
Start	Gets the position in Snapshot of the first character in the line.
TextBottom	Gets the y-coordinate of the bottom of the text in the rendered line.
TextHeight	Gets the vertical distance between the top and bottom of the text in the rendered line.
TextLeft	Gets the x-coordinate of the left edge of the text in the rendered line.
TextRight	Gets the x-coordinate of the right edge of the text in the rendered line.
TextTop	Gets the y-coordinate of the top of the text in the rendered line.
TextWidth	Gets the horizontal distance between TextRight and TextLeft.
Top	Gets the position of the top edge of this line in the text rendering coordinate system.
VirtualSpaceWidth	Get the width of the virtual spaces at the end of this line.
VisibilityState	Gets the visibility state of this rendered text line with respect to the top and bottom of the view.
Width	Gets the distance between the left and right edges of this line.

Methods

ContainsBufferPosition(SnapshotPoint)	Determines whether the specified buffer position lies within this text line.
GetAdornmentBounds(Object)	Calculates the bounds of the specified adornment.
GetAdornmentTags(Object)	Gets the adornments positioned on the line.
GetBufferPositionFromXCoordinate(Double, Boolean)	Gets the buffer position of the character whose character bounds contains the given x-coordinate.
GetBufferPositionFromXCoordinate(Double)	Gets the buffer position of the character whose character bounds contains the given x-coordinate.
GetCharacterBounds(SnapshotPoint)	Calculates the bounds of the character at the specified buffer position.
GetCharacterBounds(VirtualSnapshotPoint)	Calculates the bounds of the character at the specified buffer position.
GetExtendedCharacterBounds(SnapshotPoint)	Calculates the bounds of the character at the specified buffer position, including any adjacent space-negotiating adornments.
GetExtendedCharacterBounds(VirtualSnapshotPoint)	Calculates the bounds of the character at the specified virtual buffer position, including any adjacent space-negotiating adornments.
GetInsertionBufferPositionFromXCoordinate(Double)	Gets the buffer position used if new data were to be inserted at the given x-coordinate.
GetNormalizedTextBounds(SnapshotSpan)	Gets a collection of TextBounds structures for the text that corresponds to the given span.
GetTextElementSpan(SnapshotPoint)	Gets the span whose text elementindex corresponds to the given buffer position.
GetVirtualBufferPositionFromXCoordinate(Double)	Gets the buffer position of the character whose character bounds contains the given x-coordinate.
IntersectsBufferSpan(SnapshotSpan)	Determines whether a `bufferSpan` intersects this text line.

Applies to

Share via