ITextEdit::Delete Method (Int32, Int32)

 

Deletes a sequence of characters from the buffer.

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

bool Delete(
	int startPosition,
	int charsToDelete
)

Parameters

startPosition
Type: System::Int32

The position of the first character to delete.

charsToDelete
Type: System::Int32

The number of characters to delete.

Return Value

Type: System::Boolean

true if the deletion succeeded; false if it was prevented by a read-only region.

Exception Condition
InvalidOperationException

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

ArgumentOutOfRangeException

startPosition is less than zero or greater than the length of the buffer, or charsToDelete is less than zero, or startPosition + charsToDelete is greater than the length of the buffer.

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

Return to top
Show: