ITextBuffer.Replace(Span, String) 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.

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.

public:
 Microsoft::VisualStudio::Text::ITextSnapshot ^ Replace(Microsoft::VisualStudio::Text::Span replaceSpan, System::String ^ replaceWith);

public:
 Microsoft::VisualStudio::Text::ITextSnapshot ^ Replace(Microsoft::VisualStudio::Text::Span replaceSpan, Platform::String ^ replaceWith);

Microsoft::VisualStudio::Text::ITextSnapshot Replace(Microsoft::VisualStudio::Text::Span replaceSpan, std::wstring const & replaceWith);

public Microsoft.VisualStudio.Text.ITextSnapshot Replace (Microsoft.VisualStudio.Text.Span replaceSpan, string replaceWith);

abstract member Replace : Microsoft.VisualStudio.Text.Span * string -> Microsoft.VisualStudio.Text.ITextSnapshot

Public Function Replace (replaceSpan As Span, replaceWith As String) As ITextSnapshot

Parameters

replaceSpan: Span

The span of characters to replace.

replaceWith: String

The new text to replace the old.

Returns

ITextSnapshot

The ITextSnapshot.

Exceptions

ArgumentOutOfRangeException

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

ArgumentNullException

replaceWithis null.

InvalidOperationException

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

Remarks

This is a shortcut for creating a new ITextEdit object, using it to replace the text, and then applying it. If the replacement 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 replacement.

Applies to

Share via