UndoContext Interface
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Representa, como uma única transação, todas as operações executadas em todos os documentos abertos participantes no Visual Studio. Se seu SetAborted() método for invocado, todas as alterações feitas desde a abertura do objeto serão descartadas.
public interface class UndoContext
public interface class UndoContext
__interface UndoContext
[System.Runtime.InteropServices.Guid("D8DEC44D-CAF2-4B39-A539-B91AE921BA92")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface UndoContext
[<System.Runtime.InteropServices.Guid("D8DEC44D-CAF2-4B39-A539-B91AE921BA92")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type UndoContext = interface
Public Interface UndoContext
- Atributos
Exemplos
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
Comentários
O UndoContext objeto é retornado pela UndoContext Propriedade do _DTE objeto. Há apenas um serviço de desfazer global no Visual Studio que é aberto ou fechado. Depois que o UndoContext objeto é aberto, todas as atualizações feitas em documentos no Visual Studio podem ser revertidas (desfeitas) por uma única ação desfazer, o SetAborted método, até que o objeto seja fechado. Se o SetAborted método for invocado, todas as alterações feitas desde a abertura do objeto serão descartadas.
Para usar o UndoContext objeto, abra-o, faça alterações no documento e, em seguida, feche o objeto para finalizar as alterações.
Para descartar as alterações, chame o SetAborted método antes de fechar o UndoContext objeto. Depois de fechar UndoContext o objeto, você não poderá mais desfazer as alterações.
Observação
Antes de usar o UndoContext objeto, verifique se ele já está aberto de uma operação anterior. Se ele já estiver aberto, suas alterações serão desfeitas em todos os documentos participantes, juntamente com todas as alterações feitas desde que o objeto foi aberto pela primeira vez. Se o UndoContext objeto já estiver aberto quando você o fizer, não o feche porque o chamador anterior ainda o exige para uma operação de desfazer. Consequentemente, você não deve chamar SetAborted e fechar o UndoContext objeto, a menos que você o tenha aberto originalmente. Feche-o depois de terminar de alterar o texto em documentos.
Propriedades
| DTE |
Obtém o objeto de extensibilidade de nível superior. |
| IsAborted |
Obtém se a UndoContext operação de objeto foi finalizada pelo SetAborted() método. |
| IsOpen |
Obtém se uma operação de desfazer está em vigor no momento ou se uma solução está aberta. |
| IsStrict |
Obtém se o vínculo de desfazer pilha é estrito. |
| Parent |
Obtém o objeto pai imediato de um UndoContext objeto. |
Métodos
| Close() |
Finaliza uma operação de desfazer. |
| Open(String, Boolean) |
Inicia uma nova operação de desfazer. |
| SetAborted() |
Descarta todas as alterações em documentos abertos participantes desde a abertura do UndoContext objeto. |