IWpfTextView Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.UI.Wpf.dll

Package:: Microsoft.VisualStudio.Text.UI.Wpf v17.11.260

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a Visual Studio ITextView for the WPF platform.

public interface class IWpfTextView : Microsoft::VisualStudio::Text::Editor::ITextView, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface class IWpfTextView : Microsoft::VisualStudio::Text::Editor::ITextView, Microsoft::VisualStudio::Utilities::IPropertyOwner

__interface IWpfTextView : Microsoft::VisualStudio::Text::Editor::ITextView, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface IWpfTextView : Microsoft.VisualStudio.Text.Editor.ITextView, Microsoft.VisualStudio.Utilities.IPropertyOwner

type IWpfTextView = interface
    interface ITextView
    interface IPropertyOwner

Public Interface IWpfTextView
Implements IPropertyOwner, ITextView

Implements: ITextView IPropertyOwner

Remarks

For more information about this interface, and about how it differs from ITextView, see "Text View Subsystem" in Inside the Editor.

Properties

Background	Gets or sets the background for the visual element.
BufferGraph	Gets the IBufferGraph that contains the set of source buffers that contribute to this view. (Inherited from ITextView)
Caret	Gets the caret element. (Inherited from ITextView)
FormattedLineSource	Gets the text formatter used by the view.
HasAggregateFocus	Determines whether the view or any of its adornments has focus. (Inherited from ITextView)
InLayout	Determines whether the view is in the process of being laid out. (Inherited from ITextView)
IsClosed	Determines whether this text view has been closed. (Inherited from ITextView)
IsMouseOverViewOrAdornments	Determines whether the mouse is over the view or any of its adornments. (Inherited from ITextView)
LineHeight	Gets the nominal height of a line of text in the view. (Inherited from ITextView)
LineTransformSource	Gets the line transformer used by the view.
MaxTextRightCoordinate	Gets the right coordinate of the longest line, whether or not that line is currently visible, in logical pixels. (Inherited from ITextView)
Options	Gets the options for this text view. (Inherited from ITextView)
Properties	The collection of properties controlled by the property owner. (Inherited from IPropertyOwner)
ProvisionalTextHighlight	Gets the span of text covered by the provisional text highlight. (Inherited from ITextView)
Roles	The roles which this view plays. Roles partially determine the extensions that are instantiated for the view. (Inherited from ITextView)
Selection	Gets the selection element. (Inherited from ITextView)
TextBuffer	Gets the ITextBuffer whose text is rendered in this view. (Inherited from ITextView)
TextDataModel	Gets the ITextDataModel of this text view. (Inherited from ITextView)
TextSnapshot	Gets the ITextSnapshot of the text that is currently rendered in the view. (Inherited from ITextView)
TextViewLines	Gets the text view lines as an IWpfTextViewLineCollection.
TextViewModel	Gets the ITextViewModel of this text view. (Inherited from ITextView)
ViewportBottom	Gets the position of the bottom edge of the viewport in the text rendering coordinate system. (Inherited from ITextView)
ViewportHeight	Gets the height of the visible content window in logical pixels. (Inherited from ITextView)
ViewportLeft	Gets or sets the position of the left edge of the viewport in the text rendering coordinate system. (Inherited from ITextView)
ViewportRight	Gets the position of the right edge of the viewport in the text rendering coordinate system. (Inherited from ITextView)
ViewportTop	Gets the position of the top edge of the viewport in the text rendering coordinate system. (Inherited from ITextView)
ViewportWidth	Gets the width of the visible content window in logical pixels. (Inherited from ITextView)
ViewScroller	Gets a helper that provides various methods to scroll or manipulate the view. (Inherited from ITextView)
VisualElement	Gets the FrameworkElement that renders the view.
VisualSnapshot	Gets the ITextSnapshot of the visual buffer that is being rendered. (Inherited from ITextView)
ZoomLevel	Gets or sets the Zoom level for the IWpfTextView between 20% to 400%

Methods

Close()	Closes the text view and its view. (Inherited from ITextView)
DisplayTextLineContainingBufferPosition(SnapshotPoint, Double, ViewRelativePosition, Nullable<Double>, Nullable<Double>)	Formats and displays the contents of the text buffer so that the ITextViewLine containing `bufferPosition` is displayed at the desired position. (Inherited from ITextView)
DisplayTextLineContainingBufferPosition(SnapshotPoint, Double, ViewRelativePosition)	Formats and displays the contents of the text buffer so that the ITextViewLine containing `bufferPosition` is displayed at the desired position. (Inherited from ITextView)
GetAdornmentLayer(String)	Gets a named IAdornmentLayer.
GetSpaceReservationManager(String)	Gets a named ISpaceReservationManager.
GetTextElementSpan(SnapshotPoint)	Gets the SnapshotSpan of text that constitutes a text element (a single visual representation) at the given SnapshotPoint. (Inherited from ITextView)
GetTextViewLineContainingBufferPosition(SnapshotPoint)	Gets the IWpfTextViewLine that contains the specified text buffer position.
QueueSpaceReservationStackRefresh()	Requests a refresh of the space reservation stack. (Inherited from ITextView)

Events

BackgroundBrushChanged	Occurs when the Background is set.
Closed	Occurs immediately after the text view is closed. (Inherited from ITextView)
GotAggregateFocus	Occurs when the keyboard focus switches to the view or one of its adornments. (Inherited from ITextView)
LayoutChanged	Occurs whenever the text displayed in the view changes. (Inherited from ITextView)
LostAggregateFocus	Occurs when the keyboard focus switches away from the view and any of its adornments. (Inherited from ITextView)
MouseHover	Occurs when the mouse has hovered over the same character. (Inherited from ITextView)
ViewportHeightChanged	Occurs when the viewport's height is changed. (Inherited from ITextView)
ViewportLeftChanged	Occurs when the position of the viewport's left edge is changed. (e.g. when the view is horizontally scrolled) (Inherited from ITextView)
ViewportWidthChanged	Occurs when the viewport's width is changed. (Inherited from ITextView)
ZoomLevelChanged	Occurs when the ZoomLevel is set.

Extension Methods

GetInOuterLayout(ITextView)	Determines whether a view is in the process of being laid out or is preparing to be laid out.
GetMultiSelectionBroker(ITextView)	Gets an object for managing selections within the view.
IsEmbeddedTextView(ITextView)	Gets whether given ITextView is embedded in another ITextView.
IsReadOnlyTextView(ITextView)	Gets whether given ITextView is considered read-only.
QueuePostLayoutAction(ITextView, Action)	See QueuePostLayoutAction(Action).
TryGetContainingTextView(ITextView, ITextView)	Gets containing ITextView for given embedded ITextView.
TryGetTextViewLineContainingBufferPosition(ITextView, SnapshotPoint, ITextViewLine)	See TryGetTextViewLineContainingBufferPosition(SnapshotPoint, ITextViewLine).
TryGetTextViewLines(ITextView, ITextViewLineCollection)	See TryGetTextViewLines(ITextViewLineCollection).

Applies to

Share via