Go to main content
1/29
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Conventions
Part I Getting Started with Image Export
1
Introduction
What's New in this Release
Architectural Overview
Definition of Terms
Directory Structure
Installing Multiple SDKs
How to Use Image Export
2
Implementation Issues
Running in 24x7 Environments
Running in Multiple Threads or Processes
Image Export Issues
3
Sample Applications
Building the Samples on a Windows System
An Overview of the Sample Applications
*sample
export (Windows Only)
The export Main Window
exsimple
exredir
extract_archive
ixanno
Accessing the SDK via a Java Wrapper
The ExJava Wrapper API
The C-Based Exporter Application
Compiling the Executables
The ExportTest Sample Application
An Example Conversion Using the ExJava Wrapper
Part II Using the C/C++ API
4
Windows Implementation Details
Installation
NSF Support
Libraries and Structure
API DLLs
Support DLLs
Engine Libraries
Filter and Export Filter Libraries
Premier Graphics Filters
Additional Files
The Basics
What You Need in Your Source Code
Options and Information Storage
Structure Alignment
Character Sets
Runtime Considerations
Default Font Aliases
Changing Resources
5
UNIX Implementation Details
Installation
NSF Support
Libraries and Structure
API Libraries
Support Libraries
Engine Libraries
Filter and Export Filter Libraries
Premier Graphics Filters
Additional Files
The Basics
What You Need in Your Source Code
Information Storage
Character Sets
Runtime Considerations
X Server Requirement
OLE2 Objects
Machine-Dependent Graphics Context
Signal Handling
Runtime Search Path and $ORIGIN
Environment Variables
Default Font Aliases
Changing Resources
HP-UX Compiling and Linking
HP-UX on RISC
HP-UX on RISC (64 bit)
IBM AIX Compiling and Linking
Linux Compiling and Linking
Library Compatibility
Motif Libraries
GLIBC and Compiler Versions
Other Libraries
Compiling and Linking
Linux 32-bit
Linux 64-bit
Oracle Solaris Compiling and Linking
Oracle Solaris SPARC
Oracle Solaris x86
Oracle Solaris X Server Display Memory Issue
6
Data Access Common Functions
Deprecated Functions
DAInitEx
DADeInit
DAOpenDocument
IOSPECLINKEDOBJECT Structure
IOSPECARCHIVEOBJECT Structure
DAOpenSubdocumentById
DAOpenNextDocument
DACloseDocument
DARetrieveDocHandle
DASetOption
DAGetOption
DAGetFileId
DAGetFileIdEx
DAGetErrorString
DAGetTreeCount
DAGetTreeRecord
SCCDATREENODE Structure
DAOpenTreeRecord
DASaveTreeRecord
DACloseTreeRecord
DASetStatCallback
DASetFileAccessCallback
7
Export Functions
General Functions
EXOpenExport
EXCALLBACKPROC
EXCloseExport
EXRunExport
EXExportStatus
EXGetProperties
Annotation Functions
EXHiliteText
EXInsertText
EXHideText
EXANNOHIDETEXT Structure
EXApplyHilites
EXRedactText
8
Redirected IO
Using Redirected IO
Opening Files
IOClose
IORead
IOWrite
IOSeek
IOTell
IOGetInfo
IOGENSECONDARY and IOGENSECONDARYW Structures
File Types That Cause IOGETINFO_GENSECONDARY
IOSEEK64PROC / IOTELL64PROC
IOSeek64
IOTell64
9
Callbacks
EX_CALLBACK_ID_CREATENEWFILE
EXURLFILEIOCALLBACKDATA / EXURLFILEIOCALLBACKDATAW Structures
EX_CALLBACK_ID_NEWFILEINFO
EX_CALLBACK_ID_PAGECOUNT
EX_CALLBACK_ID_BEGINPAGE
EX_CALLBACK_ID_ENDPAGE
10
Image Export C/C++ Options
Character Mapping
SCCOPT_DEFAULTINPUTCHARSET
SCCOPT_UNMAPPABLECHAR
Output
SCCOPT_RENDERING_PREFER_OIT
Input Handling
SCCOPT_FALLBACKFORMAT
SCCOPT_FIFLAGS
SCCOPT_SYSTEMFLAGS
SCCOPT_LOTUSNOTESDIRECTORY
SCCOPT_PDF_FILTER_REORDER_BIDI
SCCOPT_TIMEZONE
SCCOPT_FORMATFLAGS
SCCOPT_IGNORE_PASSWORD
SCCOPT_REORDERMETHOD
SCCOPT_HTML_COND_COMMENT_MODE
SCCOPT_ARCFULLPATH
SCCOPT_PDF_FILTER_MAX_EMBEDDED_OBJECTS
SCCOPT_PDF_FILTER_MAX_VECTOR_PATHS
SCCOPT_PDF_FILTER_WORD_DELIM_FRACTION
Compression
SCCOPT_FILTERJPG
SCCOPT_FILTERLZW
Graphics
SCCOPT_GIF_INTERLACED
SCCOPT_GRAPHIC_CROPPING
SCCOPT_GRAPHIC_HEIGHT
SCCOPT_GRAPHIC_HEIGHTLIMIT
SCCOPT_GRAPHIC_OUTPUTDPI
SCCOPT_GRAPHIC_SIZELIMIT
SCCOPT_GRAPHIC_SIZEMETHOD
SCCOPT_GRAPHIC_TRANSPARENCYCOLOR
SCCOPT_GRAPHIC_WIDTH
SCCOPT_GRAPHIC_WIDTHLIMIT
SCCOPT_GRAPHIC_RENDERASPAGE
SCCOPT_IMAGEX_TIFFOPTIONS
EXTIFFOPTIONS Structure
SCCOPT_JPEG_QUALITY
SCCOPT_QUICKTHUMBNAIL
SCCOPT_RENDER_ENABLEALPHABLENDING
Spreadsheet and Database File Rendering
SCCOPT_DBPRINTFITTOPAGE
SCCOPT_DBPRINTGRIDLINES
SCCOPT_DBPRINTHEADINGS
SCCOPT_MAXSSDBPAGEHEIGHT
SCCOPT_MAXSSDBPAGEWIDTH
SCCOPT_SSPRINTDIRECTION
SCCOPT_SSPRINTFITTOPAGE
SCCOPT_SSPRINTGRIDLINES
SCCOPT_SSPRINTHEADINGS
SCCOPT_SSPRINTSCALEPERCENT
SCCOPT_SSPRINTSCALEXHIGH
SCCOPT_SSPRINTSCALEXWIDE
SCCOPT_SSSHOWHIDDENCELLS
SCCOPT_EX_SHOWHIDDENSSDATA
SCCOPT_FILTERNOBLANK
Page Rendering
SCCOPT_DEFAULTPRINTMARGINS
SCCVWPRINTMARGINS Structure
SCCOPT_PRINTENDPAGE
SCCOPT_PRINTSTARTPAGE
SCCOPT_USEDOCPAGESETTINGS
SCCOPT_WHATTOPRINT
SCCOPT_NUMBERFORMAT
SCCVWNUMBERFORMAT775 and SCCVWNUMBERFORMAT Structures
SCCOPT_WPEMAILHEADEROUTPUT
SCCOPT_MAILHEADERVISIBLE
SCCOPT_MAILHEADERHIDDEN
SCCOPT_MARGIN_TEXT_FONT_NAME
SCCOPT_MARGIN_TEXT_FONT_SIZE
SCCOPT_MARGIN_TEXT_LINE
SCCOPT_REDACTION_COLOR
SCCOPT_REDACTION_LABEL_FONT_NAME
SCCOPT_REDACTION_LABEL_FONT_SIZE
SCCOPT_REDACTIONS_ENABLED
SCCOPT_SHOW_REDACTION_LABELS
Font Rendering
SCCOPT_DEFAULTPRINTFONT
SCCVWFONTSPEC Structure
SCCOPT_PRINTFONTALIAS
SCCVWFONTALIAS Structure
SCCOPT_RENDER_EMBEDDED_FONTS
SCCOPT_STROKE_TEXT
Watermarks
SCCOPT_GRAPHIC_WATERMARK_OPACITY
SCCOPT_GRAPHIC_WATERMARK_PATH
SCCOPT_GRAPHIC_WATERMARK_SCALETYPE
SCCOPT_GRAPHIC_WATERMARK_SCALEPERCENT
SCCOPT_GRAPHIC_WATERMARK_HORIZONTAL_OFFSETFROM
SCCOPT_GRAPHIC_WATERMARK_VERT_OFFSETFROM
Callbacks
SCCOPT_EX_CALLBACKS
SCCOPT_EX_UNICODECALLBACKSTR
File System
SCCOPT_IO_BUFFERSIZE
SCCBUFFEROPTIONS Structure
SCCOPT_TEMPDIR
SCCUTTEMPDIRSPEC Structure
SCCOPT_DOCUMENTMEMORYMODE
SCCOPT_REDIRECTTEMPFILE
SCCOPT_STAMP_IMAGE_FILE
Part III Using the Java API
11
Introduction to the Java API
Requirements
Getting Started
Configure the Environment
Generate Code
Create an Exporter Object
Configure the Output
Set the Source and Primary Destination Files
Set the Output Type
Provide a Callback Handler
Run the Export
12
Image Export Java Classes
Annotation Class
ArchiveNode Class
Callback Class
createNewFile
CreateNewFileResponse Class
newFileInfo
prepareNewPage
NewPageResponse Class
pageInfoSlideNotes
pageInfoVisibility
openFile
OpenFileResponse Class
createTempFile
CreateTempFileResponseClass
ColorInfo Class
Exporter Interface
Annotatable Interface
Document Interface
SeekableByteChannel6 Interface
OptionsCache Class
BiDiReorderMethod
CropToContent
DefaultInputCharacterSet
DefaultRenderFont
DefaultPageMargins
DocumentMemoryMode
EmailHeaders
EnableAlphaBlending
FallbackFormat
FitHeightToPages
FitWidthToPages
FontAliasList
GraphicHeight
GraphicHeightLimit
GraphicOutputDPI
GraphicRenderAsPage
GraphicSizeLimit
GraphicSizeMethod
GraphicWidth
GraphicWidthLimit
GridMaxPageHeight
GridMaxPageWidth
IECondCommentMode
IgnorePassword
InternalRendering
ISODateTimes
JPEGQuality
LotusNotesDirectory
MarginText
MarginTextFont
PageDirection
PageFitMode
PageRange
PageScalePercent
PDFInputMaxEmbeddedObjects
PDFInputMaxVectorPaths
PDFReorderBiDi
PDFWordSpacingFactor
PerformExtendedFI
QuickThumbnail
RedactionColor
RedactionLabelFont
RedactionLabelsVisible
RedactionsEnabled
RenderEmbeddedFonts
RenderGridlines
RenderHeadings
ShowArchiveFullPath
ShowHiddenCells
ShowHiddenSpreadSheetData
StrictFile
TIFFByteOrder
TIFFColorSpace
TIFFCompression
TIFFFillOrder
TIFFMultiPage
TimeZoneOffset
TransparencyColor
UnmappableCharacter
UseDocumentPageSettings
ExportStatus Class
FileFormat Class
FontAliases Class
FontInfo Class
FontList Class
HighlightTextAnnotation Class
MailHeaders Class
Margins Class
MarginText Class
Option Interface
OutsideIn Class
OutsideInVersion Class
OutsideInException Class
PageInfo Class
PageRange Class
Watermark Class
Part IV Using the .NET API
13
Introduction to the .NET API
Requirements
Getting Started
Configuring your Environment
Generate Code
Create an Exporter Object
Configure the Output
Set the Source and Primary Destination Files
Set the Output Type
Provide a Callback Handler
Run the Export
Redirected I/O Support in .NET
14
Image Export .NET Classes
Annotation Class
ArchiveNode Class
Callback Class
OpenFile
OpenFileResponse Class
CreateNewFile
CreateNewFileResponse Class
CreateTempFile
CreateTempFileResponse Class
NewFileInfo
PrepareNewPage
NewPageResponse Class
PageInfoSlideNotes
PageInfoVisibility
ColorInfo Class
Exporter Interface
lAnnotatable Interface
Document Interface
OptionsCache Class
BiDiReorderMethod
CropToContent
DefaultInputCharacterSet
DefaultRenderFont
DefaultPageMargins
DocumentMemoryMode
EmailHeaders
FallbackFormat
FitHeightToPages
FitWidthToPages
FontAliasList
GraphicHeight
GraphicHeightLimit
GraphicOutputDPI
GraphicRenderAsPage
GraphicSizeLimit
GraphicSizeMethod
GraphicWidth
GraphicWidthLimit
GridMaxPageHeight
GridMaxPageWidth
IECondCommentMode
IgnorePassword
ISODateTimes
JPEGQuality
LotusNotesDirectory
MarginText
MarginTextFont
PageDirection
PageFitMode
PageRange
PageScalePercent
PDFInputMaxEmbeddedObjects
PDFInputMaxVectorPaths
PDFReorderBiDi
PDFWordSpacingFactor
PerformExtendedFI
QuickThumbnail
RedactionColor
RedactionLabelFont
RedactionLabelsVisible
RedactionsEnabled
RenderEmbeddedFonts
RenderGridlines
RenderHeadings
SearchMLParaAttributes
ShowArchiveFullPath
ShowHiddenCells
ShowHiddenSpreadSheetData
StrictFile
TIFFByteOrder
TIFFColorSpace
TIFFCompression
TIFFFillOrder
TIFFMultiPage
TimeZoneOffset
TransparencyColor
UnmappableCharacter
UseDocumentPageSettings
ExportStatus Class
FileFormat Class
FontAliases Class
FontInfo Class
FontList Class
HighlightTextAnnotation Class
MailHeaders Class
Margins Class
MarginText Class
Option Interface
OutsideIn Class
OutsideInConfig Class
OutsideInVersion Class
OutsideInCastException Class
OutsideInException Class
PageInfo Class
PageRange Class
Watermark Class
Scripting on this page enhances content navigation, but does not change the content in any way.