_DTE.UndoContext Property

Gets the global UndoContext object.

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

Syntax

'Declaration
ReadOnly Property UndoContext As UndoContext

UndoContext UndoContext { get; }

property UndoContext^ UndoContext {
    UndoContext^ get ();
}

abstract UndoContext : UndoContext with get

function get UndoContext () : UndoContext

Property Value

Type: EnvDTE.UndoContext
A UndoContext object.

Examples

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

   DTE.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.
      DTE.UndoContext.Close()
   End Try
End Sub

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

_DTE Interface

EnvDTE Namespace