EditPoint.Copy(Object, Boolean) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Copies the specified range of text to the clipboard.

void Copy(winrt::Windows::Foundation::IInspectable const & PointOrCount, bool Append = false);

[System.Runtime.InteropServices.DispId(136)]
public void Copy (object PointOrCount, bool Append = false);

[<System.Runtime.InteropServices.DispId(136)>]
abstract member Copy : obj * bool -> unit

Public Sub Copy (PointOrCount As Object, Optional Append As Boolean = false)

Parameters

PointOrCount: Object

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

Append: Boolean

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

Attributes: DispIdAttribute

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

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.

Applies to