Share via


ITextViewLine Interface

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

Namespace:  Microsoft.VisualStudio.Text.Formatting
Assembly:  Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)

Syntax

'Declaration
Public Interface ITextViewLine
public interface ITextViewLine
public interface class ITextViewLine
type ITextViewLine =  interface end
public interface ITextViewLine

The ITextViewLine type exposes the following members.

Properties

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

Top

Methods

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

Top

Remarks

For information about formatting, see the "Formatted Text" section of Inside the Editor.

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.

See Also

Reference

Microsoft.VisualStudio.Text.Formatting Namespace