UndoContext.Close UndoContext.Close UndoContext.Close UndoContext.Close UndoContext.Close UndoContext.Close Method

Definition

Ends an undo operation.

public:
 void Close();
public:
 void Close();
void Close();
[System.Runtime.InteropServices.DispId(4)]
public void Close ();
abstract member Close : unit -> unit
Public Sub Close ()

Examples

Sub RemoveNewLines()  
   ' Before running, select text in an open document.  
   Dim txtSel As TextSelection  
   Dim strTS As String, boolWasOpen As Boolean  
   txtSel = DTE.ActiveDocument.Selection  
   strTS = txtSel.Text  
  
   ' Check to see if UndoContext object is already open.  
   If DTE.UndoContext.IsOpen = True Then  
      boolWasOpen = True  
   Else  
      ' Open the UndoContext object to track changes.  
      DTE.UndoContext.Open("RemoveNewLines", False)  
   End If  
  
   ' Perform search for newline characters and remove them.  
   If strTS <> "" Then  
      txtSel.Delete()  
      strTS = Replace(strTS, vbNewLine, "", Compare:=vbTextCompare)  
      txtSel.Insert(strTS)  
   End If  
  
   ' If UndoContext was already open, don't close it.  
   If boolWasOpen = False Then  
      ' Close the UndoContext object to commit the changes.  
      DTE.UndoContext.Close()  
   End If  
End Sub  

Remarks

If there are pending references to the UndoContext object, then Close aborts the operation and raises an error. An error occurs if the UndoContext object is not open when Close is called.

Applies to