DTE2.UndoContext Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets the global UndoContext object.

public:
 property EnvDTE::UndoContext ^ UndoContext { EnvDTE::UndoContext ^ get(); };

public:
 property EnvDTE::UndoContext ^ UndoContext { EnvDTE::UndoContext ^ get(); };

[System.Runtime.InteropServices.DispId(235)]
public EnvDTE.UndoContext UndoContext { [System.Runtime.InteropServices.DispId(235)] get; }

[<System.Runtime.InteropServices.DispId(235)>]
[<get: System.Runtime.InteropServices.DispId(235)>]
member this.UndoContext : EnvDTE.UndoContext

Public ReadOnly Property UndoContext As UndoContext

Property Value

UndoContext

A UndoContext object.

Attributes

DispIdAttribute

Examples

Sub UndoContextExample()  
   Dim selection As TextSelection = DTE2.ActiveDocument.Selection()  
   Dim start As EditPoint = selection.TopPoint.CreateEditPoint()  
   Dim endpt As TextPoint = selection.BottomPoint  
   Dim commentStart As String  

   DTE2.UndoContext.Open("Comment Region")  
   Try  
      Do While (start.LessThan(endpt))  
         start.Insert(commentStart)  
         start.LineDown()  
         start.StartOfLine()  
      Loop  
   Finally  
      ' If an error occured, then need to make sure that the undo   
      ' context is cleaned up. Otherwise, the editor can be left in a   
      ' perpetual undo context.  
      DTE2.UndoContext.Close()  
   End Try  
End Sub