PDF Export .NET Classes

14 PDF Export .NET Classes

This chapter describes PDF Export .NET classes.

The following classes are covered:

14.1 Annotation Class

Annotation is an abstract base class for the Annotation objects.

Namespace

OutsideIn.Annotations

Properties

Height (Int64) Height of area in coordinates or rows
Left (Int64) Leftmost coordinate or column
Opacity (Single) Opacity of the annotation. Range 0.0 - 1.0; setting opacity to 0 makes the annotation invisible
SectionIndex (Int64) 0-based page/sheet/image/slide index
Top (Int64) Top coordinate or row
Units (Annotation.UnitTypeValue) Type of units in which Height, Width, Left and Top are described
UserId (Int64) User Data
Width (Int64) Width of area in coordinates or columns

Annotation.UnitTypeValue Enumeration

The UnitTypeValue is an enumeration of the various unit types that annotation positions can be described in.

Pixels: Units specified in Pixels. This Unit type should be used for Graphic files.
Twips: Units specified in Twips (1/1440th of an inch). This Unit type should be used for Word Processing documents.
Cells: Units specified in cell positions. This Unit type should be used for Spreadsheets.

14.2 ArchiveNode Class

ArchiveNode provides information about an archive node. This is a read-only class where the technology fills in all the values.

Namespace

OutsideIn

Properties

IsDirectory (Boolean) A value of true indicates that the record is an archive node.
FileSize (Int32) File size of the archive node
NodeTime (Int32) Time the archive node was created
NodeNum (Int32) Serial number of the archive node in the archive
NodeName (String) The name of the archive node

14.3 Callback Class

Callback messages are notifications that come from Outside In during the export process, providing information and sometimes the opportunity to customize the generated output.

Namespace

OutsideIn

To access callback messages, your code must create an object that inherits from Callback and pass it through the API's SetCallbackHandler method. Your object can implement methods that override the default behavior for whichever methods your application is interested in.

Callback has three methods: OpenFile, CreateNewFile and NewFileInfo.

14.3.1 OpenFile

OpenFileResponse OpenFile(
      FileTypeValue fileType,
      string fileName
)

This callback is made any time a new file needs to be opened.

Parameters

fileType: Type of file being requested to be opened.
filename: Name of the file to be open

Return Value

To take action in response to this method, return an OpenFileResponse object.

FileTypeValue Enumeration

This enumeration defines the type of file being requested to be opened. Its value may be one of the following:

Input: File to be opened (path unknown)
Template: Template file to be opened
Path: Full file name of the file to be opened.
Other: Not used.

14.3.1.1 OpenFileResponse Class

This is a class to define a new file or stream object in response to an OpenFile callback.

Constructor

OpenFileResponse(FileInfo file)

File: File object with full path to the new file.

OpenFileResponse(Stream file)

File: A stream to which the file data will be written.

14.3.2 CreateNewFile

CreateNewFileResponse CreateNewFile( FileFormat ParentOutputId,  FileFormat OutputId,
   Association Association, string Path)

This callback is made any time a new output file needs to be generated. This gives the developer the chance to affect where the new output file is created, how it is named, and the URL (if any) used to reference the file.

Parameters

ParentOutputId: File format identifier of the parent file.
OutputId: File format identifier of the file created.
Association: An Association that describes relationship between the primary output file and the new file.
Path: Full path of the file to be created.

Return Value

To take action in response to this notification, return a CreateNewFileResponse object with the new file information. If you wish to accept the defaults for the path and URL, you may return null.

14.3.2.1 CreateNewFileResponse Class

This is a class to define a new output file location in response to a CreateNewFile callback. If you do not wish to change the path to the new output file, you may use the path as received. If you do not wish to specify the URL for the new file, you many specify it as null.

Constructor

CreateNewFileResponse(FileInfo File, string URL)

File: File object with full path to new file.
URL: A new URL that references the newly created file. This parameter can be null.

Association Enumeration

This enumeration defines, for a new file created by an export process, the different possible associations between the new file and the primary output file. Its value may be one of the following:

Root - indicates the primary output file
Child - a new file linked (directly or indirectly) from the primary output file
Sibling - indicates new files not linked from the primary output file
Copy - the file was copied as a part of a template macro operation.
RequiredName - not used

Note that some of these relationships will not be possible in all Outside In Export SDKs.

14.3.3 NewFileInfo

void NewFileInfo( FileFormat ParentOutputId, FileFormat OutputId,
    Association Association, string Path, string URL)

This informational callback is made just after each new file has been created.

Parameters

ParentOutputId: File format identifier of the parent file
OutputId: File format identifier of the file created
Association: An Association that describes relationship between the primary output file and the new file.
Path: Full path of the file created
URL: URL that references the newly created file

14.3.4 CreateTempFile

CreateTempFileResponse CreateTempFile()

This callback is made any time a new temporary file needs to be generated. This gives the developer the chance to handle the reading and writing of the temporary file.

Return Value

To take action in response to this notification, return a CreateTempFileResponse object with the temporary file information.

14.3.4.1 CreateTempFileResponse Class

This is a class to define a new file or stream object in response to an CreateTempFile callback.

Constructor

CreateTempFileResponse (Stream file)

File: A stream to which the file data will be written and read from.

14.4 ColorInfo Class

ColorInfo is a class to define a color or to use a default color in appropriate cases.

Namespace

OutsideIn

Constructors

ColorInfo()

Initializes an ColorInfo object to use the default color.

public ColorInfo(Byte red,
   Byte green,
   Byte blue)

Initializes an ColorInfo object with the specified RGB values.

Properties

Blue (Byte) - Blue component of the color
Green (Byte) - Green component of the color
Red (Byte) - Red component of the color
UseDefault (Byte) - Set to true if the default color is used

14.5 Exporter Interface

This section describes the properties and methods of Exporter.

All of Outside In's Exporter functionality can be accessed through the Exporter Interface. The object returned by OutsideIn class is an implementation of this interface. This class derives from the Document Interface, which in turn is derived from the OptionsCache Interface.

Namespace

OutsideIn

Methods

GetExportStatus
```
ExportStatus GetExportStatus()
```
This function is used to determine if there were conversion problems during an export. The ExportStatus object returned may have information about sub-document failures, areas of a conversion that may not have high fidelity with the original document. When applicable the number of pages in the output is also provided.
NewSubDocumentExporter
```
Exporter NewSubDocumentExporter(
      int SubDocId,
      SubDocumentIdentifierTypeValue idType
)
```
Create a new Exporter for a subdocument.

SubDocId: Identifier of the subdocument

idType: Type of subdocument

SubDocumentIdentifierTypeValue: This is an enumeration for the type of subdocument being opened.
- IDTYPE_XX: Subdocument to be opened is based on output of XML Export (SubdocId is the value of the object_id attribute of a locator element.)
- IDTYPE_ATTACHMENT_LOCATOR: Subdocument to be opened is based on the locator value provided by the one of the Export SDKs.
- IDTYPE_ATTACHMENT_INDEX: Subdocument to be opened is based on the index of the attachment from an email message. (SubdocId is the zero-based index of the attachment from an email message file. The first attachment presented by OutsideIn has the index value 0, the second has the index value 1, etc.)
Returns: A new Exporter object for the subdocument
NewSubObjectExporter
```
Exporter NewSubObjectExporter(
      SubObjectTypeValue objType,
      uint data1,
      uint data2,
      uint data3,
      uint data4
)
```
Create a new Exporter for a subobject.

objType: Type of subobject

data1: Data identifying the subobject from SearchML

data2: Data identifying the subobject from SearchML

data3: Data identifying the subobject from SearchML

data4: Data identifying the subobject from SearchML

Returns: A new Exporter object for the subobject

SubObjectTypeValue: An enumeration to describe the type of SubObject to open.
- LinkedObject
- EmbeddedObject
- CompressedFile
- Attachment
NewArchiveNodeExporter
```
Exporter NewArchiveNodeExporter(
      int dwRecordNum
)
```
Create a new Exporter for an archive node. You may get the number of nodes in an archive using getArchiveNodeCount. The nodes are numbered from 0 to getArchiveNodeCount -1.

dwRecordNum: The number of the record to retrieve information about. The first node is node 0 and the total number of nodes may be obtained from GetArchiveNodeCount.

Returns: A new Exporter object for the archive node
NewArchiveNodeExporter with Search Export Data
```
Exporter NewArchiveNodeExporter(
      uint flags,
      uint params1,
      uint params2
)
```
Create a new Exporter for an archive node. To use this function, you must first process the archive with Search Export and save the Node data for later use in this function.

Flags: Special flags value from Search Export

Params1: Data1 from Search Export

Params2: Data2 from Search Export

Returns: A new Exporter object for the archive node
Export
```
void Export()
```
Perform the conversion and close the Export process keeping the source document open.
```
void Export(bool bLeaveSourceOpen)
```
Perform the conversion and close the Export process keep the source document open or close it based on the value of bLeaveSourceOpen.

bLeaveSourceOpen: If set to true, keeps the source document open for next export process.

Note:
Before Release 8.5.3, calling Export() with no parameters, would leave the source document open. The default behavior starting with Release 8.5.3 is to close the document after exporting the file. If you would like to keep the file open for other conversions, please use this method with "bLeaveSourceOpen" set to true.
SetExportTimeout
```
OptionsCache SetExportTimeout(int millisecondsTimeout);
```
This method sets the time that the export process should wait for a response from the Outside In export engine to complete the export of a document, setting an upper limit on the time that will elapse during a call to Export(). If the specified length of time or the default timeout amount is reached before the export has completed, the export operation is terminated and an OutsideInException is thrown. If this option is not set, the default timeout is 5 minutes.
Close
```
Close()
```
This function closes the current Export process.
NewLocalExporter
```
static Exporter NewLocalExporter(Exporter source)
```
This method creates and returns an instance of an Exporter object based on the source Exporter. All the options of source are copied to the new Exporter. The source and destination file information will not be copied.

14.5.1 lAnnotatable Interface

All of the Outside In annotation-related methods are accessed through the IAnnotatable Interface.

NameSpace

OutsideIn.Annotations

Methods

AddTextHighlight
```
void AddTextHighlight(
      HighlightTextAnnotation textanno
)
```
Highlight text in a document.

textanno: A HighlightTextAnnotation object with information about the text to highlight
AddTextHighlight and Add Annotation Properties
```
void AddTextHighlight(
      HighlightTextAnnotation textanno,
      Dictionary<string, string> Properties
)
```
Highlight text in a document and associate properties with the annotation.

textanno: A HighlightTextAnnotation object with information about the text to highlight

Properties: Key value pairs of name/value of properties associated with this annotation
AddTextHighlight and Associate a Comment
```
void AddTextHighlight(
      HighlightTextAnnotation textanno,
      string Comment
)
```
Highlight text in a document and associate a comment with the highlight.

textanno: A HighlightTextAnnotation object with information about the text to highlight

Comment: Comment text to associate with the annotation
AddTextHighlight with Comment and Properties to Annotation
```
void AddTextHighlight(
      HighlightTextAnnotation textanno,
      string Comment,
      Dictionary<string, string> Properties
)
```
Highlight text in a document and provide comment text and properties to be associated with the annotation.

textanno: A HighlightTextAnnotation object with information about the text to highlight

Comment: Comment text to associate with the annotation

Properties: Key value pairs of name/value of properties associated with this annotation

14.5.2 Document Interface

All of the Outside In document-related methods are accessed through the Document Interface.

Namespace

OutsideIn

Methods

Close
```
void Close()
```
Closes the currently open document
GetArchiveNodeCount
```
Int32 GetArchiveNodeCount()
```
Retrieves the number of nodes in an archive file.

Returns the number of nodes in the archive file or 0 if the file is not an archive file.
GetFileId
```
FileFormat GetFileId(FileIdInfoFlagValue dwFlags)
```
Gets the format of the file based on the technology's content-based file identification process.

dwFlags: Option to retrieve the file identification pre-Extended or post-Extended Test

Returns the format identifier of the file.
GetArchiveNode
```
TreeRecord GetArchiveNode(Int32 nNodeNum)
```
Retrieves information about a record in an archive file. You may get the number of nodes in an archive using getArchiveNodeCount.

nNodeNum: The number of the record to retrieve information about. The first node is node 0.

Return Value: An ArchiveNode object with the information about the record
SaveArchiveNode
```
void SaveArchiveNode(
      Int32 nNodeNum,
      FileInfo fileinfo)
void SaveArchiveNode(
      Int32 nNodeNum,
      string strFileName)
```
Extracts a record in an archive file to disk.

nNodeNumType: The number of the record to retrieve information about. The first node is node 0.

strFileNameType/fileinfo: Full path of the destination file to which the file will be extracted
SaveArchiveNode with ArchiveNode
```
void SaveArchiveNode(
      ArchiveNode arcNode,
      FileInfo fileinfo)
void SaveArchiveNode(
      ArchiveNode arcNode,
      string strFileName)
```
Extracts a record in an archive file to disk.

arcNode: An ArchiveNode object retrieved from GetArchiveNodeInfo with information about the node to extract

strFileNameType/fileinfo: Full path of the destination file to which the file will be extracted
SaveArchiveNode with Search Export Flags
```
void SaveArchiveNode(
      uint flags,
      uint params1,
      uint params2,
      FileInfo fileinfo)
void SaveArchiveNode(
      uint flags,
      uint params1,
      uint params2,
      string strFileName)
```
Extracts a record in an archive file to disk without reading the data for all nodes in the archive in a sequential order. To use this function, you must first process the archive with Search Export and save the Node data for later use in this function.

flagsType: Special flags value from Search Export

params1: Data1 from Search Export

params2: Data2 from Search Export

strFileNameType/fileinfo: Full path of the destination file to which the file will be extracted

14.5.3 OptionsCache Class

This section describes the OptionsCache class.

The options that configure the way outputs are generated are accessed through the OptionsCache class.

All of the options described in the following subsections are available through this interface. Other methods in this interface are described below.

Namespace

OutsideIn.Options

Methods

OptionsCache SetSourceFile(FileInfo file)

Sets the source document to be opened.

file: Full path to source file
OptionsCache SetSourceFile(string filename)

Set the source document.

filename: Full path of the source document

Returns: The options cache object associated with this document
OptionsCache AddSourceFile(FileInfo file)

Sets the next source document file to be exported in sequence. This allows multiple documents to be exported to the same output destination.

file: Full path to source file
OptionsCache AddSourceFile(string filename)

Set the next source document file to be exported in sequence. This allows multiple documents to be exported to the same output destination.

filename: Full path to the source file

returns: The updated options object
OptionsCache SetSourceFormat(FileFormat fileId)

Sets the source format to process the input file as, ignoring the algorithmic detection of the file type.

fileId: the format to treat the input document as.
OptionsCache SetDestinationFile(FileInfo file)

Sets the location of the destination file.

file: Full path to the destination file
OptionsCache SetDestinationFile(string filename)

Set the location of the destination file.

filename: Full path to the destination file

returns: The updated options object
OptionsCache SetDestinationFormat(FileFormat fileId)

Sets the destination file format to which the file should be converted to.

fileId: the format to convert the input document(s) to.
OptionsCache SetCallbackHandler(Callback callback)

Sets the object to use to handle callbacks.

callback: the callback handling object.
OptionsCache SetPasswordsList(List<String> Passwords)

Provides a list of strings to use as passwords for encrypted documents. The technology will cycle through this list until a successful password is found or the list is exhausted.

Passwords: List of strings to be used as passwords.
OptionsCache SetLotusNotesId(String NotesIdFile)

Sets the Lotus Notes ID file location.

NotesIdFile: Full path to the Notes ID file.
OptionsCache SetOpenForNonSequentialAccess(bool bOpenForNonSequentialAccess)

Setting this option causes the technology to open archive files in a special mode that is only usable for non-sequential access of nodes.

bOpenForNonSequentialAccess : If set to true would open the archive file in the special access mode. Note that turning this flag on a non-archive file will throw an exception at RunExport time.
OptionsCache SetSourceFile(Stream file)

Set an input stream as the source document. Exporting a file using this method may have issues with files that require the original name of the file (example: extension of the file for identification purposes or name of a secondary file dependent on the name/path of this file).
OptionsCache SetSourceFile(Stream file, String Filename)

Set an input stream as the source document and provide information about the filename (fully qualified path or file name that may be used to derive the extension of the file or name of a secondary file dependent on the name/path of this file).
OptionsCache SetNextSourceFile(Stream file)

Set an input stream as the next source document to be exported to the original destination file. This method has the same limitations as the similar SetSourceFile(Stream file) method.
OptionsCache SetNextSourceFile(Stream file, String Filename)

Set an input stream as the next source document to be exported to the original destination file. The file name provided is used as in the method SetSourceFile(Stream file, String Filename)
OptionsCache SetNextSourceFile(FileInfo file)

Set an input stream as the next source document to be exported to the original destination file.
OptionsCache SetDestinationFile(Stream file)

Set an output stream as the destination for an export.

14.5.3.1 AppendEMailAttachments

This option toggles whether or not email attachments will be output as PDF. For input files in all OIT-supported email formats that contain attachments, this option instructs the PDF Export process to export the contents of the attachments to PDF. The contents of the export are attached to the end of the email message so that only one PDF output file is produced. In addition, hyperlinks are provided that link to bookmarks marking the beginning of each attachment in the resulting PDF.

Data Type

bool

Data

true: Email attachments are output as PDF.
false: Email attachments are not included in the PDF.

Default

false

14.5.3.2 ApplyZLIBCompression

OIT Option ID: SCCOPT_APPLYFILTER

This option determines if ZLIB compression will be applied to all object streams when generating the PDF output file

Data Type

bool

Data

true: ZLIB compression is applied to all output streams.
false: ZLIB compression is not applied to any output stream

Default

true

14.5.3.3 BiDiReorderMethod

OIT Option ID: SCCOPT_REORDERMETHOD

This option controls how the technology reorders bidirectional text.

Data Type

BiDiReorderMethodValue

BiDiReorderMethodValue Enumeration

One of the following values:

UnicodeOff: This disables any processing for bidirectional characters. This option is the default.
UnicodeLToR: Characters displayed using the Unicode bidirectional algorithm assuming a base left-to-right order. Use this option to enable bidirectional rendering.
UnicodeRToL: Characters displayed using the Unicode bidirectional algorithm assuming a base right-to-left order. Use this option to force starting bidirectional rendering in the right-to-left.

Default

UnicodeOff

14.5.3.4 DefaultInputCharacterSet

OIT Option ID: SCCOPT_DEFAULTINPUTCHARSET

This option is used in cases where Outside In cannot determine the character set used to encode the text of an input file. When all other means of determining the file's character set are exhausted, Outside In will assume that an input document is encoded in the character set specified by this option. This is most often used when reading plain-text files, but may also be used when reading HTML or PDF files.

Data Type

DefaultInputCharacterSetValue

DefaultInputCharacterSetValue Enumeration

DefaultInputCharacterSetValue can be one of the following enumerations:

SystemDefault

Unicode

BigEndianUnicode

LittleEndianUnicode

Utf8

Utf7

Ascii

UnixJapanese

UnixJapaneseEuc

UnixChineseTrad1

UnixChineseEucTrad1

UnixChineseTrad2

UnixChineseEucTrad2

UnixKorean

UnixChineseSimple

Ebcdic37

Ebcdic273

Ebcdic274

Ebcdic277

Ebcdic278

Ebcdic280

Ebcdic282

Ebcdic284

Ebcdic285

Ebcdic297

Ebcdic500

Ebcdic1026

Dos437

Dos737

Dos850

Dos852

Dos855

Dos857

Dos860

Dos861

Dos863

Dos865

Dos866

Dos869

Windows874

Windows932

Windows936

Windows949

Windows950

Windows1250

Windows1251

Windows1252

Windows1253

Windows1254

Windows1255

Windows1256

Windows1257

Iso8859_1

Iso8859_2

Iso8859_3

Iso8859_4

Iso8859_5

Iso8859_6

Iso8859_7

Iso8859_8

Iso8859_9

MacRoman

MacCroatian

MacRomanian

MacTurkish

MacIcelandic

MacCyrillic

MacGreek

MacCE

MacHebrew

MacArabic

MacJapanese

HPRoman8

BiDiOldCode

BiDiPC8

BiDiE0

RussianKOI8

JapaneseX0201

Default

SystemDefault

14.5.3.5 DefaultPageSize

This option allows the developer to specify the size of each page in the generated output file. The size may be specified in inches, points, centimeters or picas. This option is only valid when UseDocumentPageSettings is set to false. 1 inch = 6 picas = 72 points = ~ 2.54 cm.

Data Type

PageInfo

Data

A PageInfo object with the page size information.

Default

8.5 inches by 11 inches

14.5.3.6 DefaultRenderFont

OIT Option ID: SCCOPT_DEFAULTPRINTFONT

This option sets the font to use when the chunker-specified font is not available on the system. It is also the font used when the font in source file is not available on the system performing the conversion.

Class members:

string strFaceName

int FontHeight

14.5.3.7 DefaultPageMargins

This option specifies the top, left, bottom and right margins in twips from the edges of the page. For instance, setting all the values to 1440 creates a 1-inch margin on all sides. Page margins will only be applied when formatting word processing, database and spreadsheet files.

Please note all margins are applied before scaling with the PageFitMode option. This option is overridden when the UseDocumentPageSettings option is set to true and print margins are specified in the input document. This option does not affect the output of bitmap, presentation, vector or archive files.

Data Type

Margins

Data

A Margins object with the margins on the 4 sides defined.

Default

1 inch for all margins (1440, 1440, 1440, 1440)

14.5.3.8 DocumentMemoryMode

