IVsTextView Interface

Definition

public interface class IVsTextView

public interface class IVsTextView

__interface IVsTextView

[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("BB23A14B-7C61-469A-9890-A95648CED5E6")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsTextView

[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("BB23A14B-7C61-469A-9890-A95648CED5E6")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsTextView

[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("BB23A14B-7C61-469A-9890-A95648CED5E6")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsTextView = interface

[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("BB23A14B-7C61-469A-9890-A95648CED5E6")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsTextView = interface

Public Interface IVsTextView

Derived

Microsoft.VisualStudio.TextManager.Interop.VsTextView

Microsoft.VisualStudio.TextManager.Interop.VsTextViewClass

Attributes

ComConversionLossAttribute GuidAttribute InterfaceTypeAttribute

Remarks

The IVsTextView interface is not the MDI child, but an individual window of text. If a splitter is involved, there can be multiple views in an MDI child. The term, caret, refers to the text insertion point, while the term, cursor, refers to the mouse pointer.

If you need to perform any operations on the view from a different thread, you may either:

• Use the interface IVsThreadSafeTextView.

• Call the GetWindowHandle method and use the PostMessage method to post messages to the main thread.

Some methods on IVsTextViewuse ViewCol coordinates (for example, GetTextStream and GetCaretPos), while others use CharIndex coordinates (for example, GetWordExtent). ViewCol coordinates may include virtual space while CharIndex coordinates are only an offset into a buffer line and never include virtual space.

If you get a coordinate in ViewCol coordinates, then you should only call methods that take CharIndex coordinates after making sure that the ViewCol coordinate does not lie in the virtual space region. For example, if you call the following:

long iLine;

long cCount;

ViewCol iCol;

IVsTextView::SomeMethod(&iLine, &icol);

Then you must check to be sure that the following is true:

IVsTextBuffer::GetLengthOfLine(iLine, &cCount);

iCol < cCount

Then call the following:

IVsTextView::SomeOtherMethod(ViewCol(iCol ))

// where SomeOtherMethod takes ViewCol coordinates

See illustrations of the implementation and/or calling of this interface in the sample Figures Language Service.

Notes to Callers

Called by clients who want to manage their view.

Methods

Applies to