ITextViewLine Interface

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)

public interface ITextViewLine

NameDescription
System_CAPS_pubpropertyBaseline

Gets the distance from the top of the text to the baseline text on the line.

System_CAPS_pubpropertyBottom

Gets the position of the bottom edge of this line in the text rendering coordinate system.

System_CAPS_pubpropertyChange

Gets the change to this rendered textline between the current layout and the previous layout.

System_CAPS_pubpropertyDefaultLineTransform

Gets the default LineTransform used to render this line.

System_CAPS_pubpropertyDeltaY

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.

System_CAPS_pubpropertyEnd

Gets the position of the first character past the end of the line, excluding any line break characters.

System_CAPS_pubpropertyEndIncludingLineBreak

Gets the position of the first character past the end of the line, including any line break characters.

System_CAPS_pubpropertyEndOfLineWidth

Gets the distance from the right edge of the last character in this line to the end of the space of this line.

System_CAPS_pubpropertyExtent

Gets the extent of the line, excluding any line break characters.

System_CAPS_pubpropertyExtentAsMappingSpan

Gets the IMappingSpan that corresponds to the Extent of the line.

System_CAPS_pubpropertyExtentIncludingLineBreak

Gets the extent of the line, including any line break characters.

System_CAPS_pubpropertyExtentIncludingLineBreakAsMappingSpan

Gets the IMappingSpan that corresponds to ExtentIncludingLineBreak.

System_CAPS_pubpropertyHeight

Gets the distance between the top and bottom edge of this line.

System_CAPS_pubpropertyIdentityTag

Gets a tag that can be used to track the identity of an ITextViewLine across layouts in the view.

System_CAPS_pubpropertyIsFirstTextViewLineForSnapshotLine

Determines whether this ITextViewLine is the first line in the list of lines formatted for a particular ITextSnapshotLine.

System_CAPS_pubpropertyIsLastTextViewLineForSnapshotLine

Determines whether this ITextViewLine is the last line in the list of lines formatted for a particular ITextSnapshotLine.

System_CAPS_pubpropertyIsValid

Determines whether this text view line is still valid.

System_CAPS_pubpropertyLeft

Gets the position of the left edge of this line in the text rendering coordinate system.

System_CAPS_pubpropertyLength

Gets the length of the line, excluding any line break characters.

System_CAPS_pubpropertyLengthIncludingLineBreak

Gets the length of the line, including any line break characters.

System_CAPS_pubpropertyLineBreakLength

Gets the length of the line break sequence (for example, "\r\n") that appears at the end of this line.

System_CAPS_pubpropertyLineTransform

Gets the LineTransform used to render this line.

System_CAPS_pubpropertyRight

Gets the position of the right edge of this line in the text rendering coordinate system.

System_CAPS_pubpropertySnapshot

Gets the ITextSnapshot on which this map is based.

System_CAPS_pubpropertyStart

Gets the position in Snapshot of the first character in the line.

System_CAPS_pubpropertyTextBottom

Gets the y-coordinate of the bottom of the text in the rendered line.

System_CAPS_pubpropertyTextHeight

Gets the vertical distance between the top and bottom of the text in the rendered line.

System_CAPS_pubpropertyTextLeft

Gets the x-coordinate of the left edge of the text in the rendered line.

System_CAPS_pubpropertyTextRight

Gets the x-coordinate of the right edge of the text in the rendered line.

System_CAPS_pubpropertyTextTop

Gets the y-coordinate of the top of the text in the rendered line.

System_CAPS_pubpropertyTextWidth

Gets the horizontal distance between TextRight and TextLeft.

System_CAPS_pubpropertyTop

Gets the position of the top edge of this line in the text rendering coordinate system.

System_CAPS_pubpropertyVirtualSpaceWidth

Get the width of the virtual spaces at the end of this line.

System_CAPS_pubpropertyVisibilityState

Gets the visibility state of this rendered text line with respect to the top and bottom of the view.

System_CAPS_pubpropertyWidth

Gets the distance between the left and right edges of this line.

NameDescription
System_CAPS_pubmethodContainsBufferPosition(SnapshotPoint)

Determines whether the specified buffer position lies within this text line.

System_CAPS_pubmethodGetAdornmentBounds(Object)

Calculates the bounds of the specified adornment.

System_CAPS_pubmethodGetAdornmentTags(Object)

Gets the adornments positioned on the line.

System_CAPS_pubmethodGetBufferPositionFromXCoordinate(Double)

Gets the buffer position of the character whose character bounds contains the given x-coordinate.

System_CAPS_pubmethodGetBufferPositionFromXCoordinate(Double, Boolean)

Gets the buffer position of the character whose character bounds contains the given x-coordinate.

System_CAPS_pubmethodGetCharacterBounds(SnapshotPoint)

Calculates the bounds of the character at the specified buffer position.

System_CAPS_pubmethodGetCharacterBounds(VirtualSnapshotPoint)

Calculates the bounds of the character at the specified buffer position.

System_CAPS_pubmethodGetExtendedCharacterBounds(SnapshotPoint)

Calculates the bounds of the character at the specified buffer position, including any adjacent space-negotiating adornments.

System_CAPS_pubmethodGetExtendedCharacterBounds(VirtualSnapshotPoint)

Calculates the bounds of the character at the specified virtual buffer position, including any adjacent space-negotiating adornments.

System_CAPS_pubmethodGetInsertionBufferPositionFromXCoordinate(Double)

Gets the buffer position used if new data were to be inserted at the given x-coordinate.

System_CAPS_pubmethodGetNormalizedTextBounds(SnapshotSpan)

Gets a collection of TextBounds structures for the text that corresponds to the given span.

System_CAPS_pubmethodGetTextElementSpan(SnapshotPoint)

Gets the span whose text element index corresponds to the given buffer position.

System_CAPS_pubmethodGetVirtualBufferPositionFromXCoordinate(Double)

Gets the buffer position of the character whose character bounds contains the given x-coordinate.

System_CAPS_pubmethodIntersectsBufferSpan(SnapshotSpan)

Determines whether a bufferSpan intersects this text line.

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.

Return to top
Show:
© 2016 Microsoft