PDF export

readPDFOptions

readPDFOptions(fileName)

Read PDF options from fileName.

savePDFOptions

savePDFOptions(fileName)

Save PDF options to fileName.

class PDFfile

Exporting PDF

Class PDFfile() provides the PDF exporting
for Python scripting as you know it from Save as PDF
menu.
Example:
pdf = PDFfile()
pdf.thumbnails = 1 # generate thumbnails too
pdf.file = 'mypdf.pdf'
pdf.save()

save

save() -> void

Save selected pages to pdf file.

Members

allowAnnots

Allow Adding Annotations and Fields. Bool value

allowChange

Allow Changing the Document. Bool value

allowCopy

Allow Copying Text and Graphics. Bool value

allowPrinting

Allow Printing the Document. Bool value

article

Save Linked Text Frames as PDF Articles
Bool value

binding

Choose binding.
0 - Left binding
1 - Right binding

bleedMarks

Create marks delimiting the bleed area.

bleedb

Bleed Bottom
Distance for bleed from the bottom of the physical page

bleedl

Bleed Left
Distance for bleed from the left of the physical page

bleedr

Bleed Right
Distance for bleed from the right of the physical page

bleedt

Bleed Top
Distance for bleed from the top of the physical page

bookmarks

Embed the bookmarks you created in your document.
These are useful for navigating long PDF documents.
Bool value

colorMarks

Add color calibration bars.

compress

Compression switch. Bool value.

compressmtd

Compression method.
0 - Automatic
1 - JPEG
2 - zip
3 - None.

cropMarks

Create crop marks in the PDF indicating where the paper should be cut or trimmed after printing.

displayBookmarks

Display the bookmarks upon opening

displayFullscreen

Display the document in full screen mode upon opening.

displayLayers

Display the layer list upon opening. Useful only for PDF 1.5+.

displayThumbs

Display the page thumbnails upon opening

doClip

Do not show objects outside the margins in the exported file

docInfoMarks

Add document information which includes the document title and page numbers.

domulti

Produce a PDF File for every Page. Bool value

downsample

Downsample image resolusion to this value. Values from 35 to 4000
Set 0 for not to downsample

effval

List of effection values for each saved page.
It is a list of list of six integers. Those int have the following meaning:
- Length of time the page is shown before the presentation
starts on the selected page. (1-3600)
- Length of time the effect runs. (1 - 3600)
A shorter time will speed up the effect,
a longer one will slow it down
- Type of the display effect
0 - No Effect
1 - Blinds
2 - Box
3 - Dissolve
4 - Glitter
5 - Split
6 - Wipe
- Direction of the effect of moving lines
for the split and blind effects.
0 - Horizontal
1 - Vertical
- Starting position for the box and split effects.
0 - Inside
1 - Outside
- Direction of the glitter or wipe effects.
0 - Left to Right
1 - Top to Bottom
2 - Bottom to Top
3 - Right to Left
4 - Top-left to Bottom-Right

embedPDF

Export EPS and PDFs in image frames as embedded PDFs. This does not yet take care of colorspaces, so you should know what you are doing before setting this to 'true'.

encrypt

Use Encription. Bool value

file

Name of file to save into

fitWindow

Fit the document page or pages to the available space in the viewer window.

fontEmbedding

Font embedding mode.
Value must be one of integers: 0 (Embed), 1 (Outline), 2 (No embedding).

fonts

List of fonts to embed.

hideMenuBar

Hide the viewer menu bar, the PDF will display in a plain window.

hideToolBar

Hide the viewer toolbar. The toolbar has usually selection and other editing capabilities.

imagepr

Color profile for images

info

Mandatory string for PDF/X or the PDF will fail
PDF/X conformance. We recommend you use the title of the document.

intenti

Rendering intent for images
0 - Perceptual
1 - Relative Colorimetric
2 - Saturation
3 - Absolute Colorimetric

intents

Rendering intent for solid colors
0 - Perceptual
1 - Relative Colorimetric
2 - Saturation
3 - Absolute Colorimetric

isGrayscale

Export PDF in grayscale

lpival

Rendering Settings for individual colors.

This is a list of values for each color
Color values have structure [siii] which stand for:
s - Color name ('Black', 'Cyan', 'Magenta', 'Yellow')
i - Frequency (10 to 1000)
i - Angle (-180 to 180)
i - Spot Function
0 - Simple Dot
1 - Line
2 - Round
3 - Ellipse
Be careful when supplying these values as they
are not checked for validity.

markLength

Indicate the length of crop and bleed marks.

markOffset

Indicate the distance offset between mark and page area.

mirrorH

Mirror Page(s) horizontally

mirrorV

Mirror Page(s) vertically

noembicc

Don't use embedded ICC profiles. Bool value

openAction

Javascript to be executed when PDF document is opened.

outdst

Output destination.
0 - screen
1 - printer

owner

Owner's password

pageLayout

Document layout in PDF viewer:
0 - Show the document in single page mode
1 - Show the document in single page mode with the pages displayed continuously end to end like a scroll
2 - Show the document with facing pages, starting with the first page displayed on the left
3 - Show the document with facing pages, starting with the first page displayed on the right

pages

List of pages to print

presentation

Enable Presentation Effects.Bool value

printprofc

Output profile for printing. If possible, get some guidance from your printer on profile selection.

profilei

Embed a color profile for images. Bool value.

profiles

Embed a color profile for solid colors. Bool value.

quality

Image quality
0 - Maximum
1 - High
2 - Medium
3 - Low
4 - Minimum

registrationMarks

Add registration marks to each separation.

resolution

Resolution of output file. Values from 35 to 4000.

rotateDeg

Automatically rotate the exported pages
Value must be one of integers: 0, 90, 180 or 270

solidpr

Color profile for solid colors

subsetList

List of fonts to subsetted.

thumbnails

Generate thumbnails. Bool value.

useDocBleeds

Use the existing bleed settings from the document preferences. Bool value

useLayers

Layers in your document are exported to the PDF. Only available if PDF 1.5 is chosen.

uselpi

Use Custom Rendering Settings. Bool value

user

User's password

usespot

Use Spot Colors. Bool value

version

Choose PDF version to use:
10 = PDF/X4
11 = PDF/X1a
12 = PDF/X-3
13 = PDF 1.3 (Acrobat 4)
14 = PDF 1.4 (Acrobat 5)
15 = PDF 1.5 (Acrobat 6)