IProjectionBufferBase.Insert(Int32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Projection

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.

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

public:
 Microsoft::VisualStudio::Text::Projection::IProjectionSnapshot ^ Insert(int position, System::String ^ text);

public:
 Microsoft::VisualStudio::Text::Projection::IProjectionSnapshot ^ Insert(int position, Platform::String ^ text);

Microsoft::VisualStudio::Text::Projection::IProjectionSnapshot Insert(int position, std::wstring const & text);

public Microsoft.VisualStudio.Text.Projection.IProjectionSnapshot Insert (int position, string text);

abstract member Insert : int * string -> Microsoft.VisualStudio.Text.Projection.IProjectionSnapshot

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

Parameters

position: Int32

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

text: String

The text to be inserted.

Returns

IProjectionSnapshot

An IProjectionSnapshot.

Exceptions

ArgumentOutOfRangeException

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

ArgumentNullException

text is null.

InvalidOperationException

A TextEdit is currently active.

Remarks

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.

Applies to

Partager via