About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface ITransactions

Declares methods for executing transactions on the document.

Since

2.0

interface ITransactions {
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    ExecuteInvisibleTransaction(action: Action): void;
    ExecuteStickyTransaction(guid: Guid, action: Action): void;
    ExecuteTransaction(action: Action): void;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
}

Hierarchy (view full)

IInterfaceBase
- ITransactions

Index

Methods

Default capability

ExecuteInvisibleTransaction ExecuteStickyTransaction ExecuteTransaction

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from IInterfaceBase.Cast

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from IInterfaceBase.TryCast

Default capability

ExecuteInvisibleTransaction

ExecuteInvisibleTransaction(action): void
Starts an invisible transaction on the document model by executing action.
Parameters
- action: Action
  The delegate to execute.
Returns void
Remark
This API expects that the script is declared with 'wrapInTransaction' set to 'false' to work as documented.

Since
2.0

ExecuteStickyTransaction

ExecuteStickyTransaction(guid, action): void
Starts a sticky transaction on the document model by executing action.
Parameters
- guid: Guid
  The id which identifies the transactions which should stick together.
- action: Action
  The delegate to execute.
Returns void
Remark
This API expects that the script is declared with 'wrapInTransaction' set to 'false' to work as documented.

Since
2.0

ExecuteTransaction

ExecuteTransaction(action): void
Starts a transaction on the document model by executing action.
Parameters
- action: Action
  The delegate to execute.
Returns void
Remark
This API expects that the script is declared with 'wrapInTransaction' set to 'false' to work as documented.

Since
2.0