AggregatedTransactionHandle Class

Spotfire 14.3 API Reference
A handle to an aggregated transaction.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelAggregatedTransactionHandle

Namespace:  Spotfire.Dxp.Framework.DocumentModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
public sealed class AggregatedTransactionHandle : IDisposable

The AggregatedTransactionHandle type exposes the following members.

Methods

  NameDescription
Public methodCommit
Commits the aggregated transaction. If this is the outermost aggregated transaction, an entry on the undo stack is created.
Public methodDispose
Disposes the transaction handle. This will rollback the transaction if it has not previously been committed.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRollback
Rollbacks the aggregated transaction.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Aggregated transactions provides the functionality to aggregate transactions which needs to be separate transactions while first executed but which should be unexecuted as one transaction at undo and redo. It also provides rollback of the transaction. This can be used to implement cancel on modal dialogs. If the handle is not committed before being disposed, it will rollback the transaction.
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference