IVsTextBuffer Interface

Acts as the base interface for the VsTextBuffer object and provides general information about the text buffer's properties. Also see IVsTextBufferEx, which adds GetTrackChanges and SetTrackChangesSuppression methods.

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

[<GuidAttribute("C08E5275-0D26-4DE9-8892-994024C23750")>]
[<InterfaceTypeAttribute()>]
type IVsTextBuffer =  interface end

The IVsTextBuffer type exposes the following members.

  NameDescription
Public methodGetLanguageServiceIDReturns the unique identifier of the language that is providing colorization and other attribute data to this buffer.
Public methodGetLastLineIndexReturns the last line in the text buffer.
Public methodGetLengthOfLineReturns the length of a line in the buffer.
Public methodGetLineCountReturns the number of lines in the buffer.
Public methodGetLineIndexOfPositionReturns the line and column numbers in the text buffer, given a position number.
Public methodGetPositionOfLineReturns the position number of a line.
Public methodGetPositionOfLineIndexReturns the position number in the text buffer, given a line and column number.
Public methodGetSizeReturns the size in characters of the buffer.
Public methodGetStateFlagsReturns the state flags of the text buffer.
Public methodGetUndoManagerReturns the undo manager for this buffer.
Public methodInitializeContentInitializes the content of the text buffer.
Public methodLockBufferHas no effect. Deprecated.
Public methodLockBufferExHas no effect. Deprecated.
Public methodReloadReloads the text buffer.
Public methodReserved1Reserved in the Vtable for future use.
Public methodReserved10Reserved in the Vtable for future use.
Public methodReserved2Reserved in the Vtable for future use.
Public methodReserved3Reserved in the Vtable for future use.
Public methodReserved4Reserved in the Vtable for future use.
Public methodReserved5Reserved in the Vtable for future use.
Public methodReserved6Reserved in the Vtable for future use.
Public methodReserved7Reserved in the Vtable for future use.
Public methodReserved8Reserved in the Vtable for future use.
Public methodReserved9Reserved in the Vtable for future use.
Public methodSetLanguageServiceIDSets the unique identifier of the language that is providing colorization and other attribute data to the buffer.
Public methodSetStateFlagsSets the state flags of the text buffer.
Public methodUnlockBufferHas no effect. Deprecated.
Public methodUnlockBufferExHas no effect. Deprecated.
Top

The IVsTextBuffer interface provides basic services and text buffer properties, and is used by many clients. It contains information such as whether the buffer is read-only, whether the buffer has been modified, and which language service is associated with the buffer.

Important noteImportant

Starting in Visual Studio 2010, you should access the text buffer on the UI thread, not on background threads. The text buffer no longer gets locked when you call LockBuffer or LockBufferEx. Similarly, the UnlockBuffer and UnlockBufferEx methods no longer have any effect.

IVsTextBuffer fires the IVsTextBufferEvents interface when there is a change in the language service. At the same time, the system notifies you of the switch to a different language service.

For the current buffer implementation, it is faster to read data from the interface IVsTextLines than to use IVsTextBuffer.

The position values used in this interface are a zero-based character index into a Unicode stream. It is always the caller's responsibility to ensure that requests do not index positions past the end of the buffer. Call the method GetSize to determine the character index position.

Notes to Callers

This interface is implemented as part of the VsTextBuffer object. As a VSPackage implementer, you call QueryInterface to get a pointer to the IVsTextBuffer interface when using the core editor objects.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft