ITextBuffer::Insert Method (Int32, String^)

Visual Studio 2015
 

Inserts the given text at the specified position in the ITextBuffer.

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

C#
C++
F#
VB
Copy 
ITextSnapshot^ Insert(
	int position,
	String^ text
)

Parameters

position
Type: System::Int32

The buffer position at which the first character of the text will appear.

text
Type: System::String^

The text to be inserted.

Return Value

Type: Microsoft.VisualStudio.Text::ITextSnapshot^

The ITextSnapshot.

Exception Condition
ArgumentNullException

text is null.

InvalidOperationException

A text edit is currently active.

ArgumentOutOfRangeException

position is less than zero or greater than the length of the buffer.

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

Return to top
Show: