Regular Event Scripts

Regular Events are events which occur at a specific set instance, as opposed to special events, which have variable occurences. Regular events in BarTender can be called at differing intervals, from once per printed item, to once per print job. When applied once per printed item, the regular event will occur with each item that gets printed; alternatively, regular events set for the print job will only print once for the entire printed batch.

BarTender supports the use of the following regular event scripts:

• OnIdenticalCopies. Every single printed item.

  When you set a value greater than one in the Copies option on the Print dialog, BarTender can send the template to your printer once and instruct the printer to print the desired number of copies. However, if you write a script for the OnIdenticalCopies event, it will be executed for every item that is printed, even if the items are identical. This requires that BarTender disable the previously mentioned printer optimization, which can result in a significant loss in performance.

• OnNewRecord. Each new record (input file data only). When reading from a data source file, an OnNewRecord event script will be executed each time a new record is read from your database or text file at print-time.

• OnPrePrompt. Just before displaying the data entry form, if data entry is enabled.

• OnPostPrompt. After a user has pressed OK to close the data entry form.

• OnPrintEnd. When a print job has just finished.

• OnPrintStart. When a print job is about to start.

• OnScreenUpdate. Any time the string for the associated object is updated on the screen.

  OnScreenUpdate is unique because execution is not limited to print time only. Instead, an OnScreenUpdate event script but will execute any time an object is updated on the screen. Objects are updated on the screen in response to a number of events, including clicking OK to return to the template. Although other uses may exist, the most important task for this event is to write scripts that give an on-screen value to a non-printing object that is being used to create a print job log file.

• OnSerialize. When serialization might occur.

Open topic with navigation