Document-Level Events

BarTender supports the running of Visual Basic Script (VBScript) in response to a variety of document-level events, including open, close, save, and a number of print-time events. You can call the Object Automation functions from within this VBScript to modify an object on your template before and during print jobs.

To enable VBScripting for document-level events

BarTender does not support automation for data entry controls. If you try to use an Object property in a data entry script (such as the OnPrePrompt or OnPostPrompt event), BarTender returns an error, and your script does not run.

Available Document Event Scripts

All of the available document event scripts are listed under Document Events in the Script pane. When you select an event and then create a script in the Editor pane, the script runs when the event occurs. For example, if you select OnOpen and then write a script for it, that script runs when the document is opened.

BarTender supports the following document events:

OnOpen: Runs the script when the document is opened.
OnSave: Runs the script when the document is saved.
OnClose: Runs the script when the document is closed.
OnPrintJobStart: Runs the script when you send your document to the printer.
OnNewRecord: Runs the script after BarTender reads a new database record during a print job.
OnSerialize: Runs the script when BarTender processes a new serial number during printing.
OnIdenticalCopies: Runs the script for every printed item, even if it is a copy.
OnPrintJobEnd: Runs the script at the completion of a print job.
OnPrintJobCancel: Runs the script when a print job is cancelled before it is completed.

Although Procedures for Document Events appears in the Script pane under Document Events, it is not really an event at all. This item is a collection of VBScript functions and subroutines that you write, which can be used by the scripts that you create for genuine document events. For more information, refer to Procedures.