Defines the path name of the output file. All files specified in the following input commands are placed in this output file.
Action sets that follow the output command, before any of the input commands are applied to the entire output file. In other words, their purpose is to modify the output pages. By default, the barcode, text and replace commands are applied to the first page, if not otherwise qualified by a pages command after output command.
To specify output file name.
output [file=]FileName [,[onexists=]OnExistsAction]
To set all output pages to the same size.
output [file=]FileName, frame=PageSize[:Alignment] [,[onexists=]OnExistsAction]
To apply barcode, text and replace commands to partially constructed output file.
output
FileName
Name of output file. Explicit or implicit (first position) value
OnExistsAction
Action to take if output file already exists. Optional explicit or implicit (valid action name) value. Valid values:
| overwrite | Overwrite existing file (default) |
| append | Append to existing file |
| error | Record an error, stop processing |
PageSize
Size of each page of output file, if frame is specified.
Valid values are: LEGAL, LETTER, A3, A4, A5, B4, B5, B6, C3, C4, C5, C6, C65, DL, E4, E5, E6, E65, M5, M65
Alignment
Position of input page on output page, if frame is specified. Valid values:
| topleft, tl, lt | Top left of input page is aligned with top left of output page. (Default) |
| topcenter, tc, ct | Top center of input page is aligned with top center of output page |
| topright, tr , rt | Top right of input page is aligned with top right of output page |
| bottomleft, bl, lb | Bottom left of input page is aligned with bottom left of output page |
| bottomcenter, bc, cb | Bottom center of input page is aligned with bottom center of output page |
| bottomright, br, rb | Bottom right of input page is aligned with bottom right of output page |
| center, c | Center of input page is aligned with center of output page |
| centerleft, cl, lc | Left center of input page is aligned with left center of output page |
| centerright, cr, rc | Right center of input page is aligned with right center of output page |
An output command line without any parameters, following any input commands, defines the newly appended input pages which now reside in the output file as the scope of operations for all the barcode, text and replace commands which follow. This allows page numbers and other meta data to refer to the set of output pages, rather than each separate set of the input pages.
When using a data source, the entire script file is executed for each record (row) of data source. If the output file name is the same for each records, OnExistsAction is ignored, then the append action is selected by default.
To create a unique output file for each record of the data source, use a data source variable as a part of output FileName
Use variable to name output file. Might come from data source.
output ${CustomerID}.pdf
Use name and path of input file to name output file
output ${inp.$dir}\${inp.$base}.pdf
Generate an error if output file already exists
output “c:\My Output Directory\MyOutput.pdf”, onexists=error
Append pages to an output file if already exists
output append, “c:\${Department}\${EmployeeID}.pdf”
Make all output pages of size legal. Align all input pages to the center of output page.
output “output.pdf”, frame=legal:c
Add a barcode to all pages from Input_1.pdf and Input_2.pdf (terminate the scope with a naked output command), then append Input_3.pdf, which will not receive the barcode.
output MyOutput.pdf
input Input_1.pdf
input Input_2.pdf
output
pages all
barcode ${docId}${pages}
input Input_3.pdf
Format |
Meaning |
Italic |
Information
that the user must supply |
Bold |
Elements that the user must type exactly as shown. |
Between brackets ([]) |
Optional
items |
Ellipsis (...) |
Parameter that can be repeated several times |