EditPoint.Cut(Object, Boolean) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 and deletes it from the document.

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

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

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

Public Sub Cut (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 CutExample()  
   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 PointOrCount is a TextPoint object, Cut cuts the text between the edit point and PointOrCount and places it on the clipboard. If PointOrCount is an integer, then Cut cuts the text after the edit point for the specified number of characters following the edit point (adding one for each implied newline sequence at the end of each line). If PointOrCount is negative, then Cut cuts text before the edit point.

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

Applies to

Partager via