ITextEdit::Replace Method (Span, String^)

 

Replaces a sequence of characters with different text.

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

bool 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.

Return Value

Type: System::Boolean

true if the replacement succeeded, false if it was prevented by a read-only region.

Exception Condition
ArgumentNullException

replaceWith is null.

InvalidOperationException

The Apply or Cancel or Dispose method has previously been called on this object.

ArgumentOutOfRangeException

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

This method has the same effect as first deleting the characters in replaceSpan and then inserting replaceWith.

Replacing an empty span with an empty string will succeed but will not generate a new snapshot or raise a Changed event.

Return to top
Show: