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)
Syntax
'Declaration
Public Interface IWpfTextViewLine _
Inherits ITextViewLine
public interface IWpfTextViewLine : ITextViewLine
public interface class IWpfTextViewLine : ITextViewLine
type IWpfTextViewLine =
interface
interface ITextViewLine
end
public interface IWpfTextViewLine extends ITextViewLine
The IWpfTextViewLine type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Baseline | Gets the distance from the top of the text to the baseline text on the line. (Inherited from ITextViewLine.) |
|
Bottom | Gets the position of the bottom edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.) |
|
Change | Gets the change to this rendered textline between the current layout and the previous layout. (Inherited from ITextViewLine.) |
|
DefaultLineTransform | Gets the default LineTransform used to render this line. (Inherited from ITextViewLine.) |
|
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. (Inherited from ITextViewLine.) |
|
End | Gets the position of the first character past the end of the line, excluding any line break characters. (Inherited from ITextViewLine.) |
|
EndIncludingLineBreak | Gets the position of the first character past the end of the line, including any line break characters. (Inherited from ITextViewLine.) |
|
EndOfLineWidth | Gets 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.) |
|
Extent | Gets the extent of the line, excluding any line break characters. (Inherited from ITextViewLine.) |
|
ExtentAsMappingSpan | Gets the IMappingSpan that corresponds to the Extent of the line. (Inherited from ITextViewLine.) |
|
ExtentIncludingLineBreak | Gets the extent of the line, including any line break characters. (Inherited from ITextViewLine.) |
|
ExtentIncludingLineBreakAsMappingSpan | Gets the IMappingSpan that corresponds to ExtentIncludingLineBreak. (Inherited from ITextViewLine.) |
|
Height | Gets the distance between the top and bottom edge of this line. (Inherited from ITextViewLine.) |
|
IdentityTag | Gets a tag that can be used to track the identity of an ITextViewLine across layouts in the view. (Inherited from ITextViewLine.) |
|
IsFirstTextViewLineForSnapshotLine | Determines whether this ITextViewLine is the first line in the list of lines formatted for a particular ITextSnapshotLine. (Inherited from ITextViewLine.) |
|
IsLastTextViewLineForSnapshotLine | Determines whether this ITextViewLine is the last line in the list of lines formatted for a particular ITextSnapshotLine. (Inherited from ITextViewLine.) |
|
IsValid | Determines whether this text view line is still valid. (Inherited from ITextViewLine.) |
|
Left | Gets the position of the left edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.) |
|
Length | Gets the length of the line, excluding any line break characters. (Inherited from ITextViewLine.) |
|
LengthIncludingLineBreak | Gets the length of the line, including any line break characters. (Inherited from ITextViewLine.) |
|
LineBreakLength | Gets the length of the line break sequence (for example, "\r\n") that appears at the end of this line. (Inherited from ITextViewLine.) |
|
LineTransform | Gets the LineTransform used to render this line. (Inherited from ITextViewLine.) |
|
Right | Gets the position of the right edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.) |
|
Snapshot | Gets the ITextSnapshot on which this map is based. (Inherited from ITextViewLine.) |
|
Start | Gets the position in Snapshot of the first character in the line. (Inherited from ITextViewLine.) |
|
TextBottom | Gets the y-coordinate of the bottom of the text in the rendered line. (Inherited from ITextViewLine.) |
|
TextHeight | Gets the vertical distance between the top and bottom of the text in the rendered line. (Inherited from ITextViewLine.) |
|
TextLeft | Gets the x-coordinate of the left edge of the text in the rendered line. (Inherited from ITextViewLine.) |
|
TextLines | Gets a list of text lines that make up the formatted text line. |
|
TextRight | Gets the x-coordinate of the right edge of the text in the rendered line. (Inherited from ITextViewLine.) |
|
TextTop | Gets the y-coordinate of the top of the text in the rendered line. (Inherited from ITextViewLine.) |
|
TextWidth | Gets the horizontal distance between TextRight and TextLeft. (Inherited from ITextViewLine.) |
|
Top | Gets the position of the top edge of this line in the text rendering coordinate system. (Inherited from ITextViewLine.) |
|
VirtualSpaceWidth | Get the width of the virtual spaces at the end of this line. (Inherited from ITextViewLine.) |
|
VisibilityState | Gets the visibility state of this rendered text line with respect to the top and bottom of the view. (Inherited from ITextViewLine.) |
|
VisibleArea | Gets the visible area in which this text line will be rendered. |
|
Width | Gets the distance between the left and right edges of this line. (Inherited from ITextViewLine.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
ContainsBufferPosition | Determines whether the specified buffer position lies within this text line. (Inherited from ITextViewLine.) |
|
GetAdornmentBounds | Calculates the bounds of the specified adornment. (Inherited from ITextViewLine.) |
|
GetAdornmentTags | Gets the adornments positioned on the line. (Inherited from ITextViewLine.) |
|
GetBufferPositionFromXCoordinate(Double) | Gets the buffer position of the character whose character bounds contains the given x-coordinate. (Inherited from ITextViewLine.) |
|
GetBufferPositionFromXCoordinate(Double, Boolean) | Gets the buffer position of the character whose character bounds contains the given x-coordinate. (Inherited from ITextViewLine.) |
|
GetCharacterBounds(SnapshotPoint) | Calculates the bounds of the character at the specified buffer position. (Inherited from ITextViewLine.) |
|
GetCharacterBounds(VirtualSnapshotPoint) | Calculates the bounds of the character at the specified buffer position. (Inherited from ITextViewLine.) |
|
GetCharacterFormatting | Gets the formatting for a particular character in the line. |
|
GetExtendedCharacterBounds(SnapshotPoint) | Calculates the bounds of the character at the specified buffer position, including any adjacent space-negotiating adornments. (Inherited from ITextViewLine.) |
|
GetExtendedCharacterBounds(VirtualSnapshotPoint) | Calculates the bounds of the character at the specified virtual buffer position, including any adjacent space-negotiating adornments. (Inherited from ITextViewLine.) |
|
GetInsertionBufferPositionFromXCoordinate | Gets the buffer position used if new data were to be inserted at the given x-coordinate. (Inherited from ITextViewLine.) |
|
GetNormalizedTextBounds | Gets a collection of TextBounds structures for the text that corresponds to the given span. (Inherited from ITextViewLine.) |
|
GetTextElementSpan | Gets the span whose text element index corresponds to the given buffer position. (Inherited from ITextViewLine.) |
|
GetVirtualBufferPositionFromXCoordinate | Gets the buffer position of the character whose character bounds contains the given x-coordinate. (Inherited from ITextViewLine.) |
|
IntersectsBufferSpan | Determines whether a bufferSpan intersects this text line. (Inherited from ITextViewLine.) |
Top
Remarks
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.