This documentation is archived and is not being maintained.

EditPoint.Copy Method

Copies the specified range of text to the clipboard.

Namespace: EnvDTE
Assembly: EnvDTE (in envdte.dll)

void Copy (
	[InAttribute] Object PointOrCount,
	[OptionalAttribute] [InAttribute] bool Append
void Copy (
	/** @attribute InAttribute() */ Object PointOrCount, 
	/** @attribute InAttribute() */ /** @attribute OptionalAttribute() */ boolean Append
function Copy (
	PointOrCount : Object, 
	Append : boolean



Required. Either a TextPoint object or a number of characters.


Optional. Indicates whether to append the selected text to the clipboard. The default is false.

If the argument is a TextPoint object, Copy copies a string representing the text between the edit point and PointOrCount. If the argument is an integer, then Copy copies a string representing the specified number of characters following the edit point (counting one for each implied newline sequence at the end of each line). If PointOrCount is negative, then Copy copies text before the edit point rather than after.

If Append is true, then Copy appends the selection to the current clipboard contents rather than replacing it.

Sub CopyExample()
   Dim objTextDoc As TextDocument
   Dim objEditPt As EditPoint, iCtr As Integer
   ' Create a new text file.
   DTE.ItemOperations.NewFile("General\Text File")
   ' Get a handle to the new document and create an EditPoint.
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")
   objEditPt = objTextDoc.StartPoint.CreateEditPoint
   ' Insert ten lines of text.
   For iCtr = 1 To 10
      objeditpt.Insert("This is a test." & Chr(13))
   Next iCtr
   ' Copies the fourth word of the fourth line and pastes it, 
   ' then cuts the fourth word of the eighth line.
End Sub