ITextBuffer.Delete(Span) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text

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

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

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.

Deletes a sequence of characters from the buffer.

public:
 Microsoft::VisualStudio::Text::ITextSnapshot ^ Delete(Microsoft::VisualStudio::Text::Span deleteSpan);

public:
 Microsoft::VisualStudio::Text::ITextSnapshot ^ Delete(Microsoft::VisualStudio::Text::Span deleteSpan);

Microsoft::VisualStudio::Text::ITextSnapshot Delete(Microsoft::VisualStudio::Text::Span deleteSpan);

public Microsoft.VisualStudio.Text.ITextSnapshot Delete (Microsoft.VisualStudio.Text.Span deleteSpan);

abstract member Delete : Microsoft.VisualStudio.Text.Span -> Microsoft.VisualStudio.Text.ITextSnapshot

Public Function Delete (deleteSpan As Span) As ITextSnapshot

Parameters

deleteSpan: Span

The span of characters to delete.

Returns

ITextSnapshot

The ITextSnapshot.

Exceptions

ArgumentOutOfRangeException

deleteSpan.End is greater than the length of the buffer.

InvalidOperationException

A TextEdit is currently active, or CheckEditAccess() would return false.

Remarks

This is a shortcut for creating a new ITextEdit object, using it to delete the text, and then applying it. If the deletion fails on account of a read-only region, the snapshot returned will be the same as the current snapshot of the buffer before the attempted deletion.

Applies to

Compartilhar via