ITextEdit.Insert Method

Definition

Namespace:

Microsoft.VisualStudio.Text

Assembly:

Microsoft.VisualStudio.Text.Data.dll

Package:

Microsoft.VisualStudio.Text.Data v17.12.215

Overloads

Insert(Int32, String)	Inserts the given text at the specified positionin the text buffer.
Insert(Int32, Char[], Int32, Int32)	Inserts an array of characters at the specified position in the ITextBuffer.

Insert(Int32, String)

Inserts the given text at the specified positionin the text buffer.

public:
 bool Insert(int position, System::String ^ text);

public:
 bool Insert(int position, Platform::String ^ text);

bool Insert(int position, std::wstring const & text);

public bool Insert (int position, string text);

abstract member Insert : int * string -> bool

Public Function Insert (position As Integer, text As String) As Boolean

Parameters

position

Int32

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

text

String

The text to be inserted.

Returns

Boolean

true if the insertion succeeded, false if it failed due to a read-only region.

Exceptions

InvalidOperationException

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

ArgumentOutOfRangeException

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

ArgumentNullException

text is null.

Remarks

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

Insert(Int32, Char[], Int32, Int32)

Inserts an array of characters at the specified position in the ITextBuffer.

public:
 bool Insert(int position, cli::array <char> ^ characterBuffer, int startIndex, int length);

public:
 bool Insert(int position, Platform::Array <char16> ^ characterBuffer, int startIndex, int length);

bool Insert(int position, std::Array <char> const & characterBuffer, int startIndex, int length);

public bool Insert (int position, char[] characterBuffer, int startIndex, int length);

abstract member Insert : int * char[] * int * int -> bool

Public Function Insert (position As Integer, characterBuffer As Char(), startIndex As Integer, length As Integer) As Boolean

Parameters

position

Int32

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

characterBuffer

Char[]

The character array from which characters will be inserted.

startIndex

Int32

The index in characterBuffer of the first character to insert.

length

Int32

The number of characters to insert from characterBuffer.

Returns

Boolean

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

Exceptions

InvalidOperationException

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

ArgumentNullException

characterBuffer is null.

ArgumentOutOfRangeException

.

Remarks

Inserting zero characters will succeed but will not generate a new snapshot or raise a Changed event.