ITextBuffer2 Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text

Assembly:: Microsoft.VisualStudio.Text.Data.dll

Package:: Microsoft.VisualStudio.Text.Data 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.

A mutable sequence of Unicode characters encoded using UTF-16. Positions within the buffer are treated as a sequence of characters (starting at character zero) or as a sequence of lines (starting at line zero). An empty buffer has a single line containing no characters.

public interface class ITextBuffer2 : Microsoft::VisualStudio::Text::ITextBuffer, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface ITextBuffer2 : Microsoft.VisualStudio.Text.ITextBuffer, Microsoft.VisualStudio.Utilities.IPropertyOwner

type ITextBuffer2 = interface
    interface ITextBuffer
    interface IPropertyOwner

Public Interface ITextBuffer2
Implements IPropertyOwner, ITextBuffer

Implements: ITextBuffer IPropertyOwner

Remarks

Any ITextBuffer will be upcastable to an ITextBuffer2.

Properties

ContentType	Gets the content type of the text in the buffer. (Inherited from ITextBuffer)
CurrentSnapshot	Gets the current content of the buffer. (Inherited from ITextBuffer)
EditInProgress	Determines whether an edit operation is currently in progress on the ITextBuffer. (Inherited from ITextBuffer)
Properties	The collection of properties controlled by the property owner. (Inherited from IPropertyOwner)

Methods

ChangeContentType(IContentType, Object)	Changes the IContentType for this ITextBuffer. (Inherited from ITextBuffer)
CheckEditAccess()	Determines whether edit operations on this text buffer are permitted on the calling thread. If TakeThreadOwnership() has previously been called, edit operations are permitted only from the same thread that made that call. (Inherited from ITextBuffer)
CreateEdit()	Creates an ITextEdit object that handles compound edit operations on this buffer. (Inherited from ITextBuffer)
CreateEdit(EditOptions, Nullable<Int32>, Object)	Creates an ITextEdit object that handles compound edit operations on this buffer. (Inherited from ITextBuffer)
CreateReadOnlyRegionEdit()	Creates an IReadOnlyRegionEdit object that handles adding or removing read-only regions from this buffer. (Inherited from ITextBuffer)
Delete(Span)	Deletes a sequence of characters from the buffer. (Inherited from ITextBuffer)
GetReadOnlyExtents(Span)	Gets a list of read-only regions that overlap the given span. (Inherited from ITextBuffer)
Insert(Int32, String)	Inserts the given `text`at the specified `position`in the ITextBuffer. (Inherited from ITextBuffer)
IsReadOnly(Int32, Boolean)	Determines whether a text insertion would be prohibited at `position` due to an IReadOnlyRegion. (Inherited from ITextBuffer)
IsReadOnly(Int32)	Determines whether a text insertion would be prohibited at `position` due to an IReadOnlyRegion. (Inherited from ITextBuffer)
IsReadOnly(Span, Boolean)	Determines whether a text modification or deletion would be prohibited at `span` due to an IReadOnlyRegion (Inherited from ITextBuffer)
IsReadOnly(Span)	Determines whether a text modification or deletion would be prohibited at `span` due to an IReadOnlyRegion (Inherited from ITextBuffer)
Replace(Span, String)	Replaces a sequence of characters with different text. This is equivalent to first deleting the text to be replaced and then inserting the new text. (Inherited from ITextBuffer)
TakeThreadOwnership()	Claims ownership of this buffer for the current thread. All subsequent modifications of this ITextBuffer must be made from the current thread, or else an InvalidOperationException will be raised. (Inherited from ITextBuffer)

Events

Changed	Occurs when a non-empty ITextEdit is successfully applied. (Inherited from ITextBuffer)
ChangedHighPriority	Occurs when a non-empty ITextEdit is successfully applied. (Inherited from ITextBuffer)
ChangedLowPriority	Occurs when a non-empty ITextEdit is successfully applied. (Inherited from ITextBuffer)
ChangedOnBackground	Occurs when a non-empty ITextEdit is successfully applied. This is raised on a background thread. Listeners are expected to schedule any expensive work to be done asynchronously outside of this thread.
Changing	Occurs just before a non-empty ITextEdit is applied. (Inherited from ITextBuffer)
ContentTypeChanged	Occurs whenever the IContentType has been changed. (Inherited from ITextBuffer)
PostChanged	Occurs after the Changed event and any resulting edits. (Inherited from ITextBuffer)
ReadOnlyRegionsChanged	Occurs when an IReadOnlyRegionEdit has created or removed read-only regions. (Inherited from ITextBuffer)

Applies to

Share via