EditPoint.Copy Method

  • Article

Copies the specified range of text to the clipboard.

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

Syntax

'Declaration
Sub Copy ( _
    PointOrCount As Object, _
    Append As Boolean _
)

void Copy(
    Object PointOrCount,
    bool Append
)

void Copy(
    [InAttribute] Object^ PointOrCount, 
    [InAttribute] bool Append
)

abstract Copy : 
        PointOrCount:Object * 
        Append:bool -> unit

function Copy(
    PointOrCount : Object, 
    Append : boolean
)

Parameters

  • Append
    Type: System.Boolean

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

Remarks

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.

Examples

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.
   objEditPt.StartOfDocument()
   objEditPt.LineDown(3)
   objEditPt.WordRight(3)
   objEditPt.Copy(4)
   objEditPt.Paste()
   objEditPt.LineDown(3)
   objEditPt.WordRight(3)
   objEditPt.Cut(4)
End Sub

.NET Framework Security

See Also

Reference

EditPoint Interface

EnvDTE Namespace