OIT Option ID: SCCOPT_DOCUMENTMEMORYMODE

This option determines the maximum amount of memory that the chunker may use to store the document's data, from 4 MB to 1 GB. The more memory the chunker has available to it, the less often it needs to re-read data from the document.

Data

SMALLEST: 1 - 4MB
SMALL: 2 - 16MB
MEDIUM: 3 - 64MB
LARGE: 4 - 256MB
LARGEST: 5 - 1 GB

Default

SMALL: 2 - 16MB

14.5.3.9 EmailHeaders

OIT Option ID: SCCOPT_WPEMAILHEADEROUTPUT

This option controls rendering of email headers.

Data

ALL: Displays all available email headers.
STANDARD: Displays "To," "From," "Subject," "CC," "BCC," "Date Sent," and "Attachments" header fields only. The filter outputs any fields not listed above as hidden fields, so they will not display.
NONE: Displays no email header fields.
CUSTOM

Default

STANDARD

14.5.3.10 EmbedFonts

This option allows the developer to specify whether or not fonts should be embedded in the file. In order to comply with the PDF/A-1a spec, this option is forced to a value of All when PDF/A is selected for the output type.

Data Type

EmbedFontsValue

EmbedFontsValue Enumeration

ReduceSize: Do not embed base fonts
All: Embed all fonts
None: Do not embed base fonts

Default

ReduceSize

14.5.3.11 FallbackFormat

This option controls how files are handled when their specific application type cannot be determined. This normally affects all plain-text files, because plain-text files are generally identified by process of elimination, for example, when a file isn't identified as having been created by a known application, it is treated as a plain-text file. It is recommended that None be set to prevent the conversion from exporting unidentified binary files as though they were text, which could generate many pages of "garbage" output.

Data Type

FallbackFormatValue

FallbackFormatValue Enumeration

Text: Unidentified file types will be treated as text files.
None: Outside In will not attempt to process files whose type cannot be identified

Default

Text

14.5.3.12 FitHeightToPages

OIT Option ID: SCCOPT_SSPRINTSCALEXHIGH

This option will fit the spreadsheet image to the number of vertical pages specified. The setting for this option will have no effect unless the SSPrintFitToPage option is set to FitToPages.

Data Type

Int32

Default

14.5.3.13 FitWidthToPages

OIT Option ID: SCCOPT_SSPRINTSCALEXWIDE

This option will fit the spreadsheet image to the number of horizontal pages specified. The setting for this option will have no effect unless the SSPrintFitToPage option is set to FitToPages.

Data Type

Int32

Default

14.5.3.14 FontAliasList

This option enables the capability to specify which font on the system should be used when a specific font referenced in the original file is not available. A different alias can be set for each font desired to be mapped.

Data Type

FontAliases

Data

A FontAliases object with a list of font matchings

Default

Windows PrintAlias default

14.5.3.15 FontDirectories

This option allows the developer to specify one or more font directories where fonts are located for use by the technology. If multiple font directories are specified, they should be delimited by a semi-colon on Windows systems.

Data Type

List<DirectoryInfo>

Data

A list of directories where fonts are located.

Default

None

14.5.3.16 FontFilter

This option allows the developer to specify a list of fonts to be included or excluded during the export process.

Data Type

FontList

Data

A FontFilter object describing the inclusion or exclusion list.

Default

None

14.5.3.17 GraphicOutputDPI

OIT Option ID: SCCOPT_GRAPHIC_OUTPUTDPI

This option allows the user to specify the output graphics device's resolution in DPI and only applies to images whose size is specified in physical units (in/cm). For example, consider a 1" square, 100 DPI graphic that is to be rendered on a 50 DPI device (GraphicOutputDPI is set to 50). In this case, the size of the resulting TIFF, BMP, JPEG, GIF, or PNG will be 50 x 50 pixels.

In addition, the special #define of SCCGRAPHIC_MAINTAIN_IMAGE_DPI, which is defined as 0, can be used to suppress any dimensional changes to an image. In other words, a 1" square, 100 DPI graphic will be converted to an image that is 100 x 100 pixels in size. This value indicates that the DPI of the output device is not important. It extracts the maximum resolution from the input image with the smallest exported image size.

Setting this option to SCCGRAPHIC_MAINTAIN_IMAGE_DPI may result in the creation of extremely large images. Be aware that there may be limitations in the system running this technology that could result in undesirably large bandwidth consumption or an error message. Additionally, an out of memory error message will be generated if system memory is insufficient to handle a particularly large image.

Also note that the SCCGRAPHIC_MAINTAIN_IMAGE_DPI setting will force the technology to use the DPI settings already present in raster images, but will use the current screen resolution as the DPI setting for any other type of input file.

For some output graphic types, there may be a discrepancy between the value set by this option and the DPI value reported by some graphics applications. The discrepancy occurs when the output format uses metric units (DPM, or dots per meter) instead of English units (DPI, or dots per inch). Depending on how the graphics application performs rounding on meters to inches conversions, the DPI value reported may be 1 unit more than expected. An example of a format which may exhibit this problem is PNG.

The maximum value that can be set is 2400 DPI; the default is 96 DPI.

Data Type

Int32

14.5.3.18 GridMaxPageHeight

OIT Option ID: SCCOPT_MAXSSDBPAGEHEIGHT

Normally, the size of images generated from spreadsheet worksheets and database tables is limited to the size of the page defined by the input document's page size information and how the UseDocumentPageSettings, GraphicWidth and GraphicHeight options are set. If, after scaling is factored in, the resulting image is too large to fit on a single page, it is split up into multiple pages.

The GridMaxPageWidth and GridMaxPageHeight options are used to change the size of a page to match the scaled size of the page being rendered - within limits. The key reason for those limits is that rendering very large pages can easily overwhelm the memory available on the system. When using this feature, a calculation should be made to be sure that the values passed in work within said memory limits. The values for these two options will override the current page dimensions if necessary.

Data Type

Int32

Data

The maximum page height (including margins) specified in twips (1440 twips are in 1 inch). If the value specified is smaller than the page height, then an error will be returned.

14.5.3.19 GridMaxPageWidth

OIT Option ID: SCCOPT_MAXSSDBPAGEWIDTH

See the documentation for GridMaxPageHeight for a full discussion of how this option works and interacts with other options affecting the page size of images generated from spreadsheet and database pages.

Data Type

Int32

Data

The maximum page width (including margins) specified in twips (1440 twips are in 1 inch). If the value specified is smaller than the page width, then Image Export will return an error.

14.5.3.20 IECondCommentMode

OIT Option ID: SCCOPT_HTML_COND_COMMENT_MODE

Some HTML input files may include "conditional comments", which are HTML comments that mark areas of HTML to be interpreted in specific versions of Internet Explorer, while being ignored by other browsers. This option allows you to control how the content contained within conditional comments will be interpreted by Outside In's HTML parsing code.

Data

NONE: Don't output any conditional comment
IE5: Include the IE5 comments
IE6: Include the IE6 comments
IE7: Include the IE7 comments
IE8: Include the IE8 comments
IE9: Include the IE9 comments
ALL: Include all conditional comments

14.5.3.21 IgnorePassword

OIT Option ID: SCCOPT_IGNORE_PASSWORD

This option can disable the password verification of files where the contents can be processed without validation of the password. If this option is not set, the filter should prompt for a password if it handles password-protected files.

Data Type

bool

14.5.3.22 ImagePassthrough

This feature is used to allow certain input files to circumvent the normal filtering process and to be 'wrapped' in a PDF output file directly. This allows for much faster exporting of the supported file formats, which currently are JPEG, JPEG2000, and TIFF.

Data Type

bool

Default

false

14.5.3.23 ISODateTimes

OIT Option ID: SCCOPT_FORMATFLAGS

When this flag is set, all Date and Time values are converted to the ISO 8601 standard. This conversion can only be performed using dates that are stored as numeric data within the original file.

Data

bool

Default

false

14.5.3.24 JPEGQuality

OIT Option ID: SCCOPT_JPEG_QUALITY

This option allows the developer to specify the lossyness of JPEG compression. The option is only valid if the dwOutputID parameter of the EXOpenExport function is set to FI_JPEGFIF, FI_PDF, FI_PDFA, or FI_PDFA_2.

Data Type

Int32

Data

A value from 1 to 100, with 100 being the highest quality but the least compression, and 1 being the lowest quality but the most compression.

Default

100

14.5.3.25 LinearizePDFOutput

Linearization is a method by which PDF renderers are able to render pages of the PDF file before the entire document is loaded. Linearized output is both larger and takes longer to produce; this option allows you to produce non-linearized PDF so that the export process will be quicker and result in a smaller output file.

Data Type

bool

Default

false

14.5.3.26 LotusNotesDirectory

OIT Option ID: SCCOPT_LOTUSNOTESDIRECTORY

This option allows the developer to specify the location of a Lotus Notes or Domino installation for use by the NSF filter. A valid Lotus installation directory must contain the file nnotes.dll.

Data

A path to the Lotus Notes directory.

Default

If this option isn't set, then OIT will first attempt to load the Lotus library according to the operating system's PATH environment variable, and then attempt to find and load the Lotus library as indicated in HKEY_CLASSES_ROOT\Notes.Link.

14.5.3.27 MarginText

This option lets you specify a text string for margin text.

Data Type

MarginText

Default

None

14.5.3.28 MarginTextFont

This option is used to set the margin text font and font size.

Data Type

FontInfo

Default

Arial, 9 pt.

14.5.3.29 PageDirection

OIT Option ID: SCCOPT_SSPRINTDIRECTION

This option controls the pattern in which the pages are rendered, either across first and then down, or down first and then across.

This option is overridden when the UseDocumentPageSettings option is set to true and print direction is specified in the input document.

Data Type

PAGEDIRECTION_VALUES

Default

PageDirectionDown

14.5.3.30 PageFitMode

OIT Option ID: SCCOPT_DBPRINTFITTOPAGE

OIT Option ID: SCCOPT_SSPRINTFITTOPAGE

This option scales a spreadsheet file or database image to a certain percent or to a page width or height. However, in an effort to preserve readability after scaling, Image Export will not shrink a database document to under approximately one-third of its original size.

It should be noted that when this option is set to NoMap, the pages of the database file are printed down first and then across.

Please note that any margins applied as a result of settings for the DefaultPrintMargins option will be included in any scaling that is applied to the output image as a result of settings for this option.

This option is overridden when the UseDocumentPageSettings option is set to true and fitting the page to the printer's image limits is specified in the input document.

Data

NoMap: No scaling is performed on the spreadsheet or database image. It will render in its original size onto as many pages as are required to fit the data.
FitToWidth: Scale the spreadsheet or database image in the rendered image so it is no larger than one page wide.
FitToHeight: Scale the spreadsheet or database image in the rendered image so it is no larger than one page high.
Scale: Scale the spreadsheet or the database image in the rendered image using the scale value stored in the PageScalePercent option.
FitToPages: Scale the spreadsheet or the database image in the rendered image to fit to the number of pages specified in the FitHeightToPages and FitWidthToPages options. Since aspect ratio is maintained, the lesser of the two dimensions (width or height) will determine the scale factor. Note that if either FitHeightToPages or FitWidthToPages is set to 0, the value in the other option will be nullified.

Default

Scale: Scales the rendered image of the spreadsheet or database image using the scale value stored in the PageScalePercent option (which is 100 by default).

14.5.3.31 PageRange

OIT Option ID: SCCOPT_WHATTOPRINT

OIT Option ID: SCCOPT_PRINTSTARTPAGE

OIT Option ID: SCCOPT_PRINTENDPAGE

This option indicates whether the whole file or a selected range of pages should be rendered. When selecting a range, the start and ending pages are specified.

Data Type

PageRange

Data

The page range to be exported.

Default

All pages are printed

14.5.3.32 PageScalePercent

OIT Option ID: SCCOPT_SSPRINTSCALEPERCENT

This option will scale spreadsheet pages by the percentage specified. The option has no effect unless the SSPrintFitToPage option is set to Scale.

This option must take a value between 1 and 100. If any value outside of this range is used, the option will be ignored.

Data Type

Int32

Default

100

14.5.3.33 PDFInputMaxEmbeddedObjects

This option allows the user to limit the number of embedded objects that are produced in a PDF file.

Data Type

UInt32

Data

The maximum number of embedded objects to produce in PDF output. Setting this to 0 would produce an all embedded objects in the input document.

Default

0 – produce all objects.

14.5.3.34 PDFInputMaxVectorPaths

This option allows the user to limit the number of vector paths that are produced in a PDF file.

Data

The maximum number of paths to produce in PDF output. Setting this to 0 would produce an all vector objects in the input document.

Default

0 – produce all vector objects.

14.5.3.35 PDFReorderBiDi

OIT Option ID: SCCOPT_PDF_FILTER_REORDER_BIDI

This option controls whether or not the PDF filter will attempt to reorder bidirectional text runs so that the output is in standard logical order as used by the Unicode 2.0 and later specification. This additional processing will result in slower filter performance according to the amount of bidirectional data in the file.

PDFReorderBiDiValue Enumeration

This enumeration defines the type of Bidirection text reordering the PDF filter should perform.

StandardBiDi: Do not attempt to reorder bidirectional text runs.
ReorderedBiDi: Attempt to reorder bidirectional text runs.

14.5.3.36 PDFWordSpacingFactor

This option controls the spacing threshold in PDF input documents. Most PDF documents do not have an explicit character denoting a word break. The PDF filter calculates the distance between two characters to determine if they are part of the same word or if there should be a word break inserted. The space between characters is compared to the length of the space character in the current font multiplied by this fraction. If the space between characters is larger, then a word break character is inserted into the text stream. Otherwise, the characters are considered to be part of the same word and no word break is inserted.

Data Type

float

Data

A value representing the percentage of the space character used to trigger a word break. Valid values are positive values less than 2.

Default

0.85

14.5.3.37 PerformExtendedFI

OIT Option ID: SCCOPT_FIFLAGS

This option affects how an input file's internal format (application type) is identified when the file is first opened by the Outside In technology. When the extended test flag is in effect, and an input file is identified as being either 7-bit ASCII, EBCDIC, or Unicode, the file's contents will be interpreted as such by the export process.

The extended test is optional because it requires extra processing and cannot guarantee complete accuracy (which would require the inspection of every single byte in a file to eliminate false positives.)

Data Type

bool

Data

One of the following values:

false: When this is set, standard file identification behavior occurs.
true: If set, the File Identification code will run an extended test on all files that are not identified.

Default

true

14.5.3.38 RedactionColor

This option provides the ability to specify the color used for a redaction rectangle (black or white) as well as the color used (black or white) for the redaction code. When the colors match, the redaction code is effectively invisible. Settings should default to Black redactions with White codes if not explicitly set. The values may be set on each redaction individually, both in the UI and in the rendered output.

Value

ColorInfo

Data

Any valid CSS color

14.5.3.39 RedactionLabelFont

This option sets the name and size of font to use for redaction labels. The font size may be reduced to allow text to fit within a redaction rectangle.

Data Type

FontInfo

Default

Default display font, 9 pt.

14.5.3.40 RedactionLabelsVisible

This option allows you to display redaction labels in your output.

Data Type

Boolean

Default

False (no labels)

14.5.3.41 RedactionsEnabled

This option tells the export to format the output to be redaction-capable. In practical terms what this means is that all embeddings will be rasterized (routed through sccimg) so that a rectangle in an embedding is consistent across all output formats.

Data Type

Boolean

Default

False

14.5.3.42 RenderEmbeddedFonts

This option allows you to disable the use of embedded fonts in PDF input files. If the option is set to true, the embedded fonts in the PDF input are used to render text; if the option is set to false, the embedded fonts are not used and the fallback is to use fonts available to Outside In to render text.

Data Type

bool

Default

true

14.5.3.43 RenderGridlines

OIT Option ID: SCCOPT_DBPRINTGRIDLINES

OIT Option ID: SCCOPT_SSPRINTGRIDLINES

If this option is true, a line is generated between cells in the rendered image.

This option is overridden when the UseDocumentPageSettings option is set to true and printing grid lines between cells is specified in the input document.

Data Type

bool

Default

true

14.5.3.44 RenderHeadings

OIT Option ID: SCCOPT_DBPRINTHEADINGS

OIT Option ID: SCCOPT_SSPRINTHEADINGS

If this option is true, field, row and column headings will be generated along with the data.

This option is overridden when the UseDocumentPageSettings option is set to true and printing column and row headers is specified in the input document.

Data Type

bool

Default

true

14.5.3.45 ShowArchiveFullPath

OIT Option ID: SCCOPT_ARCFULLPATH

This option causes the full path of a node to be returned in "GetArchiveNodeInfo" and "GetObjectInfo".

Data Type

bool

Data

true: Provide the full path.
false: Do not provide the path.

Default

false

14.5.3.46 ShowHiddenCells

OIT Option ID: SCCOPT_SSSHOWHIDDENCELLS

This option lets you determine whether or not to show hidden rows or columns when rendering spreadsheets. It is used to expand the widths of cells that are hidden by virtue of having their row height or column width reduced to 0. This is a Boolean option that will leave the data hidden when it is false, and show all hidden rows and columns when it is true, displayed using the default row width or default column height.

Data Type

bool

Default

false

14.5.3.47 ShowHiddenSpreadSheetData

The setting for this option determines whether or not hidden data (hidden columns, rows or sheets) in a spreadsheet will be included in the output. When set to false (the default), the hidden elements are not written. When set to true, they are placed in the output in the same manner as regular spreadsheet data.

Data Type

bool

Default

false

14.5.3.48 StrictFile

When an embedded file or URL can't be opened with the full path, OutsideIn will sometimes try and open the referenced file from other locations, including the current directory. When this option is set, it will prevent OutsideIn from trying to open the file from any location other than the fully qualified path or URL.

Data Type

bool

Default

false

14.5.3.49 TimeZoneOffset

OIT Option ID: SCCOPT_TIMEZONE

This option allows the user to define an offset to GMT that will be applied during date formatting, allowing date values to be displayed in a selectable time zone. This option affects the formatting of numbers that have been defined as date values. This option will not affect dates that are stored as text. To query the operating system for the time zone set on the machine, specify TimeZoneOffset_UseNative.

Note:

Daylight savings is not supported. The sent time in msg files when viewed in Outlook can be an hour different from the time sent when an image of the msg file is created.

Data Type

Int32

Data

Integer parameter from -96 to 96, representing 15-minute offsets from GMT. To query the operating system for the time zone set on the machine, specify SCC_TIMEZONE_USENATIVE.

Default

0: GMT time

14.5.3.50 UnmappableCharacter

OIT Option ID: SCCOPT_UNMAPPABLECHAR

This option selects the character used when a character cannot be found in the output character set. This option takes the Unicode value for the replacement character. It is left to the user to make sure that the selected replacement character is available in the output character set.

Data Type

UShort

Data

The Unicode value for the character to use.

Default

0x002a = "*"

14.5.3.51 UseDocumentPageSettings

OIT Option ID: SCCOPT_USEDOCPAGESETTINGS

This option is used to select the document's page layout information when rendering.

If true, the document's native (or author selected) page margins, paper size, page scaling and page orientation are used when available from the filter.

The values of the DefaultPrintMargins, RenderGridlines, RenderHeadings, PageDirection, and PageFitMode options are overridden if this option is set to true and the properties associated with those options are specified in the input document. Additionally, print area and page breaks in spreadsheet documents are ignored unless this option is set to true.

If false, the page margins, size, orientation and scaling are set to specific values rather than those in the native document. The page size is forced to 8 1/2" x 11" in portrait orientation, but this may be changed by setting the GraphicHeight and/or GraphicWidth options. The margins are forced 1" all around, but may be changed by setting the defaultMargins option. The scaling for the document will be set to 100%, although this may be changed by setting any of the various scaling options.

It should be noted that this option also affects page orientation for both input spreadsheets and word processing documents.

Data Type

bool

Default

true

14.6 ExportStatus Class

The ExportStatus class provides access to information about a conversion. This information may include information about sub-document failures, areas of a conversion that may not have high fidelity with the original document. When applicable the number of pages in the output is also provided.

Namespace

OutsideIn

Properties

PageCount (Int32) - A count of all of the output pages produced during an export operation.
StatusFlags (ExportStatusFlags) - Gets the information about possible fidelity issues with the original document.
SubDocsFailed (Int32) - Number of sub documents that were not converted.
SubDocsPassed (Int32) - Number of sub documents that were successfully converted.

ExportStatusFlags Enumeration

This enumeration is the set of possible known problems that can occur during an export process.

NoInformationAvailable: No Information is available
MissingMap: A PDF text run was missing the toUnicode table
VerticalText: A vertical text run was present
TextEffects: A run that had unsupported text effects applied. One example is Word Art
UnsupportedCompression: A graphic had an unsupported compression
UnsupportedColorSpace: A graphic had an unsupported color space
Forms: A sub documents had forms
RightToLeftTables: A table had right to left columns
Equations: A file had equations
AliasedFont: The desired font was missing, but a font alias was used
MissingFont: The desired font wasn't present on the system
SubDocFailed: a sub-document was not converted
TypeThreeFont: A type 3 font was encountered.
UnsupportedShading: An unsupported shading pattern was encountered.
InvalidHTML: An HTML parse error, as defined by the W3C, was encountered.
bInvalidAnnotationNotApplied: Unsupported annotation/redaction wasn't rendered.

14.7 FileFormat Class

This class defines the identifiers for file formats.

Namespace

OutsideIn

Methods

getDescription

String getDescription()

This method returns the description of the format.
getId

int getId()

This method returns the numeric identifier of the format.
forId

FileFormat forId(int id)

This method returns the FileFormat object for the given identifier.

