This documentation is archived and is not being maintained.

SetAborted Method

Visual Studio .NET 2003

Discards all changes to participating open documents since opening the UndoContext Object.

[Visual Basic .NET]
Public Sub SetAborted() 
[Visual Basic 6]
Sub SetAborted() 
[C++]
HRESULT __stdcall SetAborted();
[C#]
public void SetAborted();
[JScript .NET]
public function SetAborted()

Remarks

Sets the IsAborted Property for the open UndoContext object to True. When this occurs, all changes made to participating documents since opening the UndoContext object until the UndoContext object is closed are discarded.

Example

This example removes all newline characters from a block of selected text:

Sub SetAbortedExample()
   ' Before running, select text in an open document.
   Dim txtSel As TextSelection
   Dim strTS As String, strAnswer As String, bIsOpen As Boolean
   txtSel = DTE.ActiveDocument.Selection
   strTS = txtSel.Text

   ' Check to see if UndoContext object is already open.
   If DTE.UndoContext.IsOpen = True Then
      bIsOpen = True
   Else
      ' Open the UndoContext object to track changes.
      DTE.UndoContext.Open("RemoveNewLines", False)
   End If
   MsgBox("Current IsAborted value: " & DTE.UndoContext.IsAborted)

   ' Perform search for newline characters and remove them.
   If strTS <> "" Then
      txtSel.Delete()
      strTS = Replace(strTS, vbNewLine, "", Compare:=vbTextCompare)
      txtSel.Insert(strTS)
   End If

   ' Check to see if you want to discard changes.
   strAnswer = MsgBox("Do you want to discard all changes made?", vbYesNo & vbQuestion)
   If strAnswer = True Then
      DTE.UndoContext.SetAborted()
      MsgBox("Current IsAborted value: " & DTE.UndoContext.IsAborted)
   End If

   ' If UndoContext was already open, don't close it.
   If bIsOpen = True Then
      ' Close the UndoContext object to commit the changes.
      DTE.UndoContext.Close()
   End If
End Sub

See Also

IsAborted Property

Applies To: UndoContext Object

Show: