This topic has not yet been rated - Rate this topic

IWpfTextViewLine Interface

Represents a line of rendered text in the ITextView.

Namespace:  Microsoft.VisualStudio.Text.Formatting
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)
public interface IWpfTextViewLine : ITextViewLine

The IWpfTextViewLine type exposes the following members.

  NameDescription
Public propertyBaselineGets the distance from the top of the text to the baseline text on the line. (Inherited from ITextViewLine.)
Public propertyBottomGets the position of the bottom edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.)
Public propertyChangeGets the change to this rendered textline between the current layout and the previous layout. (Inherited from ITextViewLine.)
Public propertyDefaultLineTransformGets the default LineTransform used to render this line. (Inherited from ITextViewLine.)
Public propertyDeltaYGets 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. (Inherited from ITextViewLine.)
Public propertyEndGets the position of the first character past the end of the line, excluding any line break characters. (Inherited from ITextViewLine.)
Public propertyEndIncludingLineBreakGets the position of the first character past the end of the line, including any line break characters. (Inherited from ITextViewLine.)
Public propertyEndOfLineWidthGets the distance from the right edge of the last character in this line to the end of the space of this line. (Inherited from ITextViewLine.)
Public propertyExtentGets the extent of the line, excluding any line break characters. (Inherited from ITextViewLine.)
Public propertyExtentAsMappingSpanGets the IMappingSpan that corresponds to the Extent of the line. (Inherited from ITextViewLine.)
Public propertyExtentIncludingLineBreakGets the extent of the line, including any line break characters. (Inherited from ITextViewLine.)
Public propertyExtentIncludingLineBreakAsMappingSpanGets the IMappingSpan that corresponds to ExtentIncludingLineBreak. (Inherited from ITextViewLine.)
Public propertyHeightGets the distance between the top and bottom edge of this line. (Inherited from ITextViewLine.)
Public propertyIdentityTagGets a tag that can be used to track the identity of an ITextViewLine across layouts in the view. (Inherited from ITextViewLine.)
Public propertyIsFirstTextViewLineForSnapshotLineDetermines whether this ITextViewLine is the first line in the list of lines formatted for a particular ITextSnapshotLine. (Inherited from ITextViewLine.)
Public propertyIsLastTextViewLineForSnapshotLineDetermines whether this ITextViewLine is the last line in the list of lines formatted for a particular ITextSnapshotLine. (Inherited from ITextViewLine.)
Public propertyIsValidDetermines whether this text view line is still valid. (Inherited from ITextViewLine.)
Public propertyLeftGets the position of the left edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.)
Public propertyLengthGets the length of the line, excluding any line break characters. (Inherited from ITextViewLine.)
Public propertyLengthIncludingLineBreakGets the length of the line, including any line break characters. (Inherited from ITextViewLine.)
Public propertyLineBreakLengthGets the length of the line break sequence (for example, "\r\n") that appears at the end of this line. (Inherited from ITextViewLine.)
Public propertyLineTransformGets the LineTransform used to render this line. (Inherited from ITextViewLine.)
Public propertyRightGets the position of the right edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.)
Public propertySnapshotGets the ITextSnapshot on which this map is based. (Inherited from ITextViewLine.)
Public propertyStartGets the position in Snapshot of the first character in the line. (Inherited from ITextViewLine.)
Public propertyTextBottomGets the y-coordinate of the bottom of the text in the rendered line. (Inherited from ITextViewLine.)
Public propertyTextHeightGets the vertical distance between the top and bottom of the text in the rendered line. (Inherited from ITextViewLine.)
Public propertyTextLeftGets the x-coordinate of the left edge of the text in the rendered line. (Inherited from ITextViewLine.)
Public propertyTextLinesGets a list of text lines that make up the formatted text line.
Public propertyTextRightGets the x-coordinate of the right edge of the text in the rendered line. (Inherited from ITextViewLine.)
Public propertyTextTopGets the y-coordinate of the top of the text in the rendered line. (Inherited from ITextViewLine.)
Public propertyTextWidthGets the horizontal distance between TextRight and TextLeft. (Inherited from ITextViewLine.)
Public propertyTopGets the position of the top edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.)
Public propertyVirtualSpaceWidthGet the width of the virtual spaces at the end of this line. (Inherited from ITextViewLine.)
Public propertyVisibilityStateGets the visibility state of this rendered text line with respect to the top and bottom of the view. (Inherited from ITextViewLine.)
Public propertyVisibleAreaGets the visible area in which this text line will be rendered.
Public propertyWidthGets the distance between the left and right edges of this line. (Inherited from ITextViewLine.)
Top
  NameDescription
Public methodContainsBufferPositionDetermines whether the specified buffer position lies within this text line. (Inherited from ITextViewLine.)
Public methodGetAdornmentBoundsCalculates the bounds of the specified adornment. (Inherited from ITextViewLine.)
Public methodGetAdornmentTagsGets the adornments positioned on the line. (Inherited from ITextViewLine.)
Public methodGetBufferPositionFromXCoordinate(Double)Gets the buffer position of the character whose character bounds contains the given x-coordinate. (Inherited from ITextViewLine.)
Public methodGetBufferPositionFromXCoordinate(Double, Boolean)Gets the buffer position of the character whose character bounds contains the given x-coordinate. (Inherited from ITextViewLine.)
Public methodGetCharacterBounds(SnapshotPoint)Calculates the bounds of the character at the specified buffer position. (Inherited from ITextViewLine.)
Public methodGetCharacterBounds(VirtualSnapshotPoint)Calculates the bounds of the character at the specified buffer position. (Inherited from ITextViewLine.)
Public methodGetCharacterFormattingGets the formatting for a particular character in the line.
Public methodGetExtendedCharacterBounds(SnapshotPoint)Calculates the bounds of the character at the specified buffer position, including any adjacent space-negotiating adornments. (Inherited from ITextViewLine.)
Public methodGetExtendedCharacterBounds(VirtualSnapshotPoint)Calculates the bounds of the character at the specified virtual buffer position, including any adjacent space-negotiating adornments. (Inherited from ITextViewLine.)
Public methodGetInsertionBufferPositionFromXCoordinateGets the buffer position used if new data were to be inserted at the given x-coordinate. (Inherited from ITextViewLine.)
Public methodGetNormalizedTextBoundsGets a collection of TextBounds structures for the text that corresponds to the given span. (Inherited from ITextViewLine.)
Public methodGetTextElementSpanGets the span whose text element index corresponds to the given buffer position. (Inherited from ITextViewLine.)
Public methodGetVirtualBufferPositionFromXCoordinateGets the buffer position of the character whose character bounds contains the given x-coordinate. (Inherited from ITextViewLine.)
Public methodIntersectsBufferSpanDetermines whether a bufferSpan intersects this text line. (Inherited from ITextViewLine.)
Top

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

Only those lines of which parts are visible in the viewport will be formatted. 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.