Graph::BeginUpdate Method (Object^, String^, UndoOption, Boolean)

 

Starts a batch mode update on the Graph (which is more efficient). You must call the Complete() method on the returned GraphTransactionScope, otherwise your changes will be rolled back. The usual pattern is to use this in a using block so that if an exception is thrown the changes are automatically rolled back.

Namespace:   Microsoft.VisualStudio.GraphModel
Assembly:  Microsoft.VisualStudio.GraphModel (in Microsoft.VisualStudio.GraphModel.dll)

public:
GraphTransactionScope^ BeginUpdate(
	Object^ undoUnitId,
	String^ undoDescription,
	UndoOption option,
	bool forceAdd
)

Parameters

undoUnitId
Type: System::Object^

For identifying and merging.

undoDescription
Type: System::String^

An application might surface this caption as a label on the undo operations.

option
Type: Microsoft.VisualStudio.GraphModel::UndoOption

Type of undo.

forceAdd
Type: System::Boolean

This is only valid if the option is UndoOption.Add. This causes a new undo unit even if it is empty. This is useful when you are doing a compound operation that consists of multiple merged undo units where you must be sure the Add operation adds the initial unit even if it is empty.

Return Value

Type: Microsoft.VisualStudio.GraphModel::GraphTransactionScope^

A new GraphTransactionScope.

Return to top
Show: