Go to main content
1/21
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Conventions
Part I Getting Started with PDF Export
1
Introduction
1.1
Architectural Overview
1.2
Definition of Terms
1.3
Directory Structure
1.3.1
Installing Multiple SDKs
1.4
How to Use PDF Export
2
Implementation Issues
2.1
Running in 24x7 Environments
2.2
Running in Multiple Threads or Processes
2.3
PDF Export Issues
3
Sample Applications
3.1
Building the Samples on a Windows System
3.2
An Overview of the Sample Applications
3.2.1
pxsample
3.2.2
export (Windows Only)
3.2.2.1
The export Main Window
3.2.3
exsimple
3.2.4
exredir
3.2.5
extract_archive
3.2.6
pxanno
3.3
Accessing the SDK via a Java Wrapper
3.3.1
The ExJava Wrapper API
3.3.2
The C-Based Exporter Application
3.3.3
Compiling the Executables
3.3.4
The ExportTest Sample Application
3.3.5
An Example Conversion Using the ExJava Wrapper
Part II Using the C/C++ API
4
Windows Implementation Details
4.1
Installation
4.1.1
NSF Support
4.2
Libraries and Structure
4.2.1
API DLLs
4.2.2
Support DLLs
4.2.3
Engine Libraries
4.2.4
Filter and Export Filter Libraries
4.2.5
Premier Graphics Filters
4.2.6
Additional Files
4.3
The Basics
4.3.1
What You Need in Your Source Code
4.3.2
Options and Information Storage
4.3.3
Structure Alignment
4.3.4
Character Sets
4.3.5
Runtime Considerations
4.4
Default Font Aliases
4.5
Changing Resources
5
UNIX Implementation Details
5.1
Installation
5.1.1
NSF Support
5.2
Libraries and Structure
5.2.1
API Libraries
5.2.2
Support Libraries
5.2.3
Engine Libraries
5.2.4
Filter and Export Filter Libraries
5.2.5
Premier Graphics Filters
5.2.6
Additional Files
5.3
The Basics
5.3.1
What You Need in Your Source Code
5.3.2
Information Storage
5.4
Character Sets
5.5
Runtime Considerations
5.5.1
OLE2 Objects
5.5.2
Signal Handling
5.5.3
Runtime Search Path and $ORIGIN
5.6
Environment Variables
5.7
Default Font Aliases
5.8
Changing Resources
5.9
HP-UX Compiling and Linking
5.9.1
HP-UX on RISC
5.9.2
HP-UX on Itanium (64 bit)
5.10
IBM AIX Compiling and Linking
5.10.1
IBM AIX (32-bit pSeries)
5.11
Oracle Solaris Compiling and Linking
5.11.1
Oracle Solaris SPARC
5.12
Linux Compiling and Linking
5.12.1
Library Compatibility
5.12.1.1
GLIBC and Compiler Versions
5.12.1.2
Other Libraries
5.12.2
Compiling and Linking
5.12.2.1
Linux 32-bit
5.12.2.2
Linux 64-bit
6
Data Access Common Functions
6.1
Deprecated Functions
6.2
DAInitEx
6.3
DADeInit
6.4
DAOpenDocument
6.4.1
IOSPECLINKEDOBJECT Structure
6.4.2
IOSPECARCHIVEOBJECT Structure
6.4.3
SCCDAOBJECT Structure
6.5
DAOpenSubdocumentById
6.6
DAOpenNextDocument
6.7
DACloseDocument
6.8
DARetrieveDocHandle
6.9
DASetOption
6.10
DASetFileSpecOption
6.11
DAGetOption
6.12
DAGetFileId
6.13
DAGetFileIdEx
6.14
DAGetErrorString
6.15
DAGetObjectInfo
6.16
DAGetTreeCount
6.17
DAGetTreeRecord
6.17.1
SCCDATREENODE Structure
6.18
DAOpenTreeRecord
6.19
DASaveInputObject
6.20
DASaveTreeRecord
6.21
DACloseTreeRecord
6.22
DASetStatCallback
6.23
DASetFileAccessCallback
7
Export Functions
7.1
General Functions
7.1.1
EXOpenExport
7.1.2
EXCALLBACKPROC
7.1.3
EXCloseExport
7.1.4
EXRunExport
7.1.5
EXExportStatus
7.2
Annotation Functions
7.2.1
EXHiliteText
7.2.2
EXInsertText
7.2.3
EXHideText
7.2.3.1
EXANNOHIDETEXT Structure
7.2.4
EXApplyHilites
7.2.5
EXRedactText
8
Redirected IO
8.1
Using Redirected IO
8.2
Opening Files
8.3
IOClose
8.4
IORead
8.5
IOWrite
8.6
IOSeek
8.7
IOTell
8.8
IOGetInfo
8.8.1
IOGENSECONDARY and IOGENSECONDARYW Structures
8.8.2
File Types That Cause IOGETINFO_GENSECONDARY
8.9
IOSEEK64PROC / IOTELL64PROC
8.9.1
IOSeek64
8.9.2
IOTell64
9
Callbacks
9.1
EX_CALLBACK_ID_CREATENEWFILE
9.1.1
EXURLFILEIOCALLBACKDATA / EXURLFILEIOCALLBACKDATAW Structures
9.2
EX_CALLBACK_ID_NEWFILEINFO
9.3
EX_CALLBACK_ID_PAGECOUNT
9.4
EX_CALLBACK_ID_BEGINPAGE
10
PDF Export C/C++ Options
10.1
Character Mapping
10.1.1
SCCOPT_DEFAULTINPUTCHARSET
10.1.2
SCCOPT_UNMAPPABLECHAR
10.2
Input Handling
10.2.1
SCCOPT_FALLBACKFORMAT
10.2.2
SCCOPT_FIFLAGS
10.2.3
SCCOPT_FORMATFLAGS
10.2.4
SCCOPT_SYSTEMFLAGS
10.2.5
SCCOPT_IGNORE_PASSWORD
10.2.6
SCCOPT_LOTUSNOTESDIRECTORY
10.2.7
SCCOPT_PDF_FILTER_REORDER_BIDI
10.2.8
SCCOPT_REORDERMETHOD
10.2.9
SCCOPT_TIMEZONE
10.2.10
SCCOPT_HTML_COND_COMMENT_MODE
10.2.11
SCCOPT_ARCFULLPATH
10.2.12
SCCOPT_PDF_FILTER_MAX_EMBEDDED_OBJECTS
10.2.13
SCCOPT_PDF_FILTER_MAX_VECTOR_PATHS
10.2.14
SCCOPT_PDF_FILTER_WORD_DELIM_FRACTION
10.3
Compression
10.3.1
SCCOPT_APPLYFILTER
10.3.2
SCCOPT_FILTERJPG
10.3.3
SCCOPT_FILTERLZW
10.4
Graphics
10.4.1
SCCOPT_GRAPHIC_OUTPUTDPI
10.4.2
SCCOPT_GRAPHIC_SIZEMETHOD
10.4.3
SCCOPT_IMAGE_PASSTHROUGH
10.4.4
SCCOPT_RENDER_ENABLEALPHABLENDING
10.5
Spreadsheet and Database File Rendering
10.5.1
SCCOPT_DBPRINTFITTOPAGE
10.5.2
SCCOPT_DBPRINTGRIDLINES
10.5.3
SCCOPT_DBPRINTHEADINGS
10.5.4
SCCOPT_MAXSSDBPAGEHEIGHT
10.5.5
SCCOPT_MAXSSDBPAGEWIDTH
10.5.6
SCCOPT_SSPRINTDIRECTION
10.5.7
SCCOPT_SSPRINTFITTOPAGE
10.5.8
SCCOPT_SSPRINTGRIDLINES
10.5.9
SCCOPT_SSPRINTHEADINGS
10.5.10
SCCOPT_SSPRINTSCALEPERCENT
10.5.11
SCCOPT_SSPRINTSCALEXHIGH
10.5.12
SCCOPT_SSPRINTSCALEXWIDE
10.5.13
SCCOPT_SSSHOWHIDDENCELLS
10.5.14
SCCOPT_EX_SHOWHIDDENSSDATA
10.5.15
SCCOPT_FILTERNOBLANK
10.6
Page Rendering
10.6.1
SCCOPT_DEFAULTPAGESIZE
10.6.1.1
DEFAULTPAGESIZE Structure
10.6.2
SCCOPT_DEFAULTPRINTMARGINS
10.6.2.1
SCCVWPRINTMARGINS Structure
10.6.3
SCCOPT_PRINTENDPAGE
10.6.4
SCCOPT_PRINTSTARTPAGE
10.6.5
SCCOPT_USEDOCPAGESETTINGS
10.6.6
SCCOPT_WHATTOPRINT
10.6.7
SCCOPT_NUMBERFORMAT
10.6.7.1
SCCVWNUMBERFORMAT775 and SCCVWNUMBERFORMAT Structures
10.6.8
SCCOPT_DOLINEARIZATION
10.6.9
SCCOPT_WPEMAILHEADEROUTPUT
10.6.10
SCCOPT_MAILHEADERVISIBLE
10.6.11
SCCOPT_MAILHEADERHIDDEN
10.6.12
SCCOPT_EXPORTEMAILATTACHMENTS
10.6.13
SCCOPT_MARGIN_TEXT_FONT_NAME
10.6.14
SCCOPT_MARGIN_TEXT_FONT_SIZE
10.6.15
SCCOPT_MARGIN_TEXT_LINE
10.6.16
SCCOPT_REDACTION_COLOR
10.6.17
SCCOPT_REDACTION_LABEL_FONT_NAME
10.6.18
SCCOPT_REDACTION_LABEL_FONT_SIZE
10.6.19
SCCOPT_REDACTIONS_ENABLED
10.6.20
SCCOPT_SHOW_REDACTION_LABELS
10.7
Font Rendering
10.7.1
SCCOPT_DEFAULTPRINTFONT
10.7.1.1
SCCVWFONTSPEC Structure
10.7.2
SCCOPT_EMBEDFONTS
10.7.3
SCCOPT_FONTDIRECTORY
10.7.4
SCCOPT_FONTFILTER
10.7.4.1
FONTFILTERLIST Structure
10.7.4.2
FONTNAMELIST Structure
10.7.5
SCCOPT_PRINTFONTALIAS
10.7.5.1
SCCVWFONTALIAS Structure
10.7.6
SCCOPT_FONTEMBEDPOLICY
10.7.7
SCCOPT_RENDER_EMBEDDED_FONTS
10.7.8
SCCOPT_STROKE_TEXT
10.8
Watermarks
10.8.1
SCCOPT_GRAPHIC_WATERMARK_OPACITY
10.8.2
SCCOPT_GRAPHIC_WATERMARK_SCALETYPE
10.8.3
SCCOPT_GRAPHIC_WATERMARK_SCALEPERCENT
10.9
Callbacks
10.9.1
SCCOPT_EX_CALLBACKS
10.9.2
SCCOPT_EX_UNICODECALLBACKSTR
10.10
File System
10.10.1
SCCOPT_IO_BUFFERSIZE
10.10.1.1
SCCBUFFEROPTIONS Structure
10.10.2
SCCOPT_TEMPDIR
10.10.2.1
SCCUTTEMPDIRSPEC Structure
10.10.3
SCCOPT_DOCUMENTMEMORYMODE
10.10.4
SCCOPT_REDIRECTTEMPFILE
Part III Using the Java API
11
Introduction to the Java API
11.1
Requirements
11.2
Getting Started
11.2.1
Configure the Environment
11.2.2
Generate Code
11.2.2.1
Create an Exporter Object
11.2.2.2
Configure the Output
11.2.2.3
Set the Source and Primary Destination Files
11.2.2.4
Set the Output Type
11.2.2.5
Provide a Callback Handler
11.2.2.6
Run the Export
12
PDF Export Java Classes
12.1
Annotation Class
12.2
ArchiveNode Class
12.3
Callback Class
12.3.1
createNewFile
12.3.1.1
CreateNewFileResponse Class
12.3.2
newFileInfo
12.3.3
openFile
12.3.3.1
OpenFileResponse Class
12.3.4
createTempFile
12.3.4.1
CreateTempFileResponseClass
12.4
ColorInfo Class
12.5
Exporter Interface
12.5.1
Annotatable Interface
12.5.2
Document Interface
12.5.3
SeekableByteChannel6 Interface
12.5.4
OptionsCache Class
12.5.4.1
AppendEMailAttachments
12.5.4.2
ApplyZLIBCompression
12.5.4.3
BiDiReorderMethod
12.5.4.4
DefaultInputCharacterSet
12.5.4.5
DefaultPageSize
12.5.4.6
DefaultRenderFont
12.5.4.7
DefaultPageMargins
12.5.4.8
DocumentMemoryMode
12.5.4.9
EmailHeaders
12.5.4.10
EmbedFonts
12.5.4.11
EnableAlphaBlending
12.5.4.12
FallbackFormat
12.5.4.13
FitHeightToPages
12.5.4.14
FitWidthToPages
12.5.4.15
FontAliasList
12.5.4.16
FontDirectories
12.5.4.17
FontFilter
12.5.4.18
GraphicOutputDPI
12.5.4.19
GridMaxPageHeight
12.5.4.20
GridMaxPageWidth
12.5.4.21
IECondCommentMode
12.5.4.22
IgnorePassword
12.5.4.23
ImagePassthrough
12.5.4.24
ISODateTimes
12.5.4.25
JPEGQuality
12.5.4.26
LinearizePDFOutput
12.5.4.27
LotusNotesDirectory
12.5.4.28
MarginText
12.5.4.29
MarginTextFont
12.5.4.30
PageDirection
12.5.4.31
PageFitMode
12.5.4.32
PageRange
12.5.4.33
PageScalePercent
12.5.4.34
PDFInputMaxEmbeddedObjects
12.5.4.35
PDFInputMaxVectorPaths
12.5.4.36
PDFReorderBiDi
12.5.4.37
PDFWordSpacingFactor
12.5.4.38
PerformExtendedFI
12.5.4.39
RedactionColor
12.5.4.40
RedactionLabelFont
12.5.4.41
RedactionLabelsVisible
12.5.4.42
RedactionsEnabled
12.5.4.43
RenderEmbeddedFonts
12.5.4.44
RenderGridlines
12.5.4.45
RenderHeadings
12.5.4.46
ShowArchiveFullPath
12.5.4.47
ShowHiddenCells
12.5.4.48
ShowHiddenSpreadSheetData
12.5.4.49
StrictFile
12.5.4.50
TimeZoneOffset
12.5.4.51
UnmappableCharacter
12.5.4.52
UseDocumentPageSettings
12.6
ExportStatus Class
12.7
FileFormat Class
12.8
FontAliases Class
12.9
FontInfo Class
12.10
FontList Class
12.11
HighlightTextAnnotation Class
12.12
MailHeaders Class
12.13
Margins Class
12.14
MarginText Class
12.15
Option Interface
12.16
OutsideIn Class
12.17
OutsideInVersion Class
12.18
OutsideInException Class
12.19
PageInfo Class
12.20
Watermark Class
12.21
PageRange Class
Part IV Using the .NET API
13
Introduction to the .NET API
13.1
Requirements
13.2
Getting Started
13.2.1
Configuring your Environment
13.2.2
Generate Code
13.2.2.1
Create an Exporter Object
13.2.2.2
Configure the Output
13.2.2.3
Set the Source and Primary Destination Files
13.2.2.4
Set the Output Type
13.2.2.5
Provide a Callback Handler
13.2.2.6
Run the Export
13.2.3
Redirected I/O Support in .NET
14
PDF Export .NET Classes
14.1
Annotation Class
14.2
ArchiveNode Class
14.3
Callback Class
14.3.1
OpenFile
14.3.1.1
OpenFileResponse Class
14.3.2
CreateNewFile
14.3.2.1
CreateNewFileResponse Class
14.3.3
NewFileInfo
14.3.4
CreateTempFile
14.3.4.1
CreateTempFileResponse Class
14.4
ColorInfo Class
14.5
Exporter Interface
14.5.1
lAnnotatable Interface
14.5.2
Document Interface
14.5.3
OptionsCache Class
14.5.3.1
AppendEMailAttachments
14.5.3.2
ApplyZLIBCompression
14.5.3.3
BiDiReorderMethod
14.5.3.4
DefaultInputCharacterSet
14.5.3.5
DefaultPageSize
14.5.3.6
DefaultRenderFont
14.5.3.7
DefaultPageMargins
14.5.3.8
DocumentMemoryMode
14.5.3.9
EmailHeaders
14.5.3.10
EmbedFonts
14.5.3.11
FallbackFormat
14.5.3.12
FitHeightToPages
14.5.3.13
FitWidthToPages
14.5.3.14
FontAliasList
14.5.3.15
FontDirectories
14.5.3.16
FontFilter
14.5.3.17
GraphicOutputDPI
14.5.3.18
GridMaxPageHeight
14.5.3.19
GridMaxPageWidth
14.5.3.20
IECondCommentMode
14.5.3.21
IgnorePassword
14.5.3.22
ImagePassthrough
14.5.3.23
ISODateTimes
14.5.3.24
JPEGQuality
14.5.3.25
LinearizePDFOutput
14.5.3.26
LotusNotesDirectory
14.5.3.27
MarginText
14.5.3.28
MarginTextFont
14.5.3.29
PageDirection
14.5.3.30
PageFitMode
14.5.3.31
PageRange
14.5.3.32
PageScalePercent
14.5.3.33
PDFInputMaxEmbeddedObjects
14.5.3.34
PDFInputMaxVectorPaths
14.5.3.35
PDFReorderBiDi
14.5.3.36
PDFWordSpacingFactor
14.5.3.37
PerformExtendedFI
14.5.3.38
RedactionColor
14.5.3.39
RedactionLabelFont
14.5.3.40
RedactionLabelsVisible
14.5.3.41
RedactionsEnabled
14.5.3.42
RenderEmbeddedFonts
14.5.3.43
RenderGridlines
14.5.3.44
RenderHeadings
14.5.3.45
ShowArchiveFullPath
14.5.3.46
ShowHiddenCells
14.5.3.47
ShowHiddenSpreadSheetData
14.5.3.48
StrictFile
14.5.3.49
TimeZoneOffset
14.5.3.50
UnmappableCharacter
14.5.3.51
UseDocumentPageSettings
14.6
ExportStatus Class
14.7
FileFormat Class
14.8
FontAliases Class
14.9
FontInfo Class
14.10
FontList Class
14.11
HighlightTextAnnotation Class
14.12
MailHeaders Class
14.13
Margins Class
14.14
MarginText Class
14.15
Option Interface
14.16
OutsideIn Class
14.17
OutsideInVersion Class
14.18
OutsideInConfig Class
14.19
OutsideInException Class
14.19.1
OutsideInCastException Class
14.20
PageInfo Class
14.21
PageRange Class
14.22
Watermark Class
Scripting on this page enhances content navigation, but does not change the content in any way.