UndoableGraphTransactionScope Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
This is a special graph transaction scope that can be used for undoable edits (that appear in the host application undo stack).
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.GraphModel.GraphTransactionScope
Microsoft.VisualStudio.GraphModel.UndoableGraphTransactionScope
Namespace: Microsoft.VisualStudio.GraphModel
Assembly: Microsoft.VisualStudio.GraphModel (in Microsoft.VisualStudio.GraphModel.dll)
Syntax
'Declaration
Public Class UndoableGraphTransactionScope _
Inherits GraphTransactionScope
public class UndoableGraphTransactionScope : GraphTransactionScope
public ref class UndoableGraphTransactionScope : public GraphTransactionScope
type UndoableGraphTransactionScope =
class
inherit GraphTransactionScope
end
public class UndoableGraphTransactionScope extends GraphTransactionScope
The UndoableGraphTransactionScope type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
UndoableGraphTransactionScope(String) | Construct a new UndoableGraphTransactionScope |
|
UndoableGraphTransactionScope(UndoOption) | Construct a new UndoableGraphTransactionScope |
|
UndoableGraphTransactionScope(Object, UndoOption) | Construct a new UndoableGraphTransactionScope |
|
UndoableGraphTransactionScope(Object, String, UndoOption) | Construct a new UndoableGraphTransactionScope |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ScopeProperties | The property bag associated with this scope. (Inherited from GraphTransactionScope.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Complete | Mark us as completed. Dispose will check this and if this wasn't called, the transaction will abort. (Inherited from GraphTransactionScope.) |
|
Dispose() | IDisposable.Dispose. (Inherited from GraphTransactionScope.) |
.gif "Protected method") |
Dispose(Boolean) | (Overrides GraphTransactionScope.Dispose(Boolean).) |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
.gif "Static member") |
GetUndoDescription | Get the undo description from the given transaction scope properties. |
|
GetUndoId | Get the Id associated with the given GraphTransactionEnlistment |
|
GetUndoOption | Get the UndoOption associated from the given transaction scope properties. |
|
IsForceAdd | Get if the transaction is marked as "force add", which will create an undo unit even if it is empty. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | Will be notified when this scope is disposed |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") |
DisableUndo | |
|
ForceAddKey | |
|
UndoDescriptionKey | |
|
UndoOptionKey |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.