id : The numeric identifier for which the corresponding FileFormat object is returned.

14.8 FontAliases Class

FontAliases is a class for providing font matching of unknown fonts.

Namespace

OutsideIn.Options

Constructor

FontAliases(Dictionary<string, string> aliasList)
   aliasList      Aliases list as a key-value pair with original name as key

Properties

AliasList (Dictionary<String, String>) - List of font aliases set.

14.9 FontInfo Class

FontInfo is a class to define a font for use in the OutsideIn API.

Namespace

OutsideIn.Options

Constructor

FontInfo()

Constructs a FontInfo object with a 10 point Arial Font.

FontInfo(String fontface, Int16 height)
   fontface  The name of the font
   height    Size of the font in half points

Properties

Fontface (String) - The name of the font
Height (Int16) - Size of the font in half points

14.10 FontList Class

FontList is a class for inclusion or exclusion of fonts in exported documents.

Namespace

OutsideIn.Options

Constructor

FontList(Boolean  IsExclusion, String[] fonts)
   IsExclusion  If set then accompanying list is an exclusion list
   fonts        List of fonts to include or exclude

Properties

IsExclusion (Boolean) - If set, then accompanying list is an exclusion list.
FontsList (String[]) - List of fonts to include or exclude.

14.11 HighlightTextAnnotation Class

The HighlightTextAnnotation class applies to characteristics of a highlighted text annotation. This class derives from the Annotation class.

Namespace

OutsideIn.Annotations

Constructors

HighlightTextAnnotation(Int64 StartCharCount,
      Int64 EndCharCount,
      CharAttributeValues CharAttrs,
      CharAttributeValues CharMask)
HighlightTextAnnotation(Int64 StartCharCount,
      Int64 EndCharCount,
      ColorInfo Foreground,
      ColorInfo Background)
HighlightTextAnnotation(Int64 StartCharCount,
      Int64 EndCharCount,
      ColorInfo Foreground,
      ColorInfo Background,
      CharAttributeValues CharAttrs,
      CharAttributeValues CharMask)

Initializes a new instance of the HighlightTextAnnotation class.

Parameters

StartCharCount: The character count of the starting position
EndCharCount: The character count of the end position
Foreground: The text color of the highlight
Background: The background color of the highlight
CharAttrs: The character attributes to use
CharMask: Character attributes to change

CharAttributeValues Enumeration

This enumeration is the list of all character attributes to apply for the text highlight.

Normal: Normal text - All attributes off
Underline: Underline attribute
Italic: Italic attribute
Bold: Bold attribute
StrikeOut: Strike out text
SmallCaps: Small caps
Outline: Outline Text
Shadow: Shadow text
Caps: All Caps
Subscript: Subscript text
Superscript: Superscript text
DoubleUnderline: Double Underline
WordUnderline: Word Underline
DottedUnderline: Dotted Underline
DashedUnderline: Dashed Underline
All: All attributes

14.12 MailHeaders Class

MailHeaders class is a class describing the Mail Headers to be displayed, hidden or modified.

Namespace

OutsideIn.Options

Constructors

MailHeaders()

Constructs a MailHeaders object with a standard headers only.

MailHeaders(MailHeaders.BaselineValue baseline)

baseline: The starting point to add or delete headers.

Properties

Baseline (MailHeaders.BaselineValue) The starting point to add or delete headers.

Methods

MailHeaders ExcludeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr)

This method adds a standard header to the hidden list.

mtype: The type of documents in which to hide this header
mhdr: The header to hide

This method returns a reference to the updated MailHeaders object.

MailHeaders ExcludeHeader(MailHeaders.MailTypeValue mtype, String Exclusion)

This method adds a custom header to be the hidden list.

mtype: The type of documents in which to hide this header
Exclusion: User-specified MIME header name to be excluded

This method returns a reference to the updated MailHeaders object.

MailHeaders  IncludeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr)

This method adds a standard header to the visible list.

mtype: The type of documents in which to show this header
mhdr: The header to hide

This method returns a reference to the updated MailHeaders object.

MailHeaders  IncludeHeader(MailHeaders.MailTypeValue mtype, String Original, String Replacement)

This method adds a custom header to the visible list.

mtype: The type of documents in which to show this header
Original: User-specified MIME header name
Replacement: String that will be used as the label for the user-defined MIME header

This method returns a reference to the updated MailHeaders object.

void SetHeader(Dictionary<MailHeaders.MailTypeValue, Dictionary<String, String>> headers)

This method sets a series of custom headers to the visible headers list.

headers: A key value pair of user-specified MIME headers and their replacement strings

void SetHeader(Dictionary<MailHeaders.MailTypeValue, List<String>> headers)

This method sets a series of custom headers to the hidden headers list.

headers: A list of user-specified MIME headers to be hidden

MailHeaders.BaselineValue Enumeration

The BaselineValue is an enumeration of the possible baselines (starting points to add or exclude headers).

MailHeaders.MailTypeValue Enumeration

The MailTypeValue is an enumeration of the types of mail documents.

14.13 Margins Class

The Margins Class is used to describe the page margins.

Namespace

OutsideIn.Options

Constructors

Margins()

Constructs a Margins object with a 1 inch margins for top, bottom, left and right margins.

Margins(Int64 top,
       Int64 bottom,
       Int64 left,
       Int64 right)
top    Margin from the top edge of the page (in twips)
bottom Margin from the bottom edge of the page (in twips)
left   Margin from the left edge of the page (in twips)
right  Margin from the right edge of the page (in twips)

Properties

Top (Int64) Margin from the top edge of the page (in twips)
Bottom (Int64) Margin from the bottom edge of the page (in twips)
Left (Int64) Margin from the left edge of the page (in twips)
Right (Int64) Margin from the right edge of the page (in twips)

14.14 MarginText Class

This class provides a mechanism to define the Margin text to be applied to a page/document.

Namespace

OutsideIn

Constructors

MarginText(Map<MarginText.Location, String>)

Constructs a Margin text object with a list of lines.

MarginText(MarginText.Location, String)

Constructs a Margin text object with a single line.

Methods

void AddMarginText(Map<MarginText.Location, String>)

Adds a set of Margin text lines.

void AddMarginText(MarginText.Location, String)

Adds a line of Margin text.

Location Enumeration

This enumeration is the list of all the locations margin text can be applied to.

TopLeftLine1: Line 1 of Top Left Corner of page
TopLeftLine2: Line 2 of Top Left Corner of page
TopLeftLine3: Line 3 of Top Left Corner of page
TopCenterLine1: Line 1 of Top Center of page
TopCenterLine2: Line 2 of Top Center of page
TopCenterLine3: Line 3 of Top Center of page
TopRightLine1: Line 1 of Top Right Corner of page
TopRightLine2: Line 2 of Top Right Corner of page
TopRightLine3: Line 3 of Top Right Corner of page
BottomLeftLine1: Line 1 of Bottom Left Corner of page
BottomLeftLine2: Line 2 of Bottom Left Corner of page
BottomLeftLine3: Line 3 of Bottom Left Corner of page
BottomCenterLine1: Line 1 of Bottom Center of page
BottomCenterLine2: Line 2 of Bottom Center of page
BottomCenterLine3: Line 3 of Bottom Center of page
BottomRightLine1: Line 1 of Bottom Right Corner of page
BottomRightLine2: Line 2 of Bottom Right Corner of page
BottomRightLine3: Line 3 of Bottom Right Corner of page

