ITextView Interface

 

Represents a view of text in an ITextBuffer. It is the base class for a platform-specific interface that has methods to allow the formatted text to be rendered.

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

Public Interface ITextView
	Inherits IPropertyOwner

NameDescription
System_CAPS_pubpropertyBufferGraph

Gets the IBufferGraph that contains the set of source buffers that contribute to this view.

System_CAPS_pubpropertyCaret

Gets the caret element.

System_CAPS_pubpropertyHasAggregateFocus

Determines whether the view or any of its adornments has focus.

System_CAPS_pubpropertyInLayout

Determines whether the view is in the process of being laid out.

System_CAPS_pubpropertyIsClosed

Determines whether this text view has been closed.

System_CAPS_pubpropertyIsMouseOverViewOrAdornments

Determines whether the mouse is over the view or any of its adornments.

System_CAPS_pubpropertyLineHeight

Gets the nominal height of a line of text in the view.

System_CAPS_pubpropertyMaxTextRightCoordinate

Gets the right coordinate of the longest line, whether or not that line is currently visible, in logical pixels.

System_CAPS_pubpropertyOptions

Gets the options for this text view.

System_CAPS_pubpropertyProperties

(Inherited from IPropertyOwner.)

System_CAPS_pubpropertyProvisionalTextHighlight

Gets the span of text covered by the provisional text highlight.

System_CAPS_pubpropertyRoles

The roles which this view plays. Roles partially determine the extensions that are instantiated for the view.

System_CAPS_pubpropertySelection

Gets the selection element.

System_CAPS_pubpropertyTextBuffer

Gets the ITextBuffer whose text is rendered in this view.

System_CAPS_pubpropertyTextDataModel

Gets the ITextDataModel of this text view.

System_CAPS_pubpropertyTextSnapshot

Gets the ITextSnapshot of the text that is currently rendered in the view.

System_CAPS_pubpropertyTextViewLines

Gets a read-only list of the ITextViewLine objects rendered in this view.

System_CAPS_pubpropertyTextViewModel

Gets the ITextViewModel of this text view.

System_CAPS_pubpropertyViewportBottom

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

System_CAPS_pubpropertyViewportHeight

Gets the height of the visible content window (including the margin) in logical pixels.

System_CAPS_pubpropertyViewportLeft

Gets or sets the position of the left edge of the viewpoint in the text rendering coordinate system.

System_CAPS_pubpropertyViewportRight

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

System_CAPS_pubpropertyViewportTop

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

System_CAPS_pubpropertyViewportWidth

Gets the width of the visible content window (including the margin) in logical pixels.

System_CAPS_pubpropertyViewScroller

Gets a helper that provides various methods to scroll or manipulate the view.

System_CAPS_pubpropertyVisualSnapshot

Gets the ITextSnapshot of the visual buffer that is being rendered.

NameDescription
System_CAPS_pubmethodClose()

Closes the text view host and its view.

System_CAPS_pubmethodDisplayTextLineContainingBufferPosition(SnapshotPoint, Double, ViewRelativePosition)

Formats and displays the contents of the text buffer so that the ITextViewLine containing the buffer position is displayed at the desired position.

System_CAPS_pubmethodDisplayTextLineContainingBufferPosition(SnapshotPoint, Double, ViewRelativePosition, Nullable(Of Double), Nullable(Of Double))

Formats and displays the contents of the text buffer so that the ITextViewLine containing the specified buffer position is displayed at the desired position.

System_CAPS_pubmethodGetTextElementSpan(SnapshotPoint)

Gets the SnapshotSpan of text that constitutes a text element (a single visual representation) at the given SnapshotPoint.

System_CAPS_pubmethodGetTextViewLineContainingBufferPosition(SnapshotPoint)

Gets the ITextViewLine that contains the specified text buffer position.

System_CAPS_pubmethodQueueSpaceReservationStackRefresh()

Requests a refresh of the space reservation stack.

NameDescription
System_CAPS_pubeventClosed

Occurs immediately after the text view is closed.

System_CAPS_pubeventGotAggregateFocus

Occurs when the keyboard focus switches to the view or one of its adornments.

System_CAPS_pubeventLayoutChanged

Occurs when the text editor performs a text line layout.

System_CAPS_pubeventLostAggregateFocus

Occurs when the keyboard focus switches away from the view and any of its adornments.

System_CAPS_pubeventMouseHover

Occurs when the mouse has hovered over a character.

System_CAPS_pubeventViewportHeightChanged

Occurs when the viewport height is changed. Deprecated.

System_CAPS_pubeventViewportLeftChanged

Occurs when the position of the viewport left edge is changed. Deprecated

System_CAPS_pubeventViewportWidthChanged

Occurs when the viewport width is changed. Deprecated.

A text view is a platform-independent representation of a contiguous block of formatted and adorned text. The text can be accessed through the TextViewLines property.

For more information about text views, see the section "The Text View" in Inside the Editor.

The text view also instantiates an instance of an IEditorOperations component part so that it can execute various commands.

The text is formatted based on the classifiers that are attached to the underlying ITextBuffer.

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 ViewportTop property, which causes 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 one unit in the text rendering coordinate system corresponds to one pixel in the display.

Return to top
Show: