<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Python: class PDFfile
</title>
</head>
<body>
<h2>Python: class PDFfile
</h2>
<p><a name="PDFfile">class
<strong>PDFfile
</strong></a>(
<a href="__builtin__.html#object">object
</a>)
</p>
<hr />
<p>Methods defined here:
</p>
<dl>
<dt><a name="PDFfile-Save"><strong>Save
</strong></a>(...)
</dt>
<dd><code>This method is deprecated - use
<a href="#PDFfile-save">save
</a>() instead.
</code></dd>
<dt><a name="PDFfile-__init__"><strong>__init__
</strong></a>(...)
</dt>
<dd><code>x.
<a href="#PDFfile-__init__">__init__
</a>(...) initializes x; see x.__class__.__doc__ for signature
</code></dd>
<dt><a name="PDFfile-save"><strong>save
</strong></a>(...)
</dt>
<dd><code>Save selected pages to pdf file
</code></dd>
</dl>
<hr>
<p>Data and other attributes defined here:
</p>
<dl>
<dt><strong>__new__
</strong> =
<built-in method __new__ of type object
></dt>
<dd><code>T.
<a href="#PDFfile-__new__">__new__
</a>(S, ...) -
> a new object with type S, a subtype of T
</code></dd>
<dt><strong>aanot
</strong> =
<member 'aanot' of 'PDFfile' objects
></dt>
<dd><code>Allow Adding Annotations and Fields. Bool value
</code></dd>
<dt><strong>achange
</strong> =
<member 'achange' of 'PDFfile' objects
></dt>
<dd><code>Allow Changing the Document. Bool value
</code></dd>
<dt><strong>acopy
</strong> =
<member 'acopy' of 'PDFfile' objects
></dt>
<dd><code>Allow Copying Text and Graphics. Bool value
</code></dd>
<dt><strong>aprint
</strong> =
<member 'aprint' of 'PDFfile' objects
></dt>
<dd><code>Allow Printing the Document. Bool value
</code></dd>
<dt><strong>article
</strong> =
<member 'article' of 'PDFfile' objects
></dt>
<dd><code>Save Linked Text Frames as PDF Articles
<br> Bool value
</code></dd>
<dt><strong>binding
</strong> =
<member 'binding' of 'PDFfile' objects
></dt>
<dd><code>Choose binding.
<br>
0 - Left binding
<br>
1 - Right binding
</code></dd>
<dt><strong>bleedMarks
</strong> =
<attribute 'bleedMarks' of 'PDFfile' objects
></dt>
<dd><code>Create marks delimiting the bleed area.
</code></dd>
<dt><strong>bleedb
</strong> =
<member 'bleedb' of 'PDFfile' objects
></dt>
<dd><code>Bleed Bottom
<br>Distance for bleed from the bottom of the physical page
</code></dd>
<dt><strong>bleedl
</strong> =
<member 'bleedl' of 'PDFfile' objects
></dt>
<dd><code>Bleed Left
<br>Distance for bleed from the left of the physical page
</code></dd>
<dt><strong>bleedr
</strong> =
<member 'bleedr' of 'PDFfile' objects
></dt>
<dd><code>Bleed Right
<br>Distance for bleed from the right of the physical page
</code></dd>
<dt><strong>bleedt
</strong> =
<member 'bleedt' of 'PDFfile' objects
></dt>
<dd><code>Bleed Top
<br>Distance for bleed from the top of the physical page
</code></dd>
<dt><strong>bookmarks
</strong> =
<member 'bookmarks' of 'PDFfile' objects
></dt>
<dd><code>Embed the bookmarks you created in your document.
<br>These are useful for navigating long PDF documents.
<br>Bool value
</code></dd>
<dt><strong>colorMarks
</strong> =
<member 'colorMarks' of 'PDFfile' objects
></dt>
<dd><code>Add color calibration bars.
</code></dd>
<dt><strong>compress
</strong> =
<member 'compress' of 'PDFfile' objects
></dt>
<dd><code>Compression switch. Bool value.
</code></dd>
<dt><strong>compressmtd
</strong> =
<member 'compressmtd' of 'PDFfile' objects
></dt>
<dd><code>Compression method.
<br>
0 - Automatic
<br>
1 - JPEG
<br>
2 - zip
<br>
3 - None.
</code></dd>
<dt><strong>cropMarks
</strong> =
<attribute 'cropMarks' of 'PDFfile' objects
></dt>
<dd><code>Create crop marks in the PDF indicating where the paper should be cut or trimmed after printing.
</code></dd>
<dt><strong>displayBookmarks
</strong> =
<attribute 'displayBookmarks' of 'PDFfile' objects
></dt>
<dd><code>Display the bookmarks upon opening.
</code></dd>
<dt><strong>displayFullscreen
</strong> =
<attribute 'displayFullscreen' of 'PDFfile' objects
></dt>
<dd><code>Display the document in full screen mode upon opening.
</code></dd>
<dt><strong>displayLayers
</strong> =
<attribute 'displayLayers' of 'PDFfile' objects
></dt>
<dd><code>Display the layer list upon opening. Useful only for PDF 1.5+.
</code></dd>
<dt><strong>displayThumbs
</strong> =
<attribute 'displayThumbs' of 'PDFfile' objects
></dt>
<dd><code>Display the page thumbnails upon opening.
</code></dd>
<dt><strong>docInfoMarks
</strong> =
<member 'docInfoMarks' of 'PDFfile' objects
></dt>
<dd><code>Add document information which includes the document title and page numbers.
</code></dd>
<dt><strong>doClip
</strong> =
<attribute 'doClip' of 'PDFfile' objects
></dt>
<dd><code>Do not show objects outside the margins in the exported file.
</code></dd>
<dt><strong>downsample
</strong> =
<attribute 'downsample' of 'PDFfile' objects
></dt>
<dd><code>Downsample image resolusion to this value. Values from 35 to 4000
<br>Set 0 for not to downsample
</code></dd>
<dt><strong>effval
</strong> =
<attribute 'effval' of 'PDFfile' objects
></dt>
<dd><code>List of effection values for each saved page.
<br>
<pre>
It is 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
</pre></code></dd>
<dt><strong>embedPDF
</strong> =
<member 'embedPDF' of 'PDFfile' objects
></dt>
<dd><code>Export PDFs in image frames as embedded PDFs.
<br>
This does *not* yet take care of colorspaces, so you should know what you are doing before setting this to 'true'.
<br>
Bool value.
</code></dd>
<dt><strong>encrypt
</strong> =
<member 'encrypt' of 'PDFfile' objects
></dt>
<dd><code>Use Encription. Bool value
</code></dd>
<dt><strong>file
</strong> =
<attribute 'file' of 'PDFfile' objects
></dt>
<dd><code>Name of file to save into
</code></dd>
<dt><strong>fitWindow
</strong> =
<attribute 'fitWindow' of 'PDFfile' objects
></dt>
<dd><code>Fit the document page or pages to the available space in the viewer window.
</code></dd>
<dt><strong>fonts
</strong> =
<attribute 'fonts' of 'PDFfile' objects
></dt>
<dd><code>List of fonts to embed.
</code></dd>
<dt><strong>hideMenuBar
</strong> =
<attribute 'hideMenuBar' of 'PDFfile' objects
></dt>
<dd><code>Hides the viewer menu bar, the PDF will display in a plain window.
</code></dd>
<dt><strong>hideToolBar
</strong> =
<attribute 'hideToolBar' of 'PDFfile' objects
></dt>
<dd><code>Hides the viewer toolbar. The toolbar has usually selection and other editing capabilities.
</code></dd>
<dt><strong>imagepr
</strong> =
<attribute 'imagepr' of 'PDFfile' objects
></dt>
<dd><code>Color profile for images
</code></dd>
<dt><strong>info
</strong> =
<attribute 'info' of 'PDFfile' objects
></dt>
<dd><code>Mandatory string for PDF/X-3 or the PDF will fail PDF/X-3 conformance. We recommend you use the title of the document.
</code></dd>
<dt><strong>intenti
</strong> =
<member 'intenti' of 'PDFfile' objects
></dt>
<dd><code>Rendering intent for images
<br>
0 - Perceptual
<br>
1 - Relative Colorimetric
<br>
2 - Saturation
<br>
3 - Absolute Colorimetric
</code></dd>
<dt><strong>intents
</strong> =
<member 'intents' of 'PDFfile' objects
></dt>
<dd><code>Rendering intent for solid colors
<br>
0 - Perceptual
<br>
1 - Relative Colorimetric
<br>
2 - Saturation
<br>
3 - Absolute Colorimetric
</code></dd>
<dt><strong>isGrayscale
</strong> =
<attribute 'isGrayscale' of 'PDFfile' objects
></dt>
<dd><code>Export PDF in grayscale.
</code></dd>
<dt><strong>lpival
</strong> =
<attribute 'lpival' of 'PDFfile' objects
></dt>
<dd><code>Rendering Settings for individual colors.
<br>
<pre>
This is 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
</pre>
Be careful when supplying these values as they are not checked for validity.
</code></dd>
<dt><strong>markOffset
</strong> =
<member 'markOffset' of 'PDFfile' objects
></dt>
<dd><code>Indicate the distance offset between mark and page area.
</code></dd>
<dt><strong>mirrorH
</strong> =
<member 'mirrorH' of 'PDFfile' objects
></dt>
<dd><code>Mirror Page(s) horizontally. Bool value.
</code></dd>
<dt><strong>mirrorV
</strong> =
<member 'mirrorV' of 'PDFfile' objects
></dt>
<dd><code>Mirror Page(s) vertically. Bool value.
</code></dd>
<dt><strong>noembicc
</strong> =
<member 'noembicc' of 'PDFfile' objects
></dt>
<dd><code>Don't use embedded ICC profiles. Bool value
</code></dd>
<dt><strong>outdst
</strong> =
<member 'outdst' of 'PDFfile' objects
></dt>
<dd><code>Output destination.
<br>
0 - screen
<br>
1 - printer
</code></dd>
<dt><strong>owner
</strong> =
<attribute 'owner' of 'PDFfile' objects
></dt>
<dd><code>Owner's password
</code></dd>
<dt><strong>pageLayout
</strong> =
<attribute 'pageLayout' of 'PDFfile' objects
></dt>
<dd><code>Document layout in PDF viewer:
<br>
0 - Show the document in single page mode
<br>
1 - Show the document in single page mode with the pages displayed continuously end to end like a scroll
<br>
2 - Show the document with facing pages, starting with the first page displayed on the left
<br>
3 - Show the document with facing pages, starting with the first page displayed on the right
</code></dd>
<dt><strong>pages
</strong> =
<attribute 'pages' of 'PDFfile' objects
></dt>
<dd><code>List of pages to print
</code></dd>
<dt><strong>presentation
</strong> =
<member 'presentation' of 'PDFfile' objects
></dt>
<dd><code>Enable Presentation Effects.Bool value
</code></dd>
<dt><strong>printprofc
</strong> =
<attribute 'printprofc' of 'PDFfile' objects
></dt>
<dd><code>Output profile for printing. If possible, get some guidance from your printer on profile selection.
</code></dd>
<dt><strong>profilei
</strong> =
<member 'profilei' of 'PDFfile' objects
></dt>
<dd><code>Embed a color profile for images. Bool value.
</code></dd>
<dt><strong>profiles
</strong> =
<member 'profiles' of 'PDFfile' objects
></dt>
<dd><code>Embed a color profile for solid colors. Bool value.
</code></dd>
<dt><strong>quality
</strong> =
<member 'quality' of 'PDFfile' objects
></dt>
<dd><code>Image quality
<br>
0 - Maximum
<br>
1 - High
<br>
2 - Medium
<br>
3 - Low
<br>
4 - Minimum
</code></dd>
<dt><strong>registrationMarks
</strong> =
<attribute 'registrationMarks' of 'PDFfile' objects
></dt>
<dd><code>Add registration marks to each separation.
</code></dd>
<dt><strong>resolution
</strong> =
<attribute 'resolution' of 'PDFfile' objects
></dt>
<dd><code>Resolution of output file. Values from 35 to 4000.
</code></dd>
<dt><strong>solidpr
</strong> =
<attribute 'solidpr' of 'PDFfile' objects
></dt>
<dd><code>Color profile for solid colors
</code></dd>
<dt><strong>thumbnails
</strong> =
<member 'thumbnails' of 'PDFfile' objects
></dt>
<dd><code>Generate thumbnails. Bool value.
</code></dd>
<dt><strong>usedocbleeds
</strong> =
<attribute 'usedocbleeds' of 'PDFfile' objects
></dt>
<dd><code>Use the existing bleed settings from the document preferences. Bool value.
</code></dd>
<dt><strong>useLayers
</strong> =
<attribute 'useLayers' of 'PDFfile' objects
></dt>
<dd><code>Layers in your document are exported to the PDF. Only available with PDF >= 1.5.
</code></dd>
<dt><strong>uselpi
</strong> =
<member 'uselpi' of 'PDFfile' objects
></dt>
<dd><code>Use Custom Rendering Settings. Bool value
</code></dd>
<dt><strong>user
</strong> =
<attribute 'user' of 'PDFfile' objects
></dt>
<dd><code>User's password
</code></dd>
<dt><strong>version
</strong> =
<member 'version' of 'PDFfile' objects
></dt>
<dd><code>Choose PDF version to use:
<br>
11 = PDF/X-1a
<br>
12 = PDF/X-3
<br>
13 = PDF 1.3 (Acrobat 4)
<br>
14 = PDF 1.4 (Acrobat 5)
<br>
15 = PDF 1.5 (Acrobat 6)
</code></dd>
</dl>
</body>
</html>