Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ITextBuffer.Replace Method

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.

Namespace:  Microsoft.VisualStudio.Text
Assembly:  Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

ITextSnapshot Replace(
	Span replaceSpan,
	string replaceWith
)

Parameters

replaceSpan
Type: Microsoft.VisualStudio.Text.Span

The span of characters to replace.

replaceWith
Type: System.String

The new text to replace the old.

ExceptionCondition
ArgumentNullException

replaceWith is null.

InvalidOperationException

A text edit is currently active.

ArgumentOutOfRangeException

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

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.

Show:
© 2015 Microsoft