14.15 Option Interface

The Option Interface provides the methods and properties to retrieve information about an Outside In Option.

Namespace

Outside In

Properties

Name — Name of the option
Description — Description of the option
DataType — The type of the option value
SupportingProducts — The list of products that support this option

Methods

void Set(OptionsCache exporter, Object objValue);

This method sets the option to the exporter object.

exporter — The exporter object
objValue — Value of the option

Note:

If the type of objValue cannot be converted to the data type the option is expecting, an OutsideInCastException is thrown.

void Get(OptionsCache exporter)

This method gets the currently set value for the option.

exporter — The exporter object who’s option value is requested.

OutsideInProducts Enumeration

HTMLExport — Outside In HTML Export
ImageExport — Outside In Image Export
PDFExport — Outside In PDF Export
SearchExport — Outside In Search Export
WebViewExport — Outside In Web View Export
XMLExport — Outside In XML Export
AllExports — All Outside In export products

14.16 OutsideIn Class

This is a utility class that creates an instance of an Exporter object on request.

Namespace

OutsideIn

Methods

static Exporter NewLocalExporter()

This method creates an instance of an Exporter object. It returns a newly created Exporter object.

static Exporter NewLocalExporter(Exporter source)

This method creates and returns an instance of an Exporter object based on the source Exporter. All the options of source are copied to the new Exporter. The source and destination file information will not be copied.

OutsideInVersion GetCoreVersion()

This static method returns an OutsideInVersion object with information of the Outside In Core Technology used.

14.17 OutsideInVersion Class

The OutsideIn Class is used to describe the version of the Outside In Core Module.

Namespace

OutsideIn

Methods

String GetVersion()

This method returns the version information as a string in the format of “MajorVersion.MinorVersion.DotVersion”.

Properties

int MajorVersion: The major version component
int MinorVersion: The minor version component
int DotVersion: The dot version component

14.18 OutsideInConfig Class

The OutsideInConfig Class is used to describe the Outside In Configuration Options.

Namespace

OutsideIn

Constructors

OutsideInConfig()

Creates a OutsideInConfig instance with default values.

OutsideInConfig(DirectoryInfo InstallLocation, UInt32 IdleWorkerTimeout, UInt32 MinimumWorkerCount)

Creates a OutsideInConfig instance with specified values.

Properties

DirectoryInfo InstallLocation: The Location of the technology directory.

UInt32 IdleWorkerTimeout: value indicating the number of milliseconds that an idle process in excess of the minimum worker count is kept alive before being terminated. This timeout only applies to worker processes created beyond the number of MinimumWorkerCount processes.

UInt32 MinimumWorkerCount: Specifies the minimum number of running worker processes kept available for export operations. If there is a higher number of exporter objects performing simultaneous export operations, additional worker processes will be created. Those additional worker processes will be terminated according to the IdleWorkerTimeout setting. If any of these processes are terminated due to errors, they will be replaced by a new process to maintain this minimum count of loaded worker processes.

14.19 OutsideInException Class

This is the exception that is thrown when an Outside In Technology error occurs.

This class derives from the Exception class. This class has no public methods or properties except those of the parent Exception class.

Namespace

OutsideIn

14.19.1 OutsideInCastException Class

This exception is thrown when an invalid value is provided as an option value.

This class derives from the OutsideInException class. This class has no public methods or properties except those of the parent Exception class.

Namespace

OutsideIn

14.20 PageInfo Class

PageInfo is a class for defining page dimensions.

Namespace

OutsideIn.Options

Constructor

PageInfo(PageInfo.PageSizeUnitsValue units,
              Single width,
              Single height)
units    Units used to specify width and height
width    Width of the page
height   Height of the page

Properties

Units: Units used to specify width and height
Width: Width of the page
Height: Height of the page

PageInfo.PageSizeUnitsValue Enumeration

PageSizeUnitsValue is an enumeration of the various units that can be used to specify the width and height of a page.

Inches: Units are in Inches
Points: Units are in Points (1/72th of an inch)
Centimeters: Units are in Centimeters
Picas: Units are in Picas (1/6th of an inch)

14.21 PageRange Class

PageRange is a class for defining page ranges for exporting purposes.

Namespace

OutsideIn.Options

Constructors

PageRange()

Creates an instance of the PageRangeObject for printing all pages.

PageRange(Int32 StartPage)
StartPage  Starting page number of the print range

Creates an instance of the PageRangeObject for printing from a page until end of document.

PageRange(
           Int32  StartPage,
           Int32  StopPage)
StartPage  Starting page number of the print range
StopPage   End page number of the print range

Creates an instance of the PageRangeObject for printing a range of pages.

Properties

PrintAll (Boolean) - If set to true, all pages of the document will be printed
StartPage (Int32) - The start page of the print range. 0 indicates printing will begin with the first page of the document.
StopPage (Int32) - The last page of the print range. 0 indicates the last page at the end of the document.

14.22 Watermark Class

This class describes the watermark to be applied to a document.

Namespace

OutsideIn.Options

Constructors

Watermark (FileInfo file)

Creates a watermark object with the image to be used.

file: A FileInfo object with the image file to be used as a watermark

Watermark (String  filename)

Creates a watermark object with the image to be used.

filename: The name of the image file to be used as a watermark

Watermark (Stream  stream)

Creates a watermark object with the image to be used.

stream: A stream with the image to be used as a watermark

Watermark (FileInfo file, int Opacity, int Percent, ANCHORPOSITION Anchor, int VerticalOffset, int HorizontalOffset)

file: A FileInfo object with the image file to be used as a watermark
Opacity: The Opacity of the watermark. Opacity is in the range of 1-255
Percent: The Percentage the watermark image is scaled by. A value of 0 indicates no scaling
Anchor: The position from which the watermark image is offset
VerticalOffset: vertical offset to shift the image by
HorizontalOffset: horizontal offset to shift the image by

Watermark (String  filename, int Opacity, int Percent, ANCHORPOSITION Anchor, int VerticalOffset, int HorizontalOffset)

filename: The name of the image file to be used as a watermark
Opacity: The Opacity of the watermark. Opacity is in the range of 1-255
Percent: The Percentage the watermark image is scaled by. A value of 0 indicates no scaling
Anchor: The position from which the watermark image is offset
VerticalOffset: vertical offset to shift the image by
HorizontalOffset: horizontal offset to shift the image by

Watermark (Stream  stream, int Opacity, int Percent, ANCHORPOSITION Anchor, int VerticalOffset, int HorizontalOffset)

stream: A stream with the image to be used as a watermark
Opacity : The Opacity of the watermark. Opacity is in the range of 1-255
Percent: The Percentage the watermark image is scaled by. A value of 0 indicates no scaling
Anchor: The position from which the watermark image is offset
VerticalOffset: vertical offset to shift the image by
HorizontalOffset: horizontal offset to shift the image by

Properties

AnchorPosition: Watermark's Anchor position. This is the position from which the Horizontal and Vertical offsets are applied
HorzOffset: Gets or sets the horizontal offset to shift the image by
Opacity: Gets or sets the Opacity of the watermark. Opacity is in the range of 1-255. 0 disables the watermark
Percent: Gets or sets the percentage amount by which the image is to be scaled. A value of 0 indicates no scaling
VertOffset: Gets or sets the vertical offset to shift the image by