Batch Object
The system passes the Batch: object as an argument to all event handlers. The same object is available for each event in a batch operation.
Note
- A single-document operation is treated as a batch with size 1.
- CAD application links in remote mode do not support the Batch: object.
Batch object properties
The Batch: object provides the following properties. Most are read-only. To affect some read-only properties requires user interaction or custom event procedures.
Argument property
A variable stored for the Batch: object during the current batch operation. Use arguments to pass parameters between procedures within the same batch operation.
Syntax
Argument(Name) As Variant
Predefined, read-only Batch: object arguments to use to obtain additional information
| Argument | Description |
|---|---|
| Batch.Argument("**$$RelatedProjectCopy") | A reference to the project copy document released as a master document. Use in the DocGenericEvent_BeforeNewDocument: event to move the master document to the correct location if created for the first time. |
| Batch.Argument("**$$RelatedVaultDocument") | A reference to a vault document that corresponds to a briefcase file. The reference can be an ID string, Document: object, or AMDocument: object. Use in the BrcEvent_BeforeImport: event to relate a vault document to an incoming file. |
Batch object methods
The Batch: object methods affect the current batch operation.
Abort method
Abort the current batch operation.
Syntax
Abort([Message])
| Name | Description |
|---|---|
| Message | Show the specified message to the current user. |
Remarks
The system revokes uncommitted items in the batch.
AskConfirmation method
Shows a confirmation prompt in the batch progress dialog with Yes: and No: radio buttons for answer selection and an optional comment field.
FailCurrent method
Fail the current item in the current batch operation.
Important
Use this method carefully in managed change and Meridian Advanced Project Workflow operations, batch operations, or if references are involved. It could cause unexpected results.