ITextBufferEdit Interface

Definition

Namespace:: Microsoft.VisualStudio.Text

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

Package:: Microsoft.VisualStudio.Text.Data v17.14.249

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 edit operations against a ITextBuffer.

public interface class ITextBufferEdit : IDisposable

public interface ITextBufferEdit : IDisposable

type ITextBufferEdit = interface
    interface IDisposable

Public Interface ITextBufferEdit
Implements IDisposable

Derived: Microsoft.VisualStudio.Text.IReadOnlyRegionEdit

Microsoft.VisualStudio.Text.ITextEdit

Implements: IDisposable

Remarks

For more information about text edits, see the section "A Closer Look at the Text Model and the Text View" in Inside the Editor.

Properties

Canceled	Determines whether this edit has been canceled.
Snapshot	A snapshot of the ITextBuffer at the time this ITextBufferEdit object was created.

Methods

Apply()

Commits all the modifications made with this ITextBufferEdit object to the underlying ITextBuffer. Depending on the type of edit, it may also cause the ITextBuffer to generate a new snapshot and raise its Changed event if any modifications were made. This method may be called only once. After it is called, any other calls on this object (other than Dispose) will result in an InvalidOperationException.

Cancel()

Abandons all modifications started using this ITextBufferEdit object. Any further calls on this object will result in an InvalidOperationException.

Applies to