Documentation
Advanced Search


Send Feedback | Print | PDF | ePub | Mobi
Oracle Outside In Image Export Developer's Guide

14 Image Export .NET Classes

This chapter describes the Image Export .NET classes.

14.1 Annotation Class

Annotation is an abstract base class for the Annotation objects.

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

  • Twips: Units specified in Twips (1/1440th of an inch)

  • Cells: Units specified in cell positions

14.2 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. 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 two methods that you can override: CreateNewFile and NewFileInfo.

14.2.1 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.2.1.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.2.2 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 ColorInfo Class

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

Constructors

ColorInfo()

Initializes an ColorInfo object to use the default color.

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

Initializes a 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.4 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.

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

  • NewTreeNodeExporter

    Exporter NewTreeNodeExporter(
      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

  • Export

    void Export()

    Perform the conversion.

  • SetDestinationFile

    OptionsCache SetDestinationFile(
      string filename
)

    Set the location of the destination file.

    filename: Full path to the destination file

    returns: The updated options object

  • SetNextSourceFile

    OptionsCache SetNextSourceFile(
      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

  • Close

    Close()

    This function closes the current Export process.

14.4.1 Document Interface

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

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.

  • GetRecordInfo

    TreeRecord GetRecordInfo(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: A TreeRecord object with the information about the record

  • SaveRecord

    void SaveRecord(
      Int32 nNodeNum,
      FileInfo fileinfo)
void SaveRecord(
      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

  • SaveRecord with Tree Record

    void SaveRecord(
      TreeRecord treeRec,
      FileInfo fileinfo)
void SaveRecord(
      TreeRecord treeRec,
      string strFileName)

    Extracts a record in an archive file to disk.

    treeRec: A TreeRecord object retrieved from GetRecordInfo with information about the node to extract

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

  • SetSourceFile

    OptionsCache SetSourceFile( string filename)

    Set the source document.

    filename: Full path of the source document

    Returns: The options cache object associated with this document

14.4.2 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.

Methods

  • OptionsCache SetSourceFile(FileInfo file)

    Sets the source document to be opened.

    file: Full path to source file

  • OptionsCache SetNextSourceFile(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 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 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.

14.4.2.1 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.4.2.2 CropToContent

OIT Option ID: SCCOPT_GRAPHIC_CROPPING

When set to True, this option forces Image Export to crop whitespace from the edge of each output image. This includes margins and any unused space at the end of a page. This results in smaller output files without any loss of original input document content.

If there is no content, then no cropping is performed.

Data Type

bool

14.4.2.3 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.4.2.4 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.4.2.5 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.4.2.6 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.4.2.7 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.4.2.8 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.4.2.9 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

1

14.4.2.10 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

1

14.4.2.11 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.4.2.12 GraphicHeight

OIT Option ID: SCCOPT_GRAPHIC_HEIGHT

This option defines the absolute height in pixels to which exported graphics will be resized. If this option is set and the GraphicWidth option is not, the width of the image will be calculated based on the aspect ratio of the source image. The developer should be aware that very large values for this option or GraphicWidth could produce images whose size exceeds available system memory, resulting in conversion failure.

If you are exporting a non-graphic file (word processing, spreadsheet or archive) and the settings for GraphicHeight and GraphicWidth do not match the aspect ratio of the original document, the exported image will have whitespace added so that the original file's aspect ratio is maintained.

The settings for the GraphicHeightLimit and GraphicWidth options can override the setting for GraphicHeight.

Data Type

Int32

14.4.2.13 GraphicHeightLimit

OIT Option ID: SCCOPT_GRAPHIC_HEIGHTLIMIT

Note that this option differs from the behavior of setting the height of graphics in that it sets an upper limit on the image height. Images larger than this limit will be reduced to the limit value. However, images smaller than this height will not be enlarged when using this option. Setting the height using GraphicHeight causes all output images to be reduced or enlarged to be of the specified height.

Data Type

Int32

14.4.2.14 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.4.2.15 GraphicRenderAsPage

OIT Option ID: SCCOPT_GRAPHIC_RENDERASPAGE

GraphicRenderAsPage affects the way raster (bitmapped) images such as TIFF, JPG, and PNG are handled. The default behavior for Image Export is to export such images as copies of the input document, scaled according to the width and height options set by the caller. If GraphicRenderAsPage is enabled, the output produced by Image Export will look like a printed page, with the image placed on a white rectangle representing a virtual page. As usual, the dimensions of the entire image, including the virtual page, will be controlled by the normal Image Export output width and height settings. The margins into which the image will be placed will be controlled by existing Outside In print margin options. The image itself will be attempted to be scaled to its true (physical) size, or scaled down to fit within the margins if necessary.

Data Type

bool

Data

  • true: Raster file images are fit to page.

  • false: Raster file images are not fit to page.

Default

false

14.4.2.16 GraphicSizeLimit

OIT Option ID: SCCOPT_GRAPHIC_SIZELIMIT

This option is used to set the maximum size of the exported graphic in pixels. It may be used to prevent inordinately large graphics from being converted to equally cumbersome output files, thus preventing bandwidth waste.

This setting takes precedence over all other options and settings that affect the size of a converted graphic.

When creating a multi-page TIFF file, this limit is applied on a per page basis. It is not a pixel limit on the entire output file.

Data Type

Int32

14.4.2.17 GraphicSizeMethod

OIT Option ID: SCCOPT_GRAPHIC_SIZEMETHOD

This option determines the method used to size graphics. The developer can choose among three methods, each of which involves some degree of trade off between the quality of the resulting image and speed of conversion.

Using the quick sizing option results in the fastest conversion of color graphics, though the quality of the converted graphic will be somewhat degraded. The smooth sizing option results in a more accurate representation of the original graphic, as it uses anti-aliasing. Antialiased images may appear smoother and can be easier to read, but rendering when this option is set will require additional processing time. The grayscale only option also uses antialiasing, but only for grayscale graphics, and the quick sizing option for any color graphics.

The smooth sizing option does not work on images which have a width or height of more than 4096 pixels.

Data Type

  • GRAPHICSIZEMETHOD_VALUES

14.4.2.18 GraphicWidth

OIT Option ID: SCCOPT_GRAPHIC_WIDTH

This option defines the absolute width in pixels to which exported graphics will be resized. If this option is set and the GraphicHeight option is not, the height of the image will be calculated based on the aspect ratio of the source image. The developer should be aware that very large values for this option or GraphicHeight could produce images whose size exceeds available system memory, resulting in conversion failure.

If you are exporting a non-graphic file (word processing, spreadsheet or archive) and the settings for GraphicHeight and GraphicWidth do not match the aspect ratio of the original document, the exported image will have whitespace added so that the original file's aspect ratio is maintained.

The settings for the GraphicHeightLimit and GraphicWidthLimit options can override the setting for GraphicWidth.

Data Type

Int32

14.4.2.19 GraphicWidthLimit

OIT Option ID: SCCOPT_GRAPHIC_WIDTHLIMIT

This option allows a hard limit to be set for how wide in pixels an exported graphic may be. Any images wider than this limit will be resized to match the limit. It should be noted that regardless whether the GraphicHeightLimit option is set or not, any resized images will preserve their original aspect ratio.

Note that this option differs from the behavior of setting the width of graphics by using GraphicWidth in that it sets an upper limit on the image width. Images larger than this limit will be reduced to the limit value. However, images smaller than this width will not be enlarged when using this option. Setting the width using GraphicWidth causes all output images to be reduced or enlarged to be of the specified width.

Data Type

Int32

14.4.2.20 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.4.2.21 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.4.2.22 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.4.2.23 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.4.2.24 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.4.2.25 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.4.2.26 LotusNotesDirectory

OIT Option ID: SCCOPT_LOTUSNOTUSDIRECTORY

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.4.2.27 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.4.2.28 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.4.2.29 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.4.2.30 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.4.2.31 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.4.2.32 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.4.2.33 QuickThumbnail

OIT Option ID: SCCOPT_QUICKTHUMBNAIL

When this option is set to true the technology will render scaled images with a focus on speed and reduced overall memory usage. This focus on speed and memory usage, in some cases, will cause the resulting images to be less readable than when this option is set to false.

Data Type

bool

Data

  • true: Render scaled images as quick thumbnails.

  • false: Render scaled images completely.

Default

true

14.4.2.34 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.4.2.35 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.4.2.36 ShowArchiveFullPath

OIT Option ID: SCCOPT_ARCFULLPATH

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

Data Type

bool

Data

  • true: Provide the full path.

  • false: Do not provide the path.

Default

false

14.4.2.37 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.4.2.38 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.4.2.39 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.4.2.40 TIFFByteOrder

This option determines the byte order used within the file.

Data

  • BigEndian: This will use big-endian (Motorola) byte ordering.

  • LittleEndian: This will use little-endian (Intel) byte ordering (this is the default value for this parameter).

14.4.2.41 TIFFColorSpace

This option allows the developer to control the TIFF color depth and color options.

Data Type

TIFFColorSpaceValue

TIFFColorSpaceValue Enumeration

This enumeration defines the type of Color model to use in the exported TIFF File.

  • BlackWhite 1 bit black and white

  • Palette8Bit 8 bit palette

  • RGB24Bit 24 bit RGB

14.4.2.42 TIFFCompression

This option will specify the type of compression used in the TIFF file that is generated.

Data Type

TIFFCOMP_VALUES

14.4.2.43 TIFFFillOrder

This option determines the fill order used within the file. The value of this element only affects TIFF output when the TIFFCompression option is set to CCITT_GROUP3 and the TIFFColorSpace element is set to BLKWHITE.

Data Type

TIFFFillOrderValue

TIFFFillOrderValue Enumeration

The following set of flags:

  • FileStore: TIFF files intended for file stores

  • Transmission: TIFF files intended for electronic transmission (example fax)

  • AllOff

Default

AllOff

14.4.2.44 TIFFMultiPage

This allows the developer to specify whether the output creates a single multi-page TIFF file or individual single page files. When this flag is true, the output of multiple pages from one input document will generate a single file with a separate image for each page converted.

Data Type

bool

Default

false

14.4.2.45 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.4.2.46 TransparencyColor

OIT Option ID: SCCOPT_GRAPHIC_TRANSPARENCYCOLOR

This option allows the user to set the color used as the "transparency color" in the output graphic file. Naturally, this option is only used when the selected output graphic file format supports transparency (GIF and PNG only). If the option is not set, the default behavior is to use the same color value that the input file used as the transparency color.

Use the (r, g, b) macro to create the color value to pass to this option. The red, green and blue values are percentages of the color from 0-255 (with 255 being 100%). Note that this macro should be used to set a variable and that variable should then be passed to the set option routine (instead of trying to use the macro as part of the set option call directly).

Since there is no way to "unset" an option once it has been set, the developer may set the option to DefaultTransparencyColor if they wish to revert to the default behavior.

Class members:

byte Red

byte Green

byte Blue

14.4.2.47 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.4.2.48 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.5 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.

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

14.6 FileFormat Class

This class defines the identifiers for file formats.

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.7 FontAliases Class

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

Constructor

FontAliases(Boolean  clearDefaults, Dictionary<string, string> aliasList)
   clearDefaults  Option to clear current list to defaults or empty list
   aliasList      Aliases list as a key-value pair with original name as key

Properties

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

  • ClearDefaults (Boolean) - When set to false, the existing alias list is cleared and set to a list of default aliases. Otherwise the existing alias list is cleared out.

14.8 FontInfo Class

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

Constructor

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.9 FontList Class

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

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.10 HighlightTextAnnotation Class

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

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.11 MailHeaders Class

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

Constructor

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.12 Margins Class

The Margins Class is used to describe the page margins.

Constructor

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.13 OutsideIn Class

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

Methods

static Exporter NewLocalExporter()

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

14.14 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.

14.15 PageInfo Class

PageInfo is a class for defining page dimensions.

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.16 PageRange Class

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

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.17 TreeRecord Class

TreeRecord provides information about an archive record. This is a read only class where the technology fills in all the values.

Properties

  • bIsDirectory (Boolean) A value of true indicates that the record is a directory node.

  • dwFileSize (Int32) File size of the tree record

  • dwTime (Int32) Time the tree record was created

  • nNodeNum (Int32) Serial number of the tree record in the archive

  • strNodeName (String) The name of the tree record

Close Window

Table of Contents

Oracle Outside In Image Export Developer's Guide

Expand | Collapse