FOM Reference > Application > Printers > fPDFPrinter interface
  
fPDFPrinter interface
This object represents a PDF printer device.
This object inherits from fPrinter.
PDFColorMode enumeration
The color mode to use.
The PDFColorMode enumeration has the following constants of type int.
MODE_COLOR = 0
Use normal colors in the PDF.
MODE_MONOCHROME = 1
Convert all colors to monochrome.
MODE_RGB = 2
Convert all colors to RGB.
MODE_CMYK = 3
Convert all colors to CMYK.
MODE_CMYK_SPOT = 4
Convert all colors to CMYK and use spot colors.
PDFMonoCompression enumeration
The options to compress monochrome images.
The PDFMonoCompression enumeration has the following constants of type int.
MONO_AUTOMATIC = -1
Use normal compression.
MONO_NONE = 0
Use no compression.
MONO_RUNLENGTH = 1
Use Run Length compression.
MONO_CCITT3 = 2
Use CCITT Group 3 compression.
MONO_CCITT4 = 3
Use CCITT Group 4 compression.
MONO_ZIP = 4
Use Flate ZIP compression.
PDFImageCompression enumeration
The options to compress greyscale and color images.
The PDFImageCompression enumeration has the following constants of type int.
COMPRESS_AUTOMATIC = -1
Use normal compression.
COMPRESS_NONE = 0
Use no compression.
COMPRESS_RUNLENGTH = 1
Use Run Length compression.
COMPRESS_ZIP = 4
Use Flate ZIP compression.
COMPRESS_JPEG = 5
Use JPEG compression.
PDFCompressionQuality enumeration
The options for compression quality.
The PDFCompressionQuality enumeration has the following constants of type int.
QUALITY_MINIMIUM = 0
Use minimum compression.
QUALITY_LOW = 1
Use low compression.
QUALITY_MEDIUM = 2
Use medium compression.
QUALITY_HIGH = 3
Use high compression.
QUALITY_MAXIMUM = 4
Use maximum compression.
PDFDownsampleMode enumeration
The options for image downsampling mode.
The PDFDownsampleMode enumeration has the following constants of type int.
DOWNSAMPLE_OFF = 0
Do not downsample images.
DOWNSAMPLE_SUBSAMPLE = 1
Use simple subsampling.
DOWNSAMPLE_AVERAGE = 2
Use averaging algorithm to downsample image.
DOWNSAMPLE_BICUBIC = 3
Use bicubic algorithm to downsample image.
PDFVersions enumeration
The available PDF versions.
The PDFVersions enumeration has the following constants of type int.
VERSION_PDF13 = 4
PDF 1.3
VERSION_PDF14 = 5
PDF 1.4
VERSION_PDF15 = 6
PDF 1.5
VERSION_PDF16 = 7
PDF 1.6
VERSION_PDF17 = 8
PDF 1.7
VERSION_PDF17EXT3 = 9
PDF 1.7ext3
PDFXStandards enumeration
The available PDF-X standards.
The PDFXStandards enumeration has the following constants of type int.
PDFX_NONE = 0
None
PDFX_1A_2001 = 1
PDF/X-1a 2001
PDFX_1A_2003 = 2
PDF/X-1a 2003
PDFX_3_2002 = 3
PDF/X-3 2002
PDFX_3_2003 = 4
PDF/X-3 2003
PDFX_4 = 5
PDF/X-4
PDFX_4P = 6
PDF/X-4p
PDFX_5G = 7
PDF/X-5g
PDFX_5PG = 8
PDF/X-5pg
PDFAStandards enumeration
The available PDF-A standards.
The PDFAStandards enumeration has the following constants of type int.
PDFA_NONE = 0
None
PDFX_1A_2005 = 1
PDF/A-1a 2005
PDFX_1B_2005 = 2
PDF/A-1b 2005
PDFUAStandards enumeration
The available PDF-UA standards.
The PDFUAStandards enumeration has the following constants of type int.
PDFUA_NONE = 0
None
PDFUA_1 = 1
PDF/A-1a 2005
PDFXStandardIntents enumeration
The available PDF-X standard output intents.
The PDFXStandardIntents enumeration has the following constants of type int.
PDFXINTENT_NONE = 0
None
PDFXINTENT_CGATSTR001 = 1
CGATS TR 001 standard output intent.
PDFXINTENT_CGATSTR002 = 2
CGATS TR 002 standard output intent.
PDFXINTENT_CGATSTR003 = 3
CGATS TR 003 standard output intent.
PDFXINTENT_CGATSTR005 = 4
CGATS TR 005 standard output intent.
PDFXINTENT_CGATSTR006 = 5
CGATS TR 006 standard output intent.
PDFXINTENT_EUROSB104 = 6
EUROSB104 standard output intent.
PDFXINTENT_EUROSB204 = 7
EUROSB204 standard output intent.
PDFXINTENT_FOGRA27 = 8
FOGRA27 standard output intent.
PDFXINTENT_FOGRA28 = 9
FOGRA28 standard output intent.
PDFXINTENT_FOGRA29 = 10
FOGRA29 standard output intent.
PDFXINTENT_FOGRA30 = 11
FOGRA30 standard output intent.
PDFXINTENT_FOGRA31 = 12
FOGRA31 standard output intent.
PDFXINTENT_FOGRA32 = 13
FOGRA32 standard output intent.
PDFXINTENT_FOGRA33 = 14
FOGRA33 standard output intent.
PDFXINTENT_FOGRA34 = 15
FOGRA34 standard output intent.
PDFXINTENT_FOGRA35 = 16
FOGRA35 standard output intent.
PDFXINTENT_FOGRA36 = 17
FOGRA36 standard output intent.
PDFXINTENT_FOGRA37 = 18
FOGRA37 standard output intent.
PDFXINTENT_FOGRA38 = 19
FOGRA38 standard output intent.
PDFXINTENT_FOGRA39 = 20
FOGRA39 standard output intent.
PDFXINTENT_FOGRA40 = 21
FOGRA40 standard output intent.
PDFXINTENT_FOGRA41 = 22
FOGRA41 standard output intent.
PDFXINTENT_FOGRA42 = 23
FOGRA42 standard output intent.
PDFXINTENT_FOGRA43 = 24
FOGRA43 standard output intent.
PDFXINTENT_FOGRA44 = 25
FOGRA44 standard output intent.
PDFXINTENT_IFRA26 = 26
IFRA26 standard output intent.
PDFXINTENT_JC200103 = 27
JC200103 standard output intent.
PDFXINTENT_JC200104 = 28
JC200104 standard output intent.
PDFXINTENT_JCN2002 = 29
JCN2002 standard output intent.
PDFXINTENT_JCW2003 = 30
JCW2003 standard output intent.
actionDocumentOpen attribute
The PDF Action to apply when the PDF document is opened. The type of this action must be fPDFAction-TYPE_DOCUMENTOPEN, otherwise it will be ignored.
actionDocumentOpen
Access
read-write
Returns
fPDFAction
artbox attribute
If true, output Art Box.
artbox
Access
read-write
Returns
boolean
bleedbox attribute
If true, output Bleed Box.
bleedbox
Access
read-write
Returns
boolean
colorCompression attribute
How to compress color images. Value is one of fPDFPrinter.PDFImageCompression
colorCompression
Access
read-write
Returns
int
colorDownsampleDPI attribute
The DPI to use when downsampling color images.
colorDownsampleDPI
Access
read-write
Returns
int
colorDownsampleMode attribute
How to downsample color images. Value is one of fPDFPrinter.PDFDownsampleMode
colorDownsampleMode
Access
read-write
Returns
int
colorDownsampleThreshold attribute
The minimum color image DPI to trigger downsampling.
colorDownsampleThreshold
Access
read-write
Returns
int
colorMode attribute
Which color mode to use. Value is one of fPDFPrinter.PDFColorMode
colorMode
Access
read-write
Returns
int
colorQuality attribute
The level of quality to use when compressing color images. Value is one of fPDFPrinter.PDFCompressionQuality
colorQuality
Access
read-write
Returns
int
compatibility attribute
Acrobat compatibility. The default is 7 (PDF 1.6). Value is one of fPDFPrinter.PDFVersions
compatibility
Access
read-write
Returns
int
compressText attribute
If true, text and line art will be compressed.
compressText
Access
read-write
Returns
boolean
cropbox attribute
If true, output Crop Box.
cropbox
Access
read-write
Returns
boolean
defaultLanguage attribute
The default language country code to specify in the PDF.
defaultLanguage
Access
read-write
Returns
String
epsDPI attribute
The DPI to use when printing EPS files.
epsDPI
Access
read-write
Returns
int
fileFrequency attribute
Specifies how many files to create while printing. Value is one of fPrinter.PrinterFileFrequency
fileFrequency
Access
read-write
Returns
int
filename attribute
The file to print the document to.
filename
Access
read-write
Returns
String
generateFormItems attribute
If true, generate PDF Form Items if the specified PDF standards permit them.
generateFormItems
Access
read-write
Returns
boolean
generateLayers attribute
If true, any PDF Layers will be output to the PDF.
generateLayers
Access
read-write
Returns
boolean
greyscaleCompression attribute
How to compress greyscale images. Value is one of fPDFPrinter.PDFImageCompression
greyscaleCompression
Access
read-write
Returns
int
greyscaleDownsampleDPI attribute
The DPI to use when downsampling greyscale images.
greyscaleDownsampleDPI
Access
read-write
Returns
int
greyscaleDownsampleMode attribute
How to downsample greyscale images. Value is one of fPDFPrinter.PDFDownsampleMode
greyscaleDownsampleMode
Access
read-write
Returns
int
greyscaleDownsampleThreshold attribute
The minimum greyscale image DPI to trigger downsampling.
greyscaleDownsampleThreshold
Access
read-write
Returns
int
greyscaleQuality attribute
The level of quality to use when compressing greyscale images. Value is one of fPDFPrinter.PDFCompressionQuality
greyscaleQuality
Access
read-write
Returns
int
imagePassthrough attribute
If true, pass all linked images direct to the PDF without any conversion. If false, the value of fPDFPrinter.originalImages will be used.
imagePassthrough
Access
read-write
Returns
boolean
includeMedia attribute
If true, output media objects if the specified PDF standards permit them.
includeMedia
Access
read-write
Returns
boolean
linkColor attribute
Border color of PDF links.
linkColor
Access
read-write
Returns
fColor
mediaAssets attribute
The fPDFMediaAssets control stream containing a list of media assets to load into the PDF when using fFormatting.addMedia().
mediaAssets
Access
read-write
Returns
fPDFMediaAssets
monochromeCompression attribute
How to compress monochrome images. Value is one of fPDFPrinter.PDFMonoCompression
monochromeCompression
Access
read-write
Returns
int
monochromeDownsampleDPI attribute
The DPI to use when downsampling monochrome images.
monochromeDownsampleDPI
Access
read-write
Returns
int
monochromeDownsampleMode attribute
How to downsample monochrome images. Value is one of fPDFPrinter.PDFDownsampleMode
monochromeDownsampleMode
Access
read-write
Returns
int
monochromeDownsampleThreshold attribute
The minimum monochrome image DPI to trigger downsampling.
monochromeDownsampleThreshold
Access
read-write
Returns
int
originalImages attribute
If true, use the full image. Otherwise use the draft version of the image.
originalImages
Access
read-write
Returns
boolean
outlinePlaceholders attribute
When generating PDF Bookmarks, should an 'Outline Placeholder' entry be inserted for missing levels. Default is true.
If false, a bookmarks level will be reduced to compensate for the missing levels.
outlinePlaceholders
Access
read-write
Returns
boolean
printerColor attribute
If true, use the printer versions of the colors. Otherwise use the normal screen color.
printerColor
Access
read-write
Returns
boolean
profileCMYK attribute
The name of the default color profile to use for CMYK.
profileCMYK
Access
read-write
Returns
String
profileGreyscale attribute
The name of the default color profile to use for greyscale.
profileGreyscale
Access
read-write
Returns
String
profileRGB attribute
The name of the default color profile to use for RGB, or "sRGB" to use the built-in sRGB profile.
profileRGB
Access
read-write
Returns
String
propertyAuthor attribute
Include the Author document property in the PDF.
propertyAuthor
Access
read-write
Returns
boolean
propertyCustom attribute
Include the Custom document properties in the PDF.
propertyCustom
Access
read-write
Returns
boolean
propertyInterface attribute
Include the Interface Options document property in the PDF.
propertyInterface
Access
read-write
Returns
boolean
propertyKeywords attribute
Include the Keywords document property in the PDF.
propertyKeywords
Access
read-write
Returns
boolean
propertyMagnification attribute
Include the Initial View - Magnification document property in the PDF.
propertyMagnification
Access
read-write
Returns
boolean
propertyOpenOnPage attribute
Include the Initial View - Open On Page document property in the PDF.
propertyOpenOnPage
Access
read-write
Returns
boolean
propertyPageLayout attribute
Include the Initial View - Page Layout document property in the PDF.
propertyPageLayout
Access
read-write
Returns
boolean
propertyShow attribute
Include the Initial View - Show document property in the PDF.
propertyShow
Access
read-write
Returns
boolean
propertyShowWindow attribute
Include the Initial View - Show Window document property in the PDF.
propertyShowWindow
Access
read-write
Returns
boolean
propertySubject attribute
Include the Subject document property in the PDF.
propertySubject
Access
read-write
Returns
boolean
propertyTitle attribute
Include the Title document property in the PDF.
propertyTitle
Access
read-write
Returns
boolean
propertyWindow attribute
Include the Initial View - Window document property in the PDF.
propertyWindow
Access
read-write
Returns
boolean
securityMasterPassword attribute
The master password for the PDF, or empty for no password.
securityMasterPassword
Access
read-write
Returns
String
securityNoAccessible attribute
If true, the user will not be able to extract text for accessibility from the PDF.
securityNoAccessible
Access
read-write
Returns
boolean
securityNoAnnots attribute
If true, the user will not be able to create or change annotations in the PDF.
securityNoAnnots
Access
read-write
Returns
boolean
securityNoAssemble attribute
If true, the user will not be able to insert, delete or modify pages, bookmarks or thumbnails in the PDF.
securityNoAssemble
Access
read-write
Returns
boolean
securityNoCopy attribute
If true, the user will not be able to copy or extract text and graphics from the PDF.
securityNoCopy
Access
read-write
Returns
boolean
securityNoForms attribute
If true, the user will not be able to modify forms in the PDF.
securityNoForms
Access
read-write
Returns
boolean
securityNoHiresPrint attribute
If true, the user will only be able to print a low resolution version of the PDF.
securityNoHiresPrint
Access
read-write
Returns
boolean
securityNoModify attribute
If true, the user will not be able to edit the PDF.
securityNoModify
Access
read-write
Returns
boolean
securityNoPrint attribute
If true, the user will not be able to print the PDF.
securityNoPrint
Access
read-write
Returns
boolean
securityUserPassword attribute
The user password for the PDF, or empty for no password.
securityUserPassword
Access
read-write
Returns
String
standardsOutputIntent attribute
The name of the ICC color profile to use if PDF/X or PDF/A standards are specified.
standardsOutputIntent
Access
read-write
Returns
String
standardsOutputIntentURL attribute
The URL of the ICC color profile to use if either PDF/X-4p or PDF/X-5pg are specified.
standardsOutputIntentURL
Access
read-write
Returns
String
standardsPDFA attribute
The level of PDF/A to support. Setting this value to anything other than fPDFPrinter-PDFA_NONE will override fPDFPrinter.compatibility. Value is one of fPDFPrinter.PDFAStandards.
standardsPDFA
Access
read-write
Returns
int
standardsPDFUA attribute
The level of PDF/UA to support. Setting this value to anything other than fPDFPrinter-PDFUA_NONE will override fPDFPrinter.compatibility. Value is one of fPDFPrinter.PDFUAStandards.
standardsPDFUA
Access
read-write
Returns
int
standardsPDFX attribute
The level of PDF/X to support. Setting this value to anything other than fPDFPrinter-PDFX_NONE will override fPDFPrinter.compatibility. Value is one of fPDFPrinter.PDFXStandards.
standardsPDFX
Access
read-write
Returns
int
standardsPDFXStandardIntent attribute
The standard output intent to use if a PDF/X standard is specified. Value is one of fPDFPrinter.PDFXStandardIntents.
standardsPDFXStandardIntent
Access
read-write
Returns
int
subsetFonts attribute
If true, subset TrueType fonts used in the document.
subsetFonts
Access
read-write
Returns
boolean
subsetPercent attribute
The percentage threshold when subsetting fonts.
subsetPercent
Access
read-write
Returns
int
taggedPDF attribute
If true, any PDF tagging instructions will be output to the PDF.
taggedPDF
Access
read-write
Returns
boolean
trimbox attribute
If true, output Trim Box.
trimbox
Access
read-write
Returns
boolean
webOptimize attribute
If true, optimize document for fast web view.
webOptimize
Access
read-write
Returns
boolean
xmpMetadata attribute
A file containing XMP Metadata to merge into the automatically generated XMP when creating the PDF.
xmpMetadata
Access
read-write
Returns
String
fPDFPrinter method
Creates a new PDF Printer device.
fPDFPrinter
Parameters
None
Returns
fPDFPrinter. A new object of class fPDFPrinter.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fPDFPrinter. The object corresponding to the serialized representation.