Please enable JavaScript to view this site.

PDFX Reference

Properties in this section define the PDF Specification to be applied to the created PDF file and the parameters for the PDF viewing application, which may be used to define the properties used when opening the document for Viewing.

Name

Values

Description

PDFXv3

Specification

0 (Auto)

3 (1.3)

4 (1.4)

5 (1.5)

6 (1.6)

7 (1.7)

-2 (PDFA-1b)

-3 (PDFA-1a)

-4 (PDFA-2a)

-5 (PDFA-2b)

-6 (PDFA-2u)

Defines the PDF Specification level to which the PDF file should conform. Value Auto (0), allows PDFX to сhoose the most efficient specification based on other specified options. When a negative number is specified, PDFX will create a PDF file which conforms to ISO standard PDF/A. Default = 0 (Auto).

PDFSpec
 
Note that PDF/A and PDF version 1.7 are not supported in PDFXv3.

PageLayout

0 (Default)

1 (SinglePage)

2 (OneColumn)

3 (TwoColumnLeft)

4 (TwoColumnRight)

5 (TwoPagesLeft)

6 (TwoPagesRight)

Default = 0

(same)

PageMode

0 (Default)

1 (ShowNone)

2 (Bookmarks)

3 (Thumbnails)

4 (Layers)

5 (Attachments)

6 (FullScreen)

Default = 0

(same)

FullScreenMode

0 (Default)

1 (ShowNone)

2 (Bookmarks)

3 (Thumbnails)

4 (OptionalContent)

Default = 0

(no V3)

MagnificationType

0 (Default)

1 (ActualSize)

2 (FitPage)

3 (FitWidth)

4 (FitHeight)

5 (Level)

Default = 0

(no V3)

MagnificationLevel

1-6400

Default = 100

(no V3)

OpenToPage

 

Default = 0 (first page)

(no V3)

HideToolbars

Boolean

Default = False

VP.HideToolbars

HideMenubar

Boolean

Default = False

VP.HideMenubar

HideUI

Boolean

Default = False

(no V3)

FitWindow

Boolean

Default = False

VP.Fit

CenterWindow

Boolean

Default = False

VP.Center

ShowDocTitle

Boolean

Default = False

VP.ShowTitle

 

Comments

All of the above properties except Specification are requests to the PDF viewer (although they are stored in the PDF document). Different viewers may or may not obey all of the requested options. In particular, some viewers may override the PageLayout, FitWindow, and/or CenterWindow options depending on how the viewer was previously configured or opened.

Caution

The PDFX directives are quite persnikety (that's the technical term) about formating. Be careful to write the commands exactly as shown here, make sure commas are commas and periods are periods. PDFX does NOT generate error messages, so you won't know that a command has failed unless you test for the expected condition.

Examples for PDFX5

//PDFX,General.MagnificationType,FitPage

//; scale the document to fit one page into the window (instruction to viewer)

 

//PDFX,General.OpenToPage,1

//; request opening to 2nd page (starting at 0)

 

//PDFX,General.Specification,5

//; direct that the PDF be produced using PDF version 1.5 specification

 

//PDFX,General.Specification,-3

//; direct that the PDF be produced using PDF/A (archive) specification, version 1a

 

Examples for PDFX3

//PDFX,General.PDFSpec,5

//; direct that the PDF be produced using PDF version 1.5 specification

 

//PDFX,General.FitWindow,1

//; tell PDF viewer to display document as big as possible within window

 

Compatibility

PDFXv3 supports only specifications 1.3 thru 1.6 and does not support PDF/A (Specification = negative number). Several of the above properties are new in PDFXv5, or have changed names. PDFXv3 names will be up-converted to be compatible with PDFXv5+ as needed, but not vice versa.