Macros

<< Click to Display Table of Contents >>

Navigation:  GDI Print Directives >

Macros

PDFX supports macros for file naming and for headers/footers text.

%[Macro{:extra}]

Where Macro is a name of the macro value, and extra defines extra specifier for the macro. Items between {} are optional. Not all macros use an extra specifier, and will ignore all text after : up to closing bracket ]. The following macros are supported in PDFX:

Name

Values

Description

AppName

not defined

Name of the pdfsaver interface module: pdfsaver3.exe for PDFXv3,  pdfsaver5.exe for PDFXv5, or pdfsaver.exe for PDFXv9.

DocName

not defined

Filename of the document source file (stripped of the directory).

DocPath

not defined

The source file directory.

Date

Format string

Date the PDF was created (i.e. printed). Value can be formatted using format specified in extra part of the macro. When no extra is specified, default regional settings are used for formatting. See below for syntax of format string.

Year

not defined

Year number. Format of this number (two digits or four) depends from regional settings.

Month

not defined

Month number. Format depends from regional settings.

Day

not defined

Day of month (as digits). Format depends from regional settings.

Time

Format string

Time the PDF was created (printed). Value can be formatted using format specified in extra part of the macro. When no extra is specified, default regional settings are used for formatting. See below for syntax of format string

Hour

not defined

Hour of printing. Format depends from regional settings.

Minute

not defined

Minute of printing. Format depends from regional settings.

Second

not defined

Seconds of printing. Format depends from regional settings.

Computer

not defined

The name of user's computer.

User

not defined

The name (login name) of user who makes printing.

 

Format of picture string used to form the date string. The following elements can be used to construct a format picture string. If there are spaces to separate the elements in the format string, these spaces will appear in the same location in the result string. The letters must be in uppercase or lowercase as shown in the table, for example, "MM" not "mm". Characters in the format string that are enclosed in single quotation marks appear in the same location and unchanged in the output string.

Picture

Meaning

d

Day of month as digits with no leading zero for single-digit days.

dd

Day of month as digits with leading zero for single-digit days.

ddd

Day of week as a three-letter abbreviation. Depends of regional settings.

dddd

Day of week as its full name. Depends of regional settings.

M

Month as digits with no leading zero for single-digit months.

MM

Month as digits with leading zero for single-digit months.

MMM

Month as three-letter abbreviation. Depends of regional settings.

MMMM

Month as its full name. Depends of regional settings.

y

Year as last two digits, but with no leading zero for years less than 10.

yy

Year as last two digits, with leading zero for years less than 10.

yyyy

Year represented by full four or five digits, depending of the calendar used. Thai Buddhist and Korean calendars both have five digit year. The "yyyy" pattern will show five digits for these two calendars, and four digits for all other supported calendars.

yyyyy

Same as "yyyy".

gg

Period/era string. This element is ignored if the date does not have an associated era or period string. Depends of regional settings.

 

Format of picture string used to form the time string. The following elements can be used to construct a format picture string.

Picture

Meaning

h

Hours with no leading zero for single-digit hours; 12-hour clock.

hh

Hours with leading zero for single-digit hours; 12-hour clock.

H

Hours with no leading zero for single-digit hours; 24-hour clock.

HH

Hours with leading zero for single-digit hours; 24-hour clock.

m

Minutes with no leading zero for single-digit minutes.

mm

Minutes with leading zero for single-digit minutes.

s

Seconds with no leading zero for single-digit seconds.

ss

Seconds with leading zero for single-digit seconds.

t

One character time marker string, such as A or P. Depends of regional settings.

tt

Multi-character time marker string, such as AM or PM. Depends of regional settings.

 

Compatibility

PDFXv5+ only

Example

//PDFX,Save.File,%[User]%[Time:HHmm]

//PDFX,HeadersFooters.Enabled,True

//PDFX,HeadersFooters.Header.Left.Value,Docname: %[DocPath]\%[DocName]

//PDFX,HeadersFooters.Header.Right.Value,Page %[Page] of %[Pages]