Transaction(Document, String)
Constructor
Description:
Instantiates a transaction object
Instantiates a transaction object
Remarks:
The transaction does not start by creating a transaction object. One of the 'Start' methods will need to be called in order to start this transaction.
The transaction does not start by creating a transaction object. One of the 'Start' methods will need to be called in order to start this transaction.
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document for which this transaction is going to be used. |
name | String | The name of the transaction. This name will appear in the undo menu once the transaction is successfully committed. The name must not be empty. The name can be reset later by either calling <a href="c0283e7f-d261-6016-724c-31ae5cde96a7.htm">SetName(String)</a> or by using the name argument in the <a href="5fb266f4-5eca-049f-6a30-f3ed76687409.htm">Start(String)</a> method. |
Return Value
Exceptions
Exception | Condition |
---|---|
ArgumentException | The name argument is an empty string. -or- Document is a linked file. Transactions can only be used in primary documents (projects or families.) |
ArgumentNullException | A non-optional argument was null |