15 Web View Export .NET Classes
This chapter covers the following classes:
15.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; 0==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.
15.2 ArchiveNode Class
ArchiveNode provides information about an archive record. 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
15.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.
15.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.
15.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.
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 may 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.
15.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
15.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.
15.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 a 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
15.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, use this method with "bLeaveSourceOpen" set to true. -
SetExportTemplate
SetExportTemplate(FileInfo template)
This method sets the template file to be used for export.
template: A FileInfo object representing the template to be used for export.
-
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.
15.5.1 IAnnotatable Interface
All of the Outside In annotation-related methods are accessed through the IAnnotable Interface.
NameSpace
OutsideIn.Annotations
Methods
-
AddStampAnnotation
void AddStampAnnotation( StampAnnotation StampAnno)
Add a stamp annotation to the exported document.
StampAnno: A StampAnnotation object with information about the stamp to add.
-
AddStampAnnotation and Add Annotation Properties
void AddStampAnnotation( StampAnnotation StampAnno, Dictionary<string, string> Properties)
Add a stamp annotation to the exported document and associate properties with the annotation.
StampAnno: A StampAnnotation object with information about the stamp to add.
Properties: Key value pairs of name/value of properties associated with this annotation.
-
AddStampAnnotation and Associate Comment with Annotation
void AddStampAnnotation( StampAnnotation StampAnno, string Comment)
Add a stamp annotation to the exported document and associate a comment with the annotation.
StampAnno: A StampAnnotation object with information about the stamp to add
Comment: Comment text to associate with the annotation
-
AddStampAnnotation with Comment and Properties
void AddStampAnnotation( StampAnnotation StampAnno, string Comment, Dictionary<string, string> Properties)
Add a stamp annotation to the exported document and associate a comment and properties with the annotation.
StampAnno: A StampAnnotation object with information about the stamp to add
Comment: Comment text to associate with the annotation
Properties: Key value pairs of name/value of properties associated with this annotation
-
AddStampImage
void AddStampImage( Dictionary<string, Uri> stamps )
This method maps a stamp name to an image URL.
stamps: Key value pairs of stamp names and image URLs
-
ApplyHighlights
void ApplyHighlights( string HighlightJsonData )
This method applies a set of highlights from a JSON-encoded text stream previously generated from the Web View Export Javascript library.
HighlightJsonData: stream of highlight (and comment) information that was obtained via the Web View Export Javascript API function OIT.highlights.serialize.
-
AddAreaHighlight
void AddAreaHighlight( HighlightAreaAnnotation HighlightAreaAnno )
Highlight an area on a page in a document.
HighlightAreaAnno: A HighlightAreaAnnotation object with information about the area to highlight
-
AddAreaHighlight and Add Annotation Properties
void AddAreaHighlight( HighlightAreaAnnotation HighlightAreaAnno, Dictionary<string, string> Properties )
Add an area highlight to a document and associate properties with the annotation.
HighlightAreaAnno: A HighlightAreaAnnotation object with information about the area to highlight
Properties: Key value pairs of name/value of properties associated with this annotation
-
AddAreaHighlight and Associate Comment with Annotation
void AddAreaHighlight( HighlightAreaAnnotation HighlightAreaAnno, string Comment )
Highlight an area on a page in a document and associate a comment with the annotation.
HighlightAreaAnno: A HighlightAreaAnnotation object with information about the area to highlight
Comment: Comment text to associate with the annotation
-
AddAreaHighlight with Comment and Properties
void AddAreaHighlight( HighlightAreaAnnotation HighlightAreaAnno, string Comment, Dictionary<string, string> Properties )
Add an area highlight to a document, including associated comment text and properties.
HighlightAreaAnno: A HighlightAreaAnnotation object with information about the area to highlight
Comment: Comment text to associate with the annotation
Properties: Key value pairs of name/value of properties associated with this annotation
-
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
15.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.
-
GetObjectInfo
ObjectInfo GetObjectInfo()
Retrieves the information about an embedded object.
Return: An ObjectInfo object with the information about the embedded object
-
GetArchiveNode
ArchiveNode GetArchiveNode(Int32 nNodeNum)
Retrieves information about a record in an archive file
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: A TreeRecord 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
15.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)
Sets the source document.
filename: Full path of the source document
Returns: The options cache object associated with this document
-
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 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.
15.5.3.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
BiDiReorderMethodValue.UnicodeOff
15.5.3.2 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
DefaultInputCharacterSetValue.SystemDefault
15.5.3.3 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
15.5.3.4 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
15.5.3.5 DefaultRenderFont
This option sets the font to use when the font specified by the filter is not available on the system.
Data Type
FontInfo
Data
The default font to be used
Default
None
15.5.3.6 DocumentMemoryMode
OIT Option ID: SCCOPT_DOCUMENTMEMORYMODE
This option determines the maximum amount of memory that the internal storage may use to store the document's data, from 4 MB to 1 GB. The more memory the internal storage 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
DocumentMemoryModeValue.Large
15.5.3.7 EMailAttachmentHandling
This option determines whether email attachments are converted or extracted.
Data Type
EmailAttachmentHandlingValue
EmailAttachmentHandlingValue Enumeration
-
None: Attachments will not be converted or extracted.
-
Export: The attachments to this email will be converted.
-
ExportRecursive: The attachments to this email will be converted; if any are emails, they will also have their attachments converted, and so on.
-
Extract: Attachments will be extracted in their native form, stored alongside the Web View output files.
Default
EmailAttachmentHandlingValue.None
15.5.3.8 ExternalStylesheets
String option for specifying the url of a user supplied stylesheet to be included in the output html file. Values specified through this option will appear in output HTML files as linked stylesheets.
Example
<script src="oit.css"> <link rel="stylesheet" href="/some/path/myStylesheet.css"/>
Data Type
List<string>
Default
None
15.5.3.9 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
FallbackFormatValue can be one of the following enumerations:
-
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
FallbackFormatValue.Text
15.5.3.10 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
Please refer to the section "SCCOPT_PRINTFONTALIAS" in the C-API for the default font alias list.
15.5.3.11 FontBaseURL
This option allows the developer to specify the base URL used in the Web View Export output when referencing a non-exported font as a downloadable font. (Exported fonts will be placed in the exported output location.)
Data Type
String
Default
None
15.5.3.12 FontDirectories
This option allows the developer to specify one or more font directories where fonts are located for use by Web View Export. If multiple font directories are specified, they should be delimited by a colon on Linux and UNIX systems and a semi-colon on Windows systems. Please note that Web View Export supports single TrueType fonts (*.ttf, *.TTF) and TrueType collections (*.ttc, *.TTC), not Windows bitmap fonts (*.fon, *.FON), or any other type of font. Also, Web View Export does not require case-sensitive font filenames on UNIX systems.
Data Type
List<DirectoryInfo>
Default
None
15.5.3.13 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
15.5.3.14 FontReferenceMethod
This option controls the way embedded fonts are presented (or not) in the HTML5 output.
Data Type
FontReferenceMethodValue
FontReferenceMethodValue Enumeration
-
ReferenceByName: The font is referenced in the output file by name only
-
ReferenceExported: The font is subsetted, exported during document conversion, and referenced in the output by file name
-
ReferenceByBaseURL: The full font is referenced in the output using the font file name and the base URL supplied by the FontBaseURL option.
Default
FontReferenceMethodValue.ReferenceByName
15.5.3.15 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
UInt32
Default
0
15.5.3.16 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, setting this option to 0 (Maintain Source Image DPI) 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 0 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 setting this option to 0 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.
Data Type
UInt32
Default
96
15.5.3.17 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
UInt32
Default
0
15.5.3.18 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
UInt32
Default
0
15.5.3.19 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 Type
IECondCommentFlagValues
IECondCommentFlagValues Enumeration
IECondCommentFlagValues can be one or more of the following enumerations ORed together:
-
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
Default
IECondCommentFlagValues.None
15.5.3.20 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 will return an error.
Currently, only the PST and MDB Filters support this option
Data Type
bool
Default
false
15.5.3.21 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
15.5.3.22 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.
Either Lotus Notes version 8 or Lotus Domino version 8 must be installed on the same machine as OIT. A 32-bit version of the Lotus software must be used if you are using a 32-bit version of OIT. A 64-bit version of the Lotus software must be used if you are using a 64-bit version of OIT.
Data Type
String
Default
None
15.5.3.23 MarginText
This option lets you specify a text string for margin text.
Data Type
MarginText
Default
None
15.5.3.24 MarginTextFont
This option is used to set the margin text font and font size.
Data Type
FontInfo
Default
Arial, 9 pt.
15.5.3.25 OutputRawtext
An option controlling whether raw text output is generated on the server side. This option must be enabled in order to enable in-browser searching via the Outside In API. This does not affect the search capabilities of the browser itself. Raw text generation is enabled by default.
Data Type
bool
Default
true
15.5.3.26 PageRange
This option indicates whether the whole file or a selected range of pages should be rendered.
Data Type
PageRange
Data
The page range to be exported.
Default
All pages are printed
15.5.3.27 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.
15.5.3.28 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.
15.5.3.29 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.
Data Type
PDFReorderBiDiValue
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.
Default
PDFReorderBiDiValue.StandardBiDi
15.5.3.30 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
15.5.3.31 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
15.5.3.32 PostLibraryScripts
List of strings specifying the relative URL of the customer's initialization script. Scripts specified via this option will load after the Outside In libraries, and may access the Outside In Javascript API. The scripts will be referenced in the same order as that of list used to set this option.
Example:
<script src="oit.js"> <script src="/config/oitinit.js">
Data Type
List<string>
Default
None
15.5.3.33 PreLibraryScripts
List of strings specifying the URL of a script file to be referenced via a <script> tag in the output file. Scripts specified via this option will load before the Outside In libraries. The scripts will be referenced in the same order as that of list used to set this option.
Example:
<script src="/jQuery/jQuery-min.js"> <script src="/shims/customstuff.js"> <script src="oit.js">
Data Type
List<string>
Default
None
15.5.3.34 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
15.5.3.35 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.
15.5.3.36 RedactionLabelsVisible
This option allows you to display redaction labels in your output.
Data Type
Boolean
Default
False (no labels)15.5.3.37 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
15.5.3.38 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
15.5.3.39 ShowArchiveFullPath
This option causes the full path of a node to be returned in "GetArchiveNodeInfo" and "GetObjectInfo".
Data Type
bool
Default
false
15.5.3.40 StrokeOutText
This option is used to stroke out (display as graphical primitives) text in an AutoCAD file. Setting this option to false would improve performance, but the visual fidelity may be compromised.
-
If the export for the conversion is text only, text is never stroked out.
-
If the export is not text only, and the drawing is perspective, text will always be stroked out (regardless of this option). This is due to the fact that in non-text only situations visual fidelity is of importance, and handling of textual objects in perspective drawings is more accurate with stroked out text. If the conversion is non-text only and the drawing is not perspective, this option determines if text should be stroked.
Note that when this option is true, some special characters appear as asterisks or question marks due to limited support of characters for stroking out text.
Data Type
bool
Default
true
15.5.3.41 TempDirectory
From time to time, the technology needs to create one or more temporary files. This option sets the directory to be used for those files.
It is recommended that this option be set as part of a system to clean up temporary files left behind in the event of abnormal program termination. By using this option with code to delete files older than a predefined time limit, the OEM can help to ensure that the number of temporary files does not grow without limit.
If a developer would like to manage temporary files using redirected IO to completely take over responsibility for the low level IO calls of the temp file , they can set the option value to null and everytime a new temporary file needs to be created, a callback method CreateTempFile shall be called. Note that it is mandatory to support this callback if the option is set to null.
Data Type
String
Default
The system default directory for temporary files. On Windows systems, it is the value of environment variable %TMP%.
15.5.3.42 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:
This option does not apply for spreadsheet files.
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
Default
-
0: GMT time
15.5.3.43 UnmappableCharacter
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
UInt16
Default
42
15.5.3.44 URLPathOutput
String option for specifying the base URL for output files generated during the export process. The value of this option is used as a prefix for references to those resources in the primary output file. If the output base URL is "/exports/", an image tag in an exported document would look like this:
<img src="/exports/doc01.doc.jpg" />
and URLs to the exported files within content.js would be of this form:
{id:"page.1",name:"Page 1",type:"page",oid:"overlay.1",w:"816px",h:"1056px",src:"/exports/output.3.html"}
By default, the output file base URL is empty, and all output will be specified without path information.
Data Type
String
Default
None
15.5.3.45 URLPathResources
String option for specifying the base URL for Web View Export scripts, css files and other resources that do not vary with the converted file. The value of this option is used as a prefix for references to those resources in the primary output file. For example, if the resources' base URL is "/oit/", the script reference in the output file would look like this:
<script src="/oit/oit.js"></script>
By default, this value is empty, meaning all resources must be present in the same directory as the generated output.
Data Type
String
Default
None
15.5.3.46 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
15.5.3.47 VectorObjectLimit
This value sets a limit on the number of objects that will be generated in an SVG drawing so that browser capabilities will not be exceeded. A value of 0 indicates no limit.
Web View Export renders vector-based graphics from source documents as SVG drawings. SVG is part of the HTML5 specification and provides native browser-based support for vector graphics, and usually results in superior visual fidelity. However, while HTML5 browsers generally support SVG vector graphics very well, this native support can be pushed past its limits with highly complex source documents. To avoid overtaxing a browser, this option allows a limit to be placed on the complexity of SVG graphics created from such source documents. Once the specified number of objects has been added to an SVG drawing, no further graphic objects will be added.
This limit is reset for each page of output; hitting the limit on the first page of the document doesn't prevent SVG objects from being created for subsequent pages of the Web View Export output.
An application can detect if an input document triggered this limit by using the EXExportStatus API function.
Data Type
UInt32
Default
5000
15.5.3.48 WebFontPermissions
This option controls the use of "embedded" fonts (see FontReferenceMethod) in the Web View Export output; specifically, whether or not a downloadable (web font) version of the font should be made available to Web View Export output, based on the licensing restrictions indicated within the font itself.
Data Type
WebFontPermissionValues
WebFontPermissionValues Enumeration
WebFontPermissionValues can be one or more of the following enumerations ORed together:
-
DefaultPermissions
-
RequireInstallable
-
RequirePreviewPrint
-
RequireEditable
-
AllOff: All flags turned off
Default
WebFontPermissionValues.DefaultPermissions
15.5.3.49 WebViewLibraryName
String option specifying the file name of the Web View Javascript library, which will be written into a <script> tag in the generated HTML files for a Web View. If this option is not set, the value "oit.js" will be used. This option allows the Web View Javascript library to be renamed for versioning or other purposes. This option works in combination with the URLPathResources option.
Data Type
String
Default
oit.js
15.5.3.50 WebViewStructure
This option controls the structure of the output files created by Web View Export.
Data Type
WebViewStructureValue
Method
-
FileFormat GetDestinationFormat()
Gets the destination file format to which the file would be converted.
Returns: the format to convert the input document(s) to.
WebViewStructureValue Enumeration
-
Flat: HTML content is exported in a single HTML file.
-
AjaxChunked: HTML content is spread among multiple output pages.
-
AjaxStreamed: HTML content is spread among multiple output pages and the browser may begin viewing the document before the entire output has been produced.
-
PageStreaming: HTML content is spread among multiple independent output files.
Default
WebViewStructureValue.Flat
15.5.3.51 WebViewStylesheetName
String option specifying the file name of the Web View stylesheet, which will be written into a <link> tag in the generated HTML files for a Web View. If this option is not set, the value "oit.css" will be used. This option allows the Web View stylesheet to be renamed for versioning or other purposes. This option works in combination with the URLPathResources option
Data Type
String
Default
oit.css
15.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
Methods
-
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 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 subdocument 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 subdocument 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.
-
VectorObjectLimit: The vector object limit was reached.
-
InvalidAnnotationNotApplied: Unsupported annotation/redaction wasn't rendered.
15.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.
15.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.
15.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
15.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.
15.11 HighlightAreaAnnotation Class
The HighlightAreaAnnotation class defines the characteristics of a highlighted area annotation. This class derives from the Annotation class.
Namespace
OutsideIn.Annotations
Constructors
HighlightAreaAnnotation(Int64 userId, Int64 sectionIx, Int64 Top, Int64 Left, Int64 Width, Int64 Height, Annotation.UnitTypeValue units, Single opacity, ColorInfo fillColor, HighlightAreaAnnotation.AnnoBorder border, HighlightAreaAnnotation.BorderStyleValue borderStyle):
Initializes a new instance of the HighlightAreaAnnotation class.
Methods
SetBorder(HighlightAreaAnnotation.BorderSidesValue side, HighlightAreaAnnotation.AnnoBorder)
-
Parameters:
side: The side to which this border shall be applied. HighlightAreaAnnotation.BorderSidesValue is an enumeration of the sides of the annotation.
border: The type of border to be used.
Properties
-
BorderStyle: The style of the border. (Note: in the initial release of Web View Export, only solid borders are supported)
-
FillColor: Color to be used to fill the area
-
BottomBorder: Border style to use for the bottom border
-
LeftBorder: Border style to use for the left border
-
RightBorder: Border style to use for the right border
-
TopBorder: Border style to use for the top border
15.11.1 AnnoBorder Class
The AnnoBorder class defines the characteristics of the borders of annotations.
Constructors
AnnoBorder(ColorInfo color, System.Int64thickness) colorType: Color of the annotation border thicknessType: Thickness of the annotation border
Initializes a new instance of the AnnoBorder class.
15.12 HighlightTextAnnotation Class
The HighlightTextAnnotation class applies to characteristics of a highlighted text annotation. This class derives from the Annotation class.
Note:
the application of character attributes through highlighting is not supported in the initial release of Web View Export.
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
15.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)
15.14 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
15.15 Options
This class describes all the options that Outside In supports. This derives from the Option Class.
Namespace
OutsideIn.Options
Method(s)
ReadOnlyCollection<Options> EnumerateOptions()
This method retrieves the set of Options that Outside In supports. Using the "Set" method provided by the base class, an option can be set to the value desired.
15.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.
15.17 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.
15.18 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
15.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
15.20 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
15.21 PageInfo Class
PageInfo is a class for defining page dimensions.
Namespace
OutsideIn.Options
Constructor
PageInfo(PageInfo.PageSizeUnitsValues 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.PageSizeUnitsValues Enumeration
PageSizeUnitsValues 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)
15.22 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.
15.23 StampAnnotation Class
StampAnnotation is the class for defining stamp annotations. This class derives from the Annotation class.
The StampAnnotation type exposes the following members.
Namespace
OutsideIn.Annotations
Constructors
StampAnnotation(long userId, Int64 sectionIx, Int64 Top, Int64 Left, Int64 Width, Int64 Height, Annotation.UnitTypeValue units, Single opacity, StampAnnotation.SizingMethodValue sizemode, String stampName) userId User Data sectionIx 0-based page/sheet/image/slide index Top Top coordinate or row Left Leftmost coordinate or column Width Width of area in coordinates or columns Height Height of area in coordinates or rows Units Unit type Opacity Opacity of the annotation. Range 0.0 - 1.0; 0==invisible Sizemode Image sizing method stampName Name of the stamp
Properties
SizeMode: Sizing method of the source image
StampName: Registered name of stamp image
SizingMethodValue Enumeration
The SizingMethodValue is an enumeration of the sizing methods that can be applied to the image.