Interfejs UndoContext
Reprezentuje jako pojedyncza transakcja wszystkich operacji wykonywanych na wszystkie otwarte dokumenty uczestniczących w Visual Studio.Jeśli jego SetAborted wywoływana jest metoda, wszystkie zmiany wprowadzone od momentu otwarcia obiektu, są odrzucane.
Przestrzeń nazw: EnvDTE
Zestaw: EnvDTE (w EnvDTE.dll)
Składnia
'Deklaracja
<GuidAttribute("D8DEC44D-CAF2-4B39-A539-B91AE921BA92")> _
Public Interface UndoContext
[GuidAttribute("D8DEC44D-CAF2-4B39-A539-B91AE921BA92")]
public interface UndoContext
[GuidAttribute(L"D8DEC44D-CAF2-4B39-A539-B91AE921BA92")]
public interface class UndoContext
[<GuidAttribute("D8DEC44D-CAF2-4B39-A539-B91AE921BA92")>]
type UndoContext = interface end
public interface UndoContext
Typ UndoContext uwidacznia następujące elementy członkowskie.
Właściwości
Nazwa | Opis | |
---|---|---|
DTE | Pobiera obiekt rozszerzalności najwyższego poziomu. | |
IsAborted | Pobiera czy UndoContext obiektu operacja została zakończona przez SetAborted metody. | |
IsOpen | Pobiera się, czy operacja Cofnij jest obecnie wpływ lub jeśli rozwiązanie nie jest otwarty. | |
IsStrict | Pobiera czy ścisłe powiązanie stosu Cofnij. | |
Parent | Zwraca obiekt nadrzędny natychmiastowe z UndoContext obiektu. |
Początek
Metody
Nazwa | Opis | |
---|---|---|
Close | Kończy operację Cofnij. | |
Open | Rozpoczyna nową operację Cofnij. | |
SetAborted | Odrzuca wszystkie zmiany w uczestniczących otwarte dokumenty od momentu otwarcia UndoContext obiektu. |
Początek
Uwagi
UndoContext Obiekt jest zwracany przez UndoContext właściwość _DTE obiektu.Istnieje tylko jedna usługa Cofnij globalne w Visual Studio jest otwarte lub zamknięte.Po UndoContext obiekt jest otwarty, wszystkie aktualizacje wprowadzone do dokumentów w Visual Studio może być wycofany (anulowany) przez akcję Cofnij pojedynczego, SetAborted metodę, dopóki obiekt nie zostanie zamknięty.Jeśli SetAborted wywoływana jest metoda, wszystkie zmiany wprowadzone od momentu otwarcia obiektu, są odrzucane.
Aby użyć UndoContext obiektu, otworzyć go, wprowadzić zmiany w dokumencie, a następnie Zamknij obiekt, aby sfinalizować zmiany.
Aby odrzucić zmiany, call SetAborted metoda przed zamknięciem UndoContext obiektu.Po zamknięciu UndoContext obiektu można już cofnąć zmian.
[!UWAGA]
Przed rozpoczęciem korzystania z UndoContext obiekt, sprawdź, czy jest już otwarte z poprzedniej operacji.Jeśli jest już otwarty, wprowadzone zmiany zostaną cofnięte we wszystkich dokumentach uczestniczących, wraz z wszystkich zmian, ponieważ obiekt został otwarty.Jeśli UndoContext obiekt jest już otwarty, gdy go, nie należy zamykać, ponieważ poprzedni obiekt wywołujący nadal wymaga ona dla operacji Cofnij.W związku z tym, nie należy wywoływać SetAborted , a następnie Zamknij UndoContext obiektów, chyba że pierwotnie otwarty.Zamknij po zakończeniu zmiana tekstu w dokumentach.
Przykłady
Sub UndoContextExample()
' 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, do not close it.
If boolWasOpen = False Then
' Close the UndoContext object to commit the changes.
DTE.UndoContext.Close()
End If
End Sub