Go to main content
1/23
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Conventions
Part I Getting Started with Web View Export
1
Introduction
1.1
What's New in this Release
1.2
Web View Export Overview
1.2.1
Browser Compatibility
1.2.2
Architecture
1.2.3
Web View Export Output
1.3
Definition of Terms
1.4
Directory Structure
1.4.1
Installing Multiple SDKs
2
Implementation Issues
2.1
Running in 24x7 Environments
2.2
Running in Multiple Threads or Processes
2.3
Web View 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
demoserver_node.js
3.2.2
wv_sample_exporter
3.2.3
demoserver_go
3.2.4
exsimple
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
Linux Compiling and Linking
5.9.1
Library Compatibility
5.9.1.1
GLIBC and Compiler Versions
5.9.1.2
Other Libraries
5.9.1.2.1
Libraries on Linux Systems as Distributed (IA32)
5.9.2
Compiling and Linking
5.9.2.1
Linux 64-bit
6
Data Access Common Functions
6.1
DAInitEx
6.2
DADeInit
6.3
DAOpenDocument
6.3.1
IOSPECLINKEDOBJECT Structure
6.3.2
IOSPECARCHIVEOBJECT Structure
6.4
DACloseDocument
6.5
DARetrieveDocHandle
6.6
DASetOption
6.7
DAGetOption
6.8
DAGetFileId
6.9
DAGetFileIdEx
6.10
DAGetErrorString
6.11
DAGetTreeCount
6.12
DAGetTreeRecord
6.12.1
SCCDATREENODE Structure
6.13
DAOpenTreeRecord
6.14
DASaveTreeRecord
6.15
DACloseTreeRecord
6.16
DASetStatCallback
6.17
DASetFileAccessCallback
6.18
DAOpenSubdocumentById
6.19
DAAddOptionItem
6.20
DAGetOptionItem
6.21
DARemoveOptionItem
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.1.6
EXAddKeyValue Functions
7.2
Annotation Functions
7.2.1
EXHiliteText
7.2.2
EXHiliteTextEx
7.2.3
EXHiliteArea
7.2.3.1
EXANNOHILITEAREA
7.2.4
EXAddStampAnnotation
7.2.4.1
EXANNOSTAMP
7.2.5
EXAddComment
7.2.6
EXAddHiliteProperty
7.2.7
EXApplyHilites
7.2.8
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
Web View 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.3
Graphics
10.3.1
SCCOPT_GRAPHIC_OUTPUTDPI
10.3.2
SCCOPT_GRAPHIC_SIZEMETHOD
10.4
Page Rendering
10.4.1
SCCOPT_DEFAULTPAGESIZE
10.4.1.1
DEFAULTPAGESIZE Structure
10.4.2
SCCOPT_DEFAULTPRINTMARGINS
10.4.2.1
SCCVWPRINTMARGINS Structure
10.4.3
SCCOPT_PRINTENDPAGE
10.4.4
SCCOPT_PRINTSTARTPAGE
10.4.5
SCCOPT_USEDOCPAGESETTINGS
10.4.6
SCCOPT_WHATTOPRINT
10.4.7
SCCOPT_NUMBERFORMAT
10.4.7.1
SCCVWNUMBERFORMAT775 and SCCVWNUMBERFORMAT Structures
10.5
Font Rendering
10.5.1
SCCOPT_DEFAULTPRINTFONT
10.5.1.1
SCCVWFONTSPEC Structure
10.5.2
SCCOPT_FONTDIRECTORY
10.5.3
SCCOPT_PRINTFONTALIAS
10.5.3.1
SCCVWFONTALIAS Structure
10.6
File System
10.6.1
SCCOPT_IO_BUFFERSIZE
10.6.1.1
SCCBUFFEROPTIONS Structure
10.6.2
SCCOPT_TEMPDIR
10.6.2.1
SCCUTTEMPDIRSPEC Structure
10.6.3
SCCOPT_DOCUMENTMEMORYMODE
10.6.4
SCCOPT_REDIRECTTEMPFILE
10.7
Web View Export Options
10.7.1
SCCOPT_OUTPUT_STRUCTURE
10.7.2
SCCOPT_URLPATH_RESOURCES
10.7.3
SCCOPT_URLPATH_OUTPUT
10.7.4
SCCOPT_EXTERNAL_STYLESHEET
10.7.5
SCCOPT_POST_LIBRARY_SCRIPT
10.7.6
SCCOPT_PRE_LIBRARY_SCRIPT
10.7.7
SCCOPT_OUTPUT_RAWTEXT
10.7.8
SCCOPT_EX_TEXTBUFFERSIZE
10.7.9
SCCOPT_FONT_PERMISSIONS_MODE
10.7.10
SCCOPT_FONT_REFERENCE_METHOD
10.7.11
SCCOPT_FONT_BASE_URL
10.7.12
SCCOPT_EMAIL_ATTACHMENT_HANDLING
10.7.13
SCCOPT_STAMP_IMAGE_URL
10.7.14
SCCOPT_VECTOROBJECTLIMIT
10.7.15
SCCOPT_REDACTION_COLOR
10.7.16
SCCOPT_REDACTION_LABEL_FONT_NAME
10.7.17
SCCOPT_REDACTION_LABEL_FONT_SIZE
10.7.18
SCCOPT_REDACTIONS_ENABLED
10.7.19
SCCOPT_SHOW_REDACTION_LABELS
10.7.20
SCCOPT_MARGIN_TEXT_FONT_NAME
10.7.21
SCCOPT_MARGIN_TEXT_FONT_SIZE
10.7.22
SCCOPT_MARGIN_TEXT_LINE
10.7.23
SCCOPT_WV_LIBRARY_NAME
10.7.24
SCCOPT_WV_STYLESHEET_NAME
Part III Using the Javascript API
11
Web View Export Javascript API
11.1
The Global OIT Object
11.2
Client-side Display Options
11.3
Client-side Control
11.4
Ranges
11.4.1
TextRange
11.4.2
CellRange
11.4.3
RectRange
11.5
OIT.view
11.5.1
OIT.view.attach
11.5.2
OIT.view.detach
11.5.3
OIT.view.load
11.5.4
OIT.view.unload
11.5.5
OIT.view.fitToContainer
11.5.6
OIT.view.width
11.5.7
OIT.view.height
11.5.8
OIT.view.info
11.6
OIT.document
11.6.1
OIT.document.properties
11.6.2
OIT.document.externalData
11.6.3
OIT.document.setOptions
11.6.4
OIT.document.zoom
11.6.5
OIT.document.zoomIn
11.6.6
OIT.document.zoomOut
11.6.7
OIT.document.rotate
11.6.8
OIT.document.showHidden
11.6.9
OIT.document.find
11.6.10
OIT.document.findAll
11.6.11
OIT.document.getRawText
11.6.12
OIT.document.highlight
11.6.13
OIT.document.select
11.6.14
OIT.document.selectionType
11.6.15
OIT.document.selectionMode
11.6.16
OIT.document.selectionStyle
11.6.17
OIT.document.selection
11.6.18
OIT.document.textSelection
11.6.19
OIT.document.cellSelection
11.6.20
OIT.document.rectSelection
11.6.21
OIT.document.getSelectedText
11.6.22
OIT.document.textRange
11.6.23
OIT.document.textRange
11.6.24
OIT.document.textRange
11.6.25
OIT.document.textRange
11.6.26
OIT.document.cellRange
11.6.27
OIT.document.rectRange
11.6.28
OIT.document.updateViewSize
11.6.29
OIT.document.removeExtraEmailHeaders
11.6.30
OIT.document.addEventListener
11.6.31
OIT.document.removeEventListener
11.7
OIT.pages
11.7.1
OIT.pages.current
11.7.2
OIT.pages.pageName
11.7.3
OIT.pages.count
11.7.4
OIT.pages.moveto
11.7.5
OIT.pages.movetoNext
11.7.6
OIT.pages.movetoPrev
11.7.7
OIT.pages.info
11.7.8
OIT.pages.addEventListener
11.7.9
OIT.pages.removeEventListener
11.8
OIT.highlights
11.8.1
Adding and Removing Highlights
11.8.1.1
OIT.highlights.add
11.8.1.2
OIT.highlights.addNote
11.8.1.3
OIT.highlights.redact
11.8.1.4
OIT.highlights.defineStamp
11.8.1.5
OIT.highlights.addStamp
11.8.1.6
OIT.highlights.apply
11.8.1.7
OIT.highlights.remove
11.8.1.8
OIT.highlights.clear
11.8.1.9
OIT.highlights.autoHighlight
11.8.1.10
OIT.highlights.autoHighlightOptions
11.8.1.11
OIT.highlights.serialize
11.8.1.12
OIT.highlights.getJSON
11.8.2
Interacting with Highlights
11.8.2.1
OIT.highlights.setOptions
11.8.2.2
OIT.highlights.style
11.8.2.3
OIT.highlights.comment
11.8.2.4
OIT.highlights.label
11.8.2.5
OIT.highlights.properties
11.8.2.6
OIT.highlights.property
11.8.2.7
OIT.highlights.current
11.8.2.8
OIT.highlights.active
11.8.2.9
OIT.highlights.moveto
11.8.2.10
OIT.highlights.movetoNext
11.8.2.11
OIT.highlights.movetoPrev
11.8.2.12
OIT.highlights.type
11.8.2.13
OIT.highlights.range
11.8.2.14
OIT.highlights.show
11.8.2.15
OIT.highlights.show
11.8.2.16
OIT.highlights.hide
11.8.2.17
OIT.highlights.hide
11.8.2.18
OIT.highlights.isHidden
11.8.2.19
OIT.highlights.showComment
11.8.2.20
OIT.highlights.hideComment
11.8.2.21
OIT.highlights.first
11.8.2.22
OIT.highlights.last
11.8.2.23
OIT.highlights.next
11.8.2.24
OIT.highlights.prev
11.8.2.25
OIT.highlights.activate
11.8.2.26
OIT.highlights.deactivate
11.8.2.27
OIT.highlights.addEventListener
11.8.2.28
OIT.highlights.removeEventListener
11.8.2.29
Examples
11.9
OIT.hyperlinks
11.9.1
Interacting with Hyperlinks
11.9.1.1
OIT.hyperlinks.addEventListener
11.9.1.2
OIT.hyperlinks.removeEventListener
11.10
OIT.archive
11.10.1
Interacting with archive nodes
11.10.1.1
OIT.archive.addEventListener
11.10.1.2
OIT.archive.removeEventListener
11.11
OIT.attachments
11.11.1
Interacting with Email Attachments
11.11.1.1
OIT.attachments.addEventListener
11.11.1.2
OIT.attachments.removeEventListener
11.11.1.3
OIT.attachments.describe
11.11.1.4
OIT.attachments.setOptions
11.12
OIT.toolbars
11.12.1
OIT.toolbars.add
11.12.2
OIT.toolbars.remove
11.12.3
OIT.toolbars.show
11.12.4
OIT.toolbars.hide
11.12.5
OIT.toolbars.setsize
11.12.6
OIT.toolbars.addEventListener
11.12.7
OIT.toolbars.removeEventListener
11.12.8
Navigation Toolbar
11.12.9
Status Bar
11.12.9.1
webview_statusbar.show
11.12.9.2
webview_statusbar.hide
11.12.9.3
webview_statusbar.message
11.13
OIT.local
11.14
Events from the Javascript API
Part IV Using the Java API
12
Web View Export Java API
12.1
Requirements
12.2
Getting Started
12.2.1
Configure the Environment
12.2.2
Generate Code
12.2.2.1
Create an Exporter Object
12.2.2.2
Configure the Output
12.2.2.3
Set the Source and Primary Destination Files
12.2.2.4
Set the Output Type
12.2.2.5
Provide a Callback Handler
12.2.2.6
Run the Export
13
Web View Export Java Classes
13.1
Annotation Class
13.2
ArchiveNode Class
13.3
Callback Class
13.3.1
createNewFile
13.3.2
newFileInfo
13.3.3
openFile
13.3.3.1
OpenFileResponse Class
13.3.4
createTempFile
13.3.4.1
CreateTempFileResponseClass
13.4
ColorInfo Class
13.5
Exporter Interface
13.5.1
Annotatable Interface
13.5.2
Document Interface
13.5.3
SeekableByteChannel6 Interface
13.5.4
OptionsCache Class
13.5.4.1
BiDiReorderMethod
13.5.4.2
DefaultInputCharacterSet
13.5.4.3
DefaultPageMargins
13.5.4.4
DefaultPageSize
13.5.4.5
DefaultRenderFont
13.5.4.6
DocumentMemoryMode
13.5.4.7
EmailAttachmentHandling
13.5.4.8
EnableAlphaBlending
13.5.4.9
ExternalStylesheets
13.5.4.10
FallbackFormat
13.5.4.11
FontAliasList
13.5.4.12
FontBaseURL
13.5.4.13
FontDirectories
13.5.4.14
FontFilter
13.5.4.15
FontReferenceMethod
13.5.4.16
GraphicHeightLimit
13.5.4.17
GraphicOutputDPI
13.5.4.18
GraphicSizeLimit
13.5.4.19
GraphicWidthLimit
13.5.4.20
IECondCommentMode
13.5.4.21
IgnorePassword
13.5.4.22
ISODateTimes
13.5.4.23
LotusNotesDirectory
13.5.4.24
MarginText
13.5.4.25
MarginTextFont
13.5.4.26
OutputRawtext
13.5.4.27
PageRange
13.5.4.28
PDFInputMaxEmbeddedObjects
13.5.4.29
PDFInputMaxVectorPaths
13.5.4.30
PDFReorderBiDi
13.5.4.31
PDFWordSpacingFactor
13.5.4.32
PerformExtendedFI
13.5.4.33
PostLibraryScripts
13.5.4.34
PreLibraryScripts
13.5.4.35
RedactionColor
13.5.4.36
RedactionLabelFont
13.5.4.37
RedactionLabelsVisible
13.5.4.38
RedactionsEnabled
13.5.4.39
RenderEmbeddedFonts
13.5.4.40
ShowArchiveFullPath
13.5.4.41
StrokeOutText
13.5.4.42
TempDirectory
13.5.4.43
TimeZoneOffset
13.5.4.44
UnmappableCharacter
13.5.4.45
URLPathOutput
13.5.4.46
URLPathResources
13.5.4.47
UseDocumentPageSettings
13.5.4.48
VectorObjectLimit
13.5.4.49
WebFontPermissions
13.5.4.50
WebViewLibraryName
13.5.4.51
WebViewOutputStructure
13.5.4.52
WebViewStylesheetName
13.6
ExportStatus Class
13.7
FileFormat Class
13.8
FontAliases Class
13.9
FontInfo Class
13.10
FontList Class
13.11
HighlightAreaAnnotation Class
13.11.1
AnnoBorder Class
13.12
HighlightTextAnnotation Class
13.13
Margins Class
13.14
Option Interface
13.15
Options
13.16
OutsideIn Class
13.17
OutsideInVersion Class
13.18
OutsideInException Class
13.19
PageInfo Class
13.20
PageRange Class
13.21
StampAnnotation Class
Part V Using the .NET API
14
Web View Export .NET API
14.1
Requirements
14.2
Getting Started
14.2.1
Configuring your Environment
14.2.2
Generate Code
14.2.2.1
Create an Exporter Object
14.2.2.2
Configure the Output
14.2.2.3
Set the Source and Primary Destination Files
14.2.2.4
Set the Output Type
14.2.2.5
Provide a Callback Handler
14.2.2.6
Run the Export
14.2.3
Redirected I/O Support in .NET
15
Web View Export .NET Classes
15.1
Annotation Class
15.2
ArchiveNode Class
15.3
Callback Class
15.3.1
OpenFile
15.3.1.1
OpenFileResponse Class
15.3.2
CreateNewFile
15.3.3
NewFileInfo
15.3.4
CreateTempFile
15.3.4.1
CreateTempFileResponse Class
15.4
ColorInfo Class
15.5
Exporter Interface
15.5.1
IAnnotatable Interface
15.5.2
Document Interface
15.5.3
OptionsCache Class
15.5.3.1
BiDiReorderMethod
15.5.3.2
DefaultInputCharacterSet
15.5.3.3
DefaultPageMargins
15.5.3.4
DefaultPageSize
15.5.3.5
DefaultRenderFont
15.5.3.6
DocumentMemoryMode
15.5.3.7
EMailAttachmentHandling
15.5.3.8
ExternalStylesheets
15.5.3.9
FallbackFormat
15.5.3.10
FontAliasList
15.5.3.11
FontBaseURL
15.5.3.12
FontDirectories
15.5.3.13
FontFilter
15.5.3.14
FontReferenceMethod
15.5.3.15
GraphicHeightLimit
15.5.3.16
GraphicOutputDPI
15.5.3.17
GraphicSizeLimit
15.5.3.18
GraphicWidthLimit
15.5.3.19
IECondCommentMode
15.5.3.20
IgnorePassword
15.5.3.21
ISODateTimes
15.5.3.22
LotusNotesDirectory
15.5.3.23
MarginText
15.5.3.24
MarginTextFont
15.5.3.25
OutputRawtext
15.5.3.26
PageRange
15.5.3.27
PDFInputMaxEmbeddedObjects
15.5.3.28
PDFInputMaxVectorPaths
15.5.3.29
PDFReorderBiDi
15.5.3.30
PDFWordSpacingFactor
15.5.3.31
PerformExtendedFI
15.5.3.32
PostLibraryScripts
15.5.3.33
PreLibraryScripts
15.5.3.34
RedactionColor
15.5.3.35
RedactionLabelFont
15.5.3.36
RedactionLabelsVisible
15.5.3.37
RedactionsEnabled
15.5.3.38
RenderEmbeddedFonts
15.5.3.39
ShowArchiveFullPath
15.5.3.40
StrokeOutText
15.5.3.41
TempDirectory
15.5.3.42
TimeZoneOffset
15.5.3.43
UnmappableCharacter
15.5.3.44
URLPathOutput
15.5.3.45
URLPathResources
15.5.3.46
UseDocumentPageSettings
15.5.3.47
VectorObjectLimit
15.5.3.48
WebFontPermissions
15.5.3.49
WebViewLibraryName
15.5.3.50
WebViewStructure
15.5.3.51
WebViewStylesheetName
15.6
ExportStatus Class
15.7
FileFormat Class
15.8
FontAliases Class
15.9
FontInfo Class
15.10
FontList Class
15.11
HighlightAreaAnnotation Class
15.11.1
AnnoBorder Class
15.12
HighlightTextAnnotation Class
15.13
Margins Class
15.14
Option Interface
15.15
Options
15.16
OutsideIn Class
15.17
OutsideInConfig Class
15.18
OutsideInVersion Class
15.19
OutsideInException Class
15.20
OutsideInCastException Class
15.21
PageInfo Class
15.22
PageRange Class
15.23
StampAnnotation Class
Scripting on this page enhances content navigation, but does not change the content in any way.