VsTextViewClass Class

  • Article

Manages the text view of an editor window. Contains methods to manage the text view. The view is essentially the editor window shown in the UI. See IVsTextView.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TextManager.Interop.VsTextViewClass

Namespace:  Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Déclaration
<ClassInterfaceAttribute()> _
<GuidAttribute("F5E7E71E-1401-11D1-883B-0000F87579D2")> _
Public Class VsTextViewClass _
    Implements IVsTextView, VsTextView

[ClassInterfaceAttribute()]
[GuidAttribute("F5E7E71E-1401-11D1-883B-0000F87579D2")]
public class VsTextViewClass : IVsTextView, 
    VsTextView

[ClassInterfaceAttribute()]
[GuidAttribute(L"F5E7E71E-1401-11D1-883B-0000F87579D2")]
public ref class VsTextViewClass : IVsTextView, 
    VsTextView

[<ClassInterfaceAttribute()>]
[<GuidAttribute("F5E7E71E-1401-11D1-883B-0000F87579D2")>]
type VsTextViewClass =  
    class
        interface IVsTextView
        interface VsTextView
    end

public class VsTextViewClass implements IVsTextView, VsTextView

The VsTextViewClass type exposes the following members.

Constructors

  Name Description
Public method VsTextViewClass Creates a new instance of the class.

Top

Methods

  Name Description
Public method AddCommandFilter Adds a command filter to the existing chain of command filters.
Public method CenterColumns Places the specified column of text in the center of the view.
Public method CenterLines Places the specified lines of text in the center of the view.
Public method ClearSelection Clears the current selection.
Public method CloseView Closes and unregisters a view with the view manager.
Public method EnsureSpanVisible Ensures that text is in view, both vertically and horizontally.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetBuffer Returns the current contents of the text buffer.
Public method GetCaretPos Returns the line and column index of the cursor position.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLineAndColumn Converts a text stream position to a line and column index.
Public method GetLineHeight Returns the pixel height of a line.
Public method GetNearestPosition Converts a line and column index to a text stream position.
Public method GetPointOfLineColumn Returns the coordinates for the upper left corner of a particular line and column.
Public method GetScrollInfo Returns the core text editor's scroll bar settings for the specified scroll bar.
Public method GetSelectedText Returns a copy of the selected text.
Public method GetSelection Returns the text span corresponding to the current selection, if there is one.
Public method GetSelectionDataObject Returns a copy of the selected text in IDataObject interface format.
Public method GetSelectionMode Returns the current selection mode.
Public method GetSelectionSpan Returns the text span associated with a selection.
Public method GetTextStream Returns a specified stream of text in a string.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetWindowHandle Returns the window handle for this view.
Public method GetWordExtent Returns the current word extent.
Public method HighlightMatchingBrace Highlights the matching brace in a language construct.
Public method Initialize Creates the view and allows clients to specify one or more TextViewInitFlags options.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method PositionCaretForEditing Puts the caret in a position suitable for editing a function.
Public method RemoveCommandFilter Removes a command filter from the chain of command filters.
Public method ReplaceTextOnLine Replaces a line of text.
Public method RestrictViewRange Reduces the view’s range of visible/editable lines to a subset of the buffer’s lines.
Public method SendExplicitFocus Sends explicit focus to the window.
Public method SetBuffer Associates a text buffer with the view.
Public method SetCaretPos Sets the coordinates of the end point of a selection.
Public method SetScrollPosition Sets the core text editor's scroll bar settings for the specified scroll bar.
Public method SetSelection Selects specified text.
Public method SetSelectionMode Sets the selection mode.
Public method SetTopLine Sets the top line in the view to the baseline.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateCompletionStatus Used for word completion control.
Public method UpdateTipWindow Updates the tip window.
Public method UpdateViewFrameCaption Forces the view to update its frame window caption, such as "[Read only]".

Top

Remarks

You cannot create an instance of this class with the new keyword. Instead, you must get the ILocalRegistry object and create the object with CreateInstance. The MPF wraps this method with CreateInstance.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace