*ATTACH (PRTPAGE)
9.6A, PLBCMP GUI Only
*ATTACH={svarslit}
This advanced print control takes a comma separated list of fields as provided in the {svarslit} data string to specify parameters that allow an attachment to be embedded into a PDF output file along with other pertinent information. Each field is composed of a field identifier assigned using a '=' character followed by field data. The data field data can be specified with or without double quote characters. The 'F' field is required while all other *ATTACH data fields are optional when embedding an attachment in a PDF output file.
The following *ATTACH fields are supported:
A user specified string that may or may not include double quote characters.
A date string is specified as a YYYMMDDhhmmss format.
Fields:
|
Field |
Optional |
Specifies a ... |
|
C or C={value} |
Yes |
creation date for the attachment file. If the value is specified by the user application, the specified value is a static date that is output to the PDF file. If the value is not specified, the value is the current OS creation date for the attachment file when the PDF file is created. |
|
D={value} |
Yes |
user specific description for the attachment to be included in the PDF output file. |
|
F={value} |
No |
fully qualified path and file name to be embedded in the PDF output file as an attachment. Please note that the attachment file must be available when the PDF file is created. |
|
I |
Yes |
an icon that represents the attachment by a PDF reader. The value for the 'I' field can be specified as one of the following decimal ASCII characters:
0 - Paperclip(default if 'I' not used) 1 - Attachment 2 - Graph 3 - Tag |
|
M or M={value} |
Yes |
modification date for the attachment file. If the field is specified by the user application, the specified value is a static date that is output to the PDF file. If the field is not specified, the value is the current OS modification date for the attachment file when the PDF file is created. |
|
O={value} |
Yes |
output file name that is created by a PDF reader for the attachment specified by the 'F' field. If the 'O' filename is not specified, the 'F' filename is used by default. |
|
P={value} |
Yes |
position where an icon for the attachment is to be placed. If this 'P' field is not specified, the icon for an attachment is placed at the current print position. If the field is specified as a 't:b:l:r' data, the 't', 'b', 'l', and 'r' are specified as a decimal characters to represent the position of the icon. In addition, when the 't:b:l:r' syntax format is used, the 'b' and 'r' values can be specified as a zero (0) character. In this case, the 't' and 'l' location identifies the position of the top/left of the attachment icon. The 't', 'b', 'l', and 'r' decimal values represent the number of units as applied by the *UNITS list control for a PRTPAGE instruction. |
|
T={value} |
Yes |
title to be put into the PDF output file for the attachment file. |
Note:
The *ATTACH print control can be executed at any point in the generation of a PDF output file. Also, the PRTPAGE *ATTACH print control can be executed more than one time.
The *ATTACH file name as specified by the 'F=' field can use a vertical bar '|' character appended to the file name so an IP address or URL can be applied. This allows the attachment to be retrieved from a Data Manager. To avoid any conflicts with the field comma delimiter, the double quote '"' characters can be used for the field.
Examples of the *ATTACH print control:
See Also: List Controls (PRTPAGE), PRTPAGE
|
|