Predefined variable

Preset variables are derived from system, file and PDF file information and are always available at runtime.  The following groups are available:

System information

 

Name

Meaning

comp.$name

Computer name

comp.$user

User name

comp.$os

Windows version

comp.$date

Current date

comp.$time

Current time

comp.$now

Current date and time

comp.MyDocuments

My Documents folder (ending with \)

comp.TempPath

Temp folder (ending with \)

 

Current input or output file information

 

Name

Meaning

file.$name

File name (base name + extension)

file.$path

File full path

file.$dir

File folder

file.$base

Base name (no extension)

file.$ext

File extension

file.$created

Created date and time

file.$modified

Last modified data and time

Last input file information

 

Name

Meaning

inp.$name

File name (base name + extension)

inp.$path

File full path

inp.$dir

File folder

inp.$base

Base name (no extension)

inp.$ext

File extension

inp.$created

Created date and time

inp.$modified

Last modified data and time

PDF document properties

 

Name

Meaning

pdf.$author

PDF author property

pdf.$company

PDF company property

pdf.$creator

PDF creator property

pdf.$keywords

PDF keywords property

pdf.$producer

PDF producer property

pdf.$subject}

PDF subject property

pdf.$title

PDF title property

page

Current page number

page.auto

Current page number.  Fixed length

pages

Total page count in input or output

 
${page.auto} creates a constant length page number throughout document by left padding with zeroes.  The total length (1, 2, 3 or 4 digits) is the same as number of digits in ${pages}

Placement variables

 

Name

Meaning

anchor

Value of anchor used for anchor placement

last

Value for the last text or barcode
commands use for last placement

data.AnchorName

Value of AnchorName anchor variable

data.AnchorName.text

Value of anchor pattern associated with AnchorName anchor

Other variables

 

Name

Meaning

script.$base

Base name of current script file

script.$dir

File folder of current script file

samples.$dir

Directory of PDFImprint samples

nl

New line

_vars

List of user variables

file:FileName

Value is read from a file