Previous Next JavaScript must be enabled to correctly display this content

SDK Reference

This appendix serves as a reference for the Software Developer’s Kit.

Quick Reference

The tables in this section act as a pointer to more detailed information later in this chapter.

An asterisk in the following lists indicates a read-only action.

Viewing Documents

This section contains properties, methods and events used when viewing documents.

Selecting Files

PROPERTIES METHODS EVENTS

CurrentPageNumber*

DefaultInputCharSet

DisplayEngineName*

DisplayEngineType*

DisplayFont

DocumentMemoryMode

EMailDisplayMode

EMailFitMode

FallbackFormat

FileInfoDisplayName*

FileInfoFileId*

FileInfoFileIdName*

FileInfoName*

FilterOptions

FontScalingFactor

HTMLDisplayMode

HTMLFitMode

MaintainZoom

SystemUnicode

UnmappableChar

Clear

ViewFile

DisplayEngineChange

FileChange

GetCredentials

InformationMessage

ViewThisFile

Printing

PROPERTIES METHODS EVENTS

PrintCollate

PrintCopies

PrintEndPage

PrinterDC

PrinterDriver

PrintJobName

PrinterName

PrinterPort

PrintStartPage

PrintFont

PrintMarginLeft_ Right_ Top_ and Bottom

UseDocPageSettings

WhatToPrint

PrintSetup

PrintOI

PrinterAbort

Clipboard

PROPERTIES METHODS EVENTS

ClipFont

ClipInfo*

EnableDragNDrop

ToClipboard

CopyToClip

None

User Interface Options

This section describes user interface options.

Text Selection

PROPERTIES METHODS EVENTS

SelectionAnchor

SelectionEnd

SelectAll

SelChange

Menus

PROPERTIES METHODS EVENTS

DoContextMenu

None

ContextMenu

Dialogs

PROPERTIES METHODS EVENTS

DialogFlags

ResourceLibraryID

ClipboardOptions

DisplayOptions

PrintOptions

DoHelp

EnableApp

OptionChange

Scroll Bar Interaction

PROPERTIES METHODS EVENTS

HScrollbar

VScrollbar

HScroll

VScroll

HScrollPageSize

HScrollPosition

HScrollRange

HScrollState

VScrollPageSize

VScrollPosition

VScrollRange (obsolete)

VScrollRangeMin

VScrollRangeMax

VScrollState

Miscellaneous

PROPERTIES METHODS EVENTS

HTMLCondCommentMode

ParseXMPMetadata

IdleBitmap

GetProperty

Keydown

Display Engine Options

This section presents Display Engine options.

Formatting

PROPERTIES METHODS EVENTS

FormatFlags

IntlFlags

TimeZoneOffset

None

None

Image

PROPERTIES METHODS EVENTS

AntiAliasMode

BMPFitMode

BMPPrintAspect

BMPPrintBorder

BMPDither

BMPDitherAvailable*

BMPRotation

ImgXZoomPercent

ImgYZoomPercent

RenderEmbeddedFonts

StrokeText

VecFitMode

VecPrintAspect

VecPrintBorder

VecPrintBackground

VecShowBackground

ImgZoom

ImgShowFullScreen

None

Word Processing

PROPERTIES METHODS EVENTS

EMailViewDisabled

GetCustomEMailHeader

SetCustomEmailHeader

WPDisplayMode

WPFitMode

WPEmailHeaderOutputMode

WPWrapToWindow

None

None

Archive Options

PROPERTIES METHODS EVENTS

ArchiveSortOrder

ArchiveSortDescending

ArchiveSave

None

Database/Spreadsheets

PROPERTIES METHODS EVENTS

DBClipBoard

DBDraftMode

DBFieldNamesToClip

DBPrintGridLines

DBPrintHeadings

DBPrintFit

DBShowGridLines

SSClipBoard

SSDraftMode

SSPrintDirection

SSPrintGridLines

SSPrintHeadings

SSPrintFit

SSPrintScalePercent

SSPrintScaleXHigh

SSPrintScaleXWide

SSShowGridLines

SSShowHiddenCells

None

None

Searching

PROPERTIES METHODS EVENTS

None

Search

SearchNext

None

Positions

PROPERTIES METHODS EVENTS

None

ComparePositions

CopyPosition

DisplayPosition

FindPosition

GetActualCount

SetPositionToCurrent

SetPositionToSelection

SetActualCount

None

Annotations

PROPERTIES METHODS EVENTS

AnnotationData*

AnnotationDataType*

AnnotationEndPos*

AnnotationId*

AnnotationStartPos*

AddAnnotationHilite

AddAnnotationHideText

AddAnnotationInsertText

AddAnnotationPicture

ClearAnnotations

FindAnnotation

AnnotationSetPos

GetAnnotationData

GoToAnnotation

HiliteStyle

AnnotationEvent

Raw Text

PROPERTIES METHODS EVENTS

RawTextCharSet*

RawTextLength*

RawTextOffset*

RawTextString*

SystemRawText

GetRawText

RawTextEvent

Advanced Topics

The following tables describe more advanced topics.

Drawing Pages

PROPERTIES METHODS EVENTS

PageFormatHeight*

PageFormatWidth*

PagePaletteHandle*

PagePicture*

PageResultBottom*

PageResultLeft*

PageResultRight*

PageResultTop*

PageUnitsPerInch*

DeinitDrawPage

DrawPage

DrawPageEx

ExtDrawPage

GetDrawPageInfo

GetPageCount

InitDrawPage

None

Memory I/O

PROPERTIES METHODS EVENTS

CopyBuffer

CopyBufferSize

Copy

None

Redirected I/O

PROPERTIES METHODS EVENTS

None

None

Close

GenSecond

GetInfo

Open

Read

Seek

Tell

System

PROPERTIES METHODS EVENTS

FIFlags

ReorderMethod

StatusEvents

SysLotusNotesPath

SystemTimer

SystemReadAhead

SystemIdle

GetTechPath

ReadAheadDone

Stat

Miscellaneous

The following are other items referenced in this chapter.

Errors

PROPERTIES METHODS EVENTS

ErrorCode*

ErrorMsg*

ErrorShowMsg

PDFInputMaxEmbeddedObjects

PDFInputMaxVectorPaths

PDFWordSpacingFactor

None

Error

Properties

The following properties are used in the SDK.

Note:

All property options are Local in scope except where noted.

AnnotationData

Read only. This contains the user data value of the last annotation accessed.

Type

VARIANT

Default

0

Related to

SCCVW_FINDANNOTATION (Outside In Viewer)

AnnotationDataType

Read only. This contains the format of the last annotation accessed. Valid values are:

Type

Short

Default

ADTYPE_NODATA

Related to

SCCVW_GETANNOTATIONDATA (Outside In Viewer)

AnnotationEndPos

Read only. This contains the position object of the last annotation accessed.

Type

OixPos

Default

none

Related to

SCCVW_FINDANNOTATION (Outside In Viewer)

AnnotationId

Read only. This contains the Id value of the last annotation added or found.

Type

Long

Default

0

Related to

SCCVW_FINDANNOTATION (Outside In Viewer)

AnnotationStartPos

Read only. This contains the position object of the last annotation accessed. This position is a zero-based character count.

Type

OixPos

Default

none

Related to

SCCVW_FINDANNOTATION (Outside In Viewer)

AntiAliasMode

This property determines whether bitmaps with higher color resolution than the screen should use a dithering algorithm to improve the display.

Note:

This option is Global in scope.

Type

BOOL

Default

True

Related to

SCCID_ANTIALIAS (Outside In Viewer)

ArchiveSortDescending

If the archive listing is sorted (see ArchiveSortOrder), this property determines the direction that the list will be sorted.

Type

BOOL

Default

FALSE

Related to

SCCID_ARCSORTORDER (Outside In Viewer)

ArchiveSortOrder

Determines the order in which the files are displayed in the archive display engine. One of the following values:

Type

Short

Default

SCCVW_SORT_NONE

Related to

SCCID_ARCSORTORDER (Outside In Viewer)

BMPDither

Determines whether or not to use a dithering algorithm on bitmaps with higher color resolution than the screen in order to get a better color display. One of the following values:

Type

BOOL

Default

FALSE

Related to

SCCID_BMPDITHER (Outside In Viewer)

BMPDitherAvailable

Read only. This property indicates whether or not the current image can be dithered. For instance, dithering is not possible or necessary for a 16-color bitmap on a 256-color display, but is possible for a 256 bitmap on a 16-color display. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_BMPDITHERAVAILABLE (Outside In Viewer)

BMPFitMode

Determines how the display engine (vector or bitmap) displays (stretches/shrinks) an image in relation to the size of the view window. One of the following values:

Invalid values are reset to the last set value.

Type

Short

Default

SCCVW_FITMODE_ORIGINAL

Related to

SCCID_BMPFITMODE (Outside In Viewer)

BMPPrintAspect

The option indicates how the image will be stretched when printed. It can be one of the following values:

Invalid values will be reset to the last set value.

Type

Short

Default

SCCVW_PRINTASPECT_SCALE

Related to

SCCID_BMPPRINTASPECT (Outside In Viewer)

BMPPrintBorder

Determines if a one-pixel border is to be printed around images. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_BMPPRINTBORDER (Outside In Viewer)

BMPRotation

Determines how the bitmap is to be rotated. These rotations are absolute from the graphics initial state. One of the following values:

Type

Short

Default

SCCVW_ROTATION_NONE

Related to

SCCID_BMPROTATION (Outside In Viewer)

ClipFont

This property allows the developer to set the default clipboard font. The developer may implement a font dialog or set this value directly. If the developer chooses to implement his own dialog, be advised that a default font will be used for any printer font selected from the dialog.

The developer should set the ToClipboard property (see ToClipboard) to RTF (0x2) to copy text to the clipboard in this font.

Type

LPFONTDISP

Related to

SCCID_DEFAULTCLIPBOARDFONT (Outside In Viewer)

ClipInfo

Read only. This property holds flags that specify the readiness of the view window to manipulate clipboard information.

Currently, valid values for this property are:

Type

ULONG

Default

SCCVW_NOTREADYCOPYTOCLIP

Related to

SCCVW_GETCLIPINFO (Outside In Viewer)

CopyBuffer

Read only. This property contains a string that contains the data requested by a call to the Copy method (see Copy). If no call has been made to the Copy method, then the value will be a null string.

Type

BSTR

Default

Null

Related to

SCCVW_COPY (Outside In Viewer)

CopyBufferSize

Read only. This property contains the size of the data produced in the copy buffer as a result of a call to the Copy method (see Copy). If no call has been made to the Copy method, then the value will be zero.

Type

Long

Default

0

Related to

SCCVW_COPY (Outside In Viewer)

CurrentPageNumber

Read only. This property contains the page number of the page currently displayed in the view window. A value of 0 is returned to indicate that the current page number is not available.

The page number is available when the word processing display engine is in preview mode, and not available when it is in draft or normal mode. For other formats such as spreadsheets, presentations, and multi-page images, the page number is equivalent to the number of the current sheet, slide, or image.

Type

Long

Default

0

Related to

SCCVW_GETCURRENTPAGENUMBER (Outside In Viewer)

DBClipBoard

Determines which format the database takes when it is copied to the clipboard. One of the following values:

Type

Short

Default

SCCVW_CLIPSUBFORMAT_TABLE

Related to

SCCID_DBCLIPBOARD (Outside In Viewer)

DBDraftMode

Determines how much formatting information is included when displaying a database or spreadsheet. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_DBDRAFTMODE (Outside In Viewer)

DBFieldNamesToClip

Determines if field headings / row and column names will the copied to the clipboard along with the data. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_DBFIELDNAMESTOCLIP (Outside In Viewer)

DBPrintFit

Determines how the database printouts are fitted to the paper size and default print margins.

If the scaling is too much (one-fifth the original size) it is limited to that amount and will continue on additional pages. Aspect ratio is maintained. One of the following values:

Type

Short

Default

SCCVW_DBPRINTFITMODE_NOMAP

Related to

SCCID_DBPRINTFITTOPAGE (Outside In Viewer)

DBPrintGridLines

Determines if a dotted line is printed between fields. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_DBPRINTGRIDLINES (Outside In Viewer)

DBPrintHeadings

Determines if field headings will be printed along with the data. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_DBPRINTHEADINGS (Outside In Viewer)

DBShowGridLines

Determines if a dotted line is displayed between fields. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_DBSHOWGRIDLINES (Outside In Viewer)

DefaultInputCharSet

This property defines the character set to be used when the technology 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. Possible values are the CS_ values defined in the header files.

Note:

This option supersedes the FallbackFormat option for selecting the character set assumed for plain-text files. For backwards compatibility, use of deprecated character-set -related values is still currently supported for FallbackFormat, though internally such values will be translated into equivalent values for the DefaultInputCharSet. As a result, if an application were to set both options, the last such value set for either option would be the value that takes effect.

Note:

This option is Global in scope.

Type

LONG

Default

CS_SYSTEMDEFAULT

Related to

SCCID_DEFAULTINPUTCHARSET (Outside In Viewer)

DialogFlags

Determines how dialogs are displayed and how dialog choices are added to the menus. It can be one or more of the following OR-ed together.

Type

Short

Default

0

Related to

SCCID_DIALOGFLAGS (Outside In Viewer)

DisplayEngineName

Read only. This property contains the name of the display engine. These names include: “Spreadsheet,” “Database,” “Document,” “Bitmap,” “Archive,” “Hex,” and “Drawing.”

Type

BSTR

Default

Null

Related to

SCCVW_GETDISPLAYINFO (Outside In Viewer)

DisplayEngineType

Read only. This property contains a numeric identifier for the type of display engine in use. The types are as follows:

Type

SHORT

Default

SCCVWTYPE_NONE

Related to

SCCVW_GETDISPLAYINFO (Outside In Viewer)

DisplayFont

This property allows the developer to set the default display font. The developer may implement a font dialog or set this value directly.

Type

LPFONTDISP

Related to

SCCID_DEFAULTDISPLAYFONT (Outside In Viewer)

DoContextMenu

This property determines if the built-in context menu will be displayed when the user performs a right-mouse click. If this is set to FALSE then the control will not display a context menu and the developer will have to implement the ContextMenu event (see ContextMenu) in order to provide one.

Type

BOOL

Default

TRUE

Related to

SCCVW_CONTEXTMENU (Outside In Viewer)

DocumentMemoryMode

This property determines the maximum amount of memory that the internal caching system may use to store the document’s data, from 4 MB to 1 GB. The more memory that is available to the caching system, the less often it needs to re-read data from the document. It can be one of the following values:

Note:

This option is Global in scope.

Type

LONG

Default

SCCDOCUMENTMEMORYMODE_LARGE (256MB)

Related to

SCCID_DOCUMENTMEMORYMODE (Outside In Viewer)

EMailDisplayMode

This property indicates how the word processor display engine displays the email file. It can be one of the following:

Type

Short

Default

SCCVW_WPMODE_WEBLAYOUT

Related to

SCCID_EMAILDISPLAYMODE (Outside In Viewer)

EMailFitMode

Controls the size of email files when using preview or weblayout mode.

Data

One of the following values:

EMailViewDisabled

This property determines whether or not the E-mail header will be displayed.

Note:

This option is Global in scope.

Type

BOOL

Default

False

Related to

SCCID_WPDISABLEEMAILHEADER (Outside In Viewer)

EnableDragNDrop

Enables the drag and drop capability of the control. This allows users to click on a highlighted selection in a document and drag it to a target application that can accept it.

Type

BOOL

Default

FALSE

Related to

SCCID_OLEFLAGS (Outside In Viewer)

ErrorCode

Read only. Contains a code for the error status of the last operation performed by the control. This code can refer to both errors in the ActiveX control or in the Outside In Technology. It is 0 if there is no error.

Type

LONG

Default

0

Related to

SCCVW_BAILOUT (Outside In Viewer)

ErrorMsg

Read only. Contains an error message that corresponds to error status reported by the ErrorCode property (see ErrorCode). It is a zero length string if there is no error.

Type

BSTR

Default

0

Related to

SCCVW_BAILOUT (Outside In Viewer)

ErrorShowMsg

If this is set to TRUE then the control will automatically display error messages as errors occur. Otherwise, the messages will not be shown.

Type

Short int (possible future extension)

Default

TRUE

Related to

SCCVW_BAILOUT (Outside In Viewer)

FallbackFormat

This property defines how the viewer displays unidentifiable documents. Valid values for this property are as follows:

Note:

This option is Global in scope.

Type

Int

Default

FI_ANSI

Related to

SCCID_FALLBACKFORMAT (Outside In Viewer)

FIFlags

This property is set to use flags related to File Identification behavior. It can be one of the following:

Note:

This option is Global in scope.

Type

Bool

Default

FALSE

Related to

SCCID_FIFLAGS (Outside In Viewer)

FileInfoDisplayName

Read only. String used when a human-readable form of the file name is needed. This string is either set specifically by the developer in the ViewFile method (see ViewFile) or is generated by the viewer based on the real name of the file. This property is updated whenever the FileChange event (see FileChange) occurs.

Type

BSTR

Default

Null

Related to

SCCVW_GETFILEINFO, SCCVW_SETDISPLAYNAME (Outside In Viewer)

FileInfoFileId

Read only. The ID number associated with this type of file. These values are listed in the header files.

Type

Short

Default

0

Related to

SCCVW_GETFILEINFO (Outside In Viewer)

FileInfoFileIdName

Read only. This is a string that is a description of the file ID number. For example, “WordPerfect 5.0.” See the header files for a listing of these strings.

Type

BSTR

Default

NULL

Related to

SCCVW_GETFILEINFO (Outside In Viewer)

FileInfoName

Read only. The full path to the actual file being viewed.

Type

BSTR

Default

Null

Related to

SCCVW_GETFILEINFO (Outside In Viewer)

FilterOptions

This property determines the behavior of certain filters. This property can contain one or more of the following values OR-ed together:

The following is a list of file types affected when OIX_ENABLELZW option is turned off:

Although this option can disable access to files in ZIP or EXE archives stored using LZW compression, any files in such archives that were stored using any other form of compression will still be accessible.

The following is a list of file types affected when OIX_ENABLEJPG option is turned off:

As of Release 8.4.0, only the PST and MDB Filters support the OIX_IGNOREPASSWORD option.

Note:

This option is Global in scope.

Type

LONG

Default

OIX_ENABLEJPG OIX_ENABLELZW

Related to

SCCID_IGNORE_PASSWORD, SCCID_FILTERJPG, SCCID_FILTERLZW, and SCCID_PDF_FILTER_REORDER_BIDI (Outside In Viewer)

FontScalingFactor

This property scales fonts in the view of a file by a percentage of the original size. The valid range of values is 50% to 300%.

Type

long

Default

100

Related to

SCCID_FONTSCALINGFACTOR (Outside In Viewer)

FormatFlags

This option determines the formatting options of data. It can be one of the following values:

Type

LONG

Default

0

Related to

SCCOPT_FORMATFLAGS (Outside In Viewer)

HScrollbar

This property controls the visibility of the horizontal scroll bar. TRUE means that the scrollbar is always visible, but may be disabled if unnecessary. A FALSE value makes the scrollbar invisible.

The Outside In Viewer does not have the ability to automatically show/hide scrollbars. This property takes the place of the ScrollFlags property because there are only two real values for each scrollbar.

Type

BOOL

Default

TRUE

Related to

SCCID_SCROLLFLAGS (Outside In Viewer)

HTMLCondCommentMode

Some HTML includes a special type of comment that will be read by particular versions of browsers or other products. This property allows you to control which of those comments are included in the output.

Data

Default

HTML_COND_COMMENT_NONE

Related to

SCCID_HTML_COND_COMMENT_MODE (Outside In Viewer)

HTMLDisplayMode

This property indicates how the word processor display engine displays the HTML file. It can be one of the following:

Type

Short

Default

SCCVW_WPMODE_WEBLAYOUT

Related to

SCCID_HTMLDISPLAYMODE (Outside In Viewer)

HTMLFitMode

Controls the size of HTML files when using preview or weblayout mode.

Data

One of the following values:

Default

SCCVW_FITMODE_ORIGINAL

ImgXZoomPercent

The percent used to stretch/shrink the horizontal size of the image. For instance, setting the percent to 200 will show 2 display pixels for every image pixel, that is, twice the horizontal size.

Type

Long

Default

100

Related to

SCCID_VECZOOM, SCCID_BMPZOOM (Outside In Viewer)

ImgYZoomPercent

The percent used to stretch/shrink the vertical size of the image. For instance, setting the percent to 200 will show 2 display pixels for every image pixel, that is, twice the vertical size.

Type

Long

Default

100

Related to

SCCID_VECZOOM, SCCID_BMPZOOM (Outside In Viewer)

IntlFlags

These flags relate to setting options for international support. If IntlFlags is set to TRUE, then print margins are displayed in inches; otherwise, print margins will be displayed in metric units.

Type

BOOL

Default

The default value is retrieved from the operating system.

Related to

SCCID_INTLFLAGS (Outside In Viewer)

Data

MaintainZoom

This option tells the Viewer to maintain its zoom and rotation settings when changing sections within a file. As each page of a presentation file is displayed as a new section, this allows a user to zoom to their desired level once, and keep that setting as they page through the presentation, rather than needing to re-zoom on each page.

Type

BOOL

Default

True

Related to

SCCID_MAINTAINZOOM (Outside In Viewer)

PageFormatHeight

Read only. This property is filled with the formatted page height in logical units after a call to DrawPage, GetDrawPageInfo, or DrawPageEx (see DrawPage GetDrawPageInfo, and DrawPageEx).

Type

LONG

Default

0

Related to

SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)

PageFormatWidth

Read only. This property is filled with the formatted page width in logical units after a call to DrawPage, GetDrawPageInfo, or DrawPageEx (see DrawPage GetDrawPageInfo, and DrawPageEx).

Type

LONG

Default

0

Related to

SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)

PagePaletteHandle

This property is filled with a palette handle after a call to DrawPage (see DrawPage).

Type

OLE_HANDLE

Default

none

Related to

SCCVW_DRAWPAGE (Outside In Viewer)

PagePicture

Type

LPPICTUREDISP

Default

none

Related to

SCCVW_DRAWPAGE (Outside In Viewer)

Description

This property is filled with the Picture object after a call to DrawPage (see DrawPage).

PageResultBottom

Read only. Bottom coordinate of rectangle in device units that was actually filled when a page was drawn into the output device context. This property is only set by a call to DrawPageEx (see DrawPageEx).

Type

LONG

Default

0

Related to

SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)

PageResultLeft

Read only. Left coordinate of rectangle in device units that was actually filled when a page was drawn into the output device context. This property is only set by a call to DrawPageEx (see DrawPageEx).

Type

LONG

Default

0

Related to

SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)

PageResultRight

Read only. Right coordinate of rectangle in device units that was actually filled when a page was drawn into the output device context. This property is only set by a call to DrawPageEx (see DrawPageEx).

Type

LONG

Default

0

Related to

SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)

PageResultTop

Read only. Top coordinate of rectangle in device units that was actually filled when a page was drawn into the output device context. This property is only set by a call to DrawPageEx (see DrawPageEx).

Type

LONG

Default

0

Related to

SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)

PageUnitsPerInch

Read only. This property is filled with the units per inch that PageFormatHeight and PageFormatWidth properties (see PageFormatHeight, and PageFormatWidth) represent after a call to DrawPage, GetDrawPageInfo, or DrawPageEx (see DrawPage, GetDrawPageInfo, and DrawPageEx).

Type

LONG

Default

0

Related to

SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)

ParseXMPMetadata

Adobe’s Extensible Metadata Platform (XMP) is a labeling technology that allows you to embed data about a file, known as metadata, into the file itself. This option determines if XMP data will be parsed into normal OIT document properties. Enabling this option may cause the loss of some regular data in premium graphics filters (such as Postscript), but won’t affect most formats (such as PDF).

One of the following values:

Type

BOOL

Default

FALSE

Related to

SCCID_PARSEXMPMETADATA (Outside In Viewer)

PDFInputMaxEmbeddedObjects

PDF files sometimes have a very large number of embedded objects. This option allows the user to limit the number of embedded objects that are produced in a PDF file. Setting this option to 0 means to produce an unlimited amount of embedded objects.

Type

ULONG

Default

0

Related to

SCCID_PDF_FILTER_MAX_EMBEDDED_OBJECTS (Outside In Viewer)

PDFInputMaxVectorPaths

PDF files sometimes have a very large number of vector paths. This option allows the user to limit the number of vector paths that are produced in a PDF file. Setting this option to 0 means to produce an unlimited amount of vector paths.

Type

ULONG

Default

0

Related to

SCCID_PDF_FILTER_MAX_VECTOR_PATHS (Outside In Viewer)

PDFWordSpacingFactor

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.

Type

float

Default

0.85

Related to

SCCID_PDF_FILTER_WORD_DELIM_FRACTION (Outside In Viewer)

PrintCollate

This property, if TRUE, cause multiple copies of a printout to be collated. If FALSE, multiple copies will be printed together.

Type

BOOL

Default

FALSE

Related to

SCCID_PRINTCOLLATE

PrintCopies

This property indicates the number of copies of the file, selection, or range to print.

Type

int

Default

1

Related to

SCCID_PRINTCOPIES (Outside In Viewer)

PrintEndPage

This property indicates the page printing should end on. It is only valid if the WhatToPrint property (see WhatToPrint) has the value SCCVW_PRINT_PAGERANGE. This value resets automatically when a new file is loaded.

Type

int

Default

1

Related to

SCCID_PRINTENDPAGE (Outside In Viewer)

PrinterDC

This property holds the handle of the printer device context that may be used with the PrintOI method (see PrintOI), if the developer chooses to control printing in this way.

Type

OLE_HANDLE

Default

NULL

Related to

SCCVW_PRINTEX (Outside In Viewer)

PrinterDriver

This property is used with the PrinterName and PrinterPort properties (see PrinterName, and PrinterPort) to optionally specify a printer in the PrintOI method (see PrintOI).

Type

BSTR

Default

NULL

Related to

SCCVW_PRINTEX (Outside In Viewer)

PrinterName

This property contains the name for a printer. This may be used in the PrintOI method (see PrintOI), if the developer chooses to control printing in this way.

Type

BSTR

Default

NULL

Related to

SCCVW_PRINTEX (Outside In Viewer)

PrinterPort

This property is used in conjunction with the PrinterName property (see PrinterName) to specify a printer in the PrintOI method (see PrintOI).

Type

BSTR

Default

NULL

Related to

SCCVW_PRINTEX (Outside In Viewer)

PrintFont

This property allows the developer to set the default print font. The developer may implement a font dialog or set this value directly. If the developer chooses to implement his own dialog, be advised that a default font will be used for any printer font selected from within the dialog.

Type

LPFONTDISP

Related to

SCCID_DEFAULTPRINTFONT (Outside In Viewer)

PrintJobName

This property is used to specify the text to be printed in the header on each page if printing of headers is enabled.

Type

BSTR

Default

Empty string

Related to

SCCID_PRINTJOBNAME (Outside In Viewer)

PrintMarginLeft/Right/Top/Bottom

These properties contain the print margins in centimeters (if IntlFlags is not set) or inches (if IntlFlags is set). If a value outside the range is assigned, the value will be clipped to the range.

Type

Float

Default

1 Inch (2.54 cm)

Range

0 to 4.23 Inches (0 to 10.76 cm)

Related to

SCCID_DEFAULTPRINTMARGINS (Outside In Viewer)

PrintStartPage

This property indicates the page on which printing should start. It is only valid if the WhatToPrint property (see WhatToPrint) has the value SCCVW_PRINT_PAGERANGE. This value resets automatically when a new file is loaded.

Type

int

Default

0

Related to

SCCID_PRINTSTARTPAGE (Outside In Viewer)

RawTextCharSet

Read only. This is a value that represents which character set the RawTextString (see RawTextString) is in. This should be the native character set for the platform or Unicode. Refer to the header files for character set values.

Type

Short

Default

0

Related to

SCCVW_GETRAWTEXT (Outside In Viewer)

RawTextLength

Read Only. This is a value that represents the size of the RawTextString (see RawTextString) buffer created when requested through GetRawText (see GetRawText).

Type

Long

**Default **

0

Related to

SCCVW_GETRAWTEXT (Outside In Viewer)

RawTextOffset

Read only. This is a value that represents the number of characters from the beginning of the document to the first character in the RawTextString (see RawTextString).

Type

Long

Default

0

Related to

SCCVW_GETRAWTEXT (Outside In Viewer)

RawTextString

Read only. This is the string that represents the raw text requested by GetRawText (see GetRawText).

Type

BSTR

Default

NULL

Related to

SCCVW_GETRAWTEXT (Outside In Viewer)

RenderEmbeddedFonts

This option allows you to disable the use of embedded fonts in PDF input files. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCOPT_RENDER_EMBEDDED_FONTS (Outside In Viewer)

ReorderMethod

This property indicates how the viewer reorders bidirectional text.

It can be one of the following values:

Type

Short

Default

SCCVW_REORDER_NONE

Related to

SCCID_REORDERMETHOD (Outside In Viewer)

ResourceLibraryID

This property allows multiple versions of the resource localization library to exist and to be changed programmatically. The default localization library name is SCCLO.DLL. To select a different library name, this property must be set to a string corresponding to characters added to this default name. For example, to choose the SCCLOXX.DLL file, ResourceLibraryID must be set to XX.

This addition is not limited to two characters, it may be 0 – 5 characters. If ResourceLibraryID is set to a zero-length string, it will revert to its default of LO.

Type

BSTR

Default

LO

Related to

SCCID_RESOURCELIBRARYID (Outside In Viewer)

SelectionAnchor

This property sets the anchor, or beginning, of the selection area. If the value for this property is invalid, it will not be set and will remain at its previous value. For more information, see Positions. This property is also populated with the start of user-selected text.

Type

OixPos

Default

none

Related to

SCCVW_SETSELECTION (Outside In Viewer)

SelectionEnd

This property sets the end position of the selection area. If the value for this property is invalid, it will not be set and will remain at its previous value. For more information, see Positions. This property is also populated with the ending position of user-selected text.

Type

OixPos

Default

none

Related to

SCCVW_SETSELECTION (Outside In Viewer)

SSClipBoard

Determines what format the database or spreadsheet takes when it is copied to the clipboard.

Type

Short

Default

SCCVW_CLIPSUBFORMAT_TABLE

Related to

SCCID_SSCLIPBOARD (Outside In Viewer)

SSDraftMode

Determines how much formatting information is included when displaying a database or spreadsheet.

Type

BOOL

Default

TRUE

Related to

SCCID_SSDRAFTMODE (Outside In Viewer)

SSPrintDirection

This option will determine the direction that the spreadsheet will be printed. This value resets when the view window is opened. The following values are valid:

Type

Long

Default

SCCVW_SSPRINTDIRECTION_ACROSS

Related to

SCCID_SSPRINTSCALEXWIDE (Outside In Viewer)

SSPrintFit

Determines how the database or spreadsheet printouts are fitted to the paper size and default print margins.

If the scaling is too much (one-fifth the original size) it is limited to that amount and will continue on additional pages. Aspect ratio is maintained. The following values are valid:

Type

Short

Default

SCCVW_SSPRINTFITMODE_NOMAP

Related to

SCCID_SSPRINTFITTOPAGE (Outside In Viewer)

SSPrintGridLines

Determines if a dotted line is printed between fields. The following values are valid:

Type

BOOL

Default

TRUE

Related to

SCCID_SSPRINTGRIDLINES (Outside In Viewer)

SSPrintHeadings

Determines if field headings will be printed along with the data. The following values are valid:

Type

BOOL

Default

TRUE

Related to

SCCID_SSPRINTHEADINGS (Outside In Viewer)

SSPrintScalePercent

This option will scale the spreadsheet pages by the percentage specified. Values of 30 to 300% are valid.

Type

Long

Default

100

Related to

SCCID_SSPRINTSCALEPERCENT (Outside In Viewer)

SSPrintScaleXHigh

This option will fit the printing to the number of vertical pages specified. This value resets when the view window is opened.

Type

Long

Default

1

Related to

SCCID_SSPRINTSCALEXHIGH (Outside In Viewer)

SSPrintScaleXWide

This option will fit the printing to the number of horizontal pages specified.

Type

Long

Default

1

Related to

SCCID_SSPRINTSCALEXWIDE (Outside In Viewer)

SSRowColNamesToClip

This property has been deprecated.

SSShowGridLines

Determines if a dotted line is displayed between fields. The following values are valid:

Type

BOOL

Default

TRUE

Related to

SCCID_SSSHOWGRIDLINES (Outside In Viewer)

SSShowHiddenCells

Determines whether hidden rows and columns will be shown when displaying a spreadsheet. This can be one of the following values:

**Type **

BOOL

**Default **

FALSE

Related to

SCCID_SSSHOWHIDDENCELLS (Outside In Viewer)

StatusEvents

This option determines if Status events are to be generated by the control, and if they are working.

Use of the Status Callback Function

An application’s status callback function will be called periodically by Outside In to provide a status message. Currently, the only status message defined is OIT_STATUS_WORKING, which provides a “sign of life” that can be used during unusually long processing operations to verify that Outside In has not stopped working. If the application decides that it would not like to continue processing the current document, it may use the return value from this function to tell Outside In to abort.

The status callback function has two return values defined:

The following is an example of a minimal status callback function.

VTDWORD MyStatusCallback( VTHANDLE hUnique, VTDWORD dwID, VTSYSVAL
pCallbackData, VTSYSVAL pAppData)
{
    if(dwID == OIT_STATUS_WORKING)
    {
        if( checkNeedToAbort( pAppData ) )
            return (OIT_STATUS_ABORT);
    }
  
    return (OIT_STATUS_CONTINUE);
}

Type

Bool

Default

False

Related to

VWSetStatCallback (Outside In Viewer)

StrokeTest

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. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCOPT_RENDER_EMBEDDED_FONTS (Outside In Viewer)

SysLotusNotesPath

This property 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.

Note:

This option is Global in scope.

Type

String

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.

Related to

SCCID_LOTUSNOTESPATH (Outside In Viewer)

SystemRawText

If set to TRUE then the developer will receive the RawTextEvent (see RawTextEvent) as new text becomes available.

Note:

This option is Global in scope.

Type

BOOL

Default

FALSE

Related to

SCCID_SYSTEMFLAGS (Outside In Viewer)

SystemReadAhead

If this property is set to FALSE, then the control’s process that reads through the rest of the file in the background is disabled. When the property is set to FALSE, the file will be read on demand as the user scrolls down through the document. This will cause unusual scroll bar behavior as the user scroll down.

Note:

This option is Global in scope.

Type

BOOL

Default

TRUE

Related to

SCCID_SYSTEMFLAGS (Outside In Viewer)

SystemTimer

If set to FALSE, then it disables the control’s internal timer that controls background reading, caret blinking and auto scroll. If this is set to TRUE, the developer must call the SystemIdle method (see SystemIdle) for the control to perform any background operations. It is recommended that this property be left set to its default of TRUE.

Note:

This option is Global in scope.

Type

BOOL

Default

TRUE

Related to

SCCID_SYSTEMFLAGS (Outside In Viewer)

SystemUnicode

If this property is set to TRUE, then Unicode will be enabled. This affects the methods GetRawText, Search, and Get AnnotationData (see GetRawText, Search, and GetAnnotationData).

Note:

This option is Global in scope.

Type

long

Default

FALSE

Related to

SCCID_SYSTEMFLAGS (Outside In Viewer)

TimeZoneOffset

This property controls the offset to GMT that is applied during date formatting, allowing date values to be displayed in a selectable time zone. The option defaults to the current GMT time display. A flag tells the technology to query the OS and use the OS’s defined timezone.

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.

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.

Scope

Global

Type

Short - Integer Parameter from -96 to 96, representing 15 minute offsets from GMT, or SCC_TIMEZONE_USENATIVE, which will query the OS for the timezone set on the machine

Default

0 : GMT Time

Related to

SCCID_TIMEZONE (Outside In Viewer)

ToClipboard

This property controls the format that the viewer copies to the clipboard when the CopyToClip method (see CopyToClip) is called. This property can contain one or more of the following values OR-ed together:

Type

ULONG

Default

SCCVW_CLIPFORMAT_WINMETAFILE

Related to

SCCID_TOCLIPBOARD (Outside In Viewer)

UnmappableChar

This property defines what replacement character to use when the viewer cannot find the character to be displayed in any font on the system.

This value is the Unicode value for the replacement character.

Type

Short

Default

0x002a - ‘*’

Related to

SCCID_UNMAPPABLECHAR (Outside In Viewer)

UseDocPageSettings

Used to select the document’s page layout information when printing.

Type

BOOL

Default

TRUE

Related to

SCCID_USEDOCPAGESETTINGS (Outside In Viewer)

Data

VecFitMode

Determines how the display engine (vector or bitmap) displays (stretches/shrinks) an image in relation to the size of the view window. One of the following values:

Invalid values will be reset to the last set value.

Type

Short

Default

SCCVW_FITMODE_ORIGINAL

Related to

SCCID_VECFITMODE (Outside In Viewer)

VecPrintAspect

The option indicates how the image will be stretched when printed. It can be one of the following values:

Invalid values will be reset to the last set value.

Type

Short

Default

SCCVW_PRINTASPECT_SCALE (previously referred as SCCVW_PRINTASPECT_ORIGINAL)

Related to

SCCID_VECPRINTASPECT (Outside In Viewer)

VecPrintBackground

If this property is set to TRUE, then the background of the vector image will be printed. If it is set to FALSE, then the background will not be printed.

Type

BOOL

Default

TRUE

Related to

SCCID_VECPRINTBACKGROUND (Outside In Viewer)

VecPrintBorder

Determines if a one-pixel border is to be printed around images. One of the following values:

Type

BOOL

Default

TRUE

Related to

SCCID_VECPRINTBORDER (Outside In Viewer)

VecShowBackground

If TRUE, the background of a vector image as defined in the file will be displayed. If it is FALSE, the background will not be displayed.

Type

BOOL

Default

TRUE

Related to

SCCID_VECSHOWBACKGROUND (Outside In Viewer)

VScrollbar

This property controls the visibility of the vertical scroll bar. TRUE means that the scrollbar is always visible, but may be disabled if unnecessary. A FALSE value makes the scrollbar invisible.

The Outside In Viewer does not have the ability to automatically show/hide scrollbars. This property takes the place of the ScrollFlags property because there are only two real values for each scrollbar.

Type

BOOL

Default

TRUE

Related to

SCCID_SCROLLFLAGS (Outside In Viewer)

WhatToPrint

This option indicates how much of a file should be printed when the PrintOI method (see PrintOI) is called. It can be one of the following values. This value resets automatically when a new file is loaded.

Type

ULONG

Default

0

Related to

SCCID_WHATTOPRINT (Outside In Viewer)

Data

WPDisplayMode

This property indicates how the word processor display engine displays the document. This does not apply to Email and HTML files. It can be one of the following:

Type

Short

Default

SCCVW_WPMODE_PREVIEW

Related to

SCCID_WPDISPLAYMODE (Outside In Viewer)

WPEmailHeaderOutputMode

This property controls viewing and printing of email headers.

Note:

The property WPMimeHeaderOutput has been deprecated, and this takes its place.

Note:

This option is Global in scope.

Data

One of these values:

Type

Long

Default

SCCUT_WP_EMAILHEADERSTANDARD

Related to

SCCID_WPEMAILHEADEROUTPUT (Outside In Viewer)

WPFitMode

This property controls the size of word processor pages when using the preview mode. One of the following values:

Type

Short

Default

SCCVW_FITMODE_ORIGINAL

Related to

SCCID_WPFITMODE (Outside In Viewer)

WPWrapToWindow

This property indicates how the word processing display engine wraps text in the window in Normal and Draft modes. Text always wraps to the page size in preview mode. If the option is TRUE (default) the text will wrap to fit the window. If the option is FALSE, text will not wrap and the horizontal scroll bar will be available for scrolling to the unwrapped text.

Type

BOOL

Default

TRUE

Related to

SCCID_WRAPTOWINDOW (Outside In Viewer)

Methods

The following methods are used in the SDK.

AddAnnotationHideText

This method allows the developer to remove a section of text from the viewed document.

Usage

Void AddAnnotationHideText (long lId, VARIANT varData, OixPos StartPos, OixPos EndPos)

Returns

Void

Parameters

Related to

SCCVW_ADDANNOTATION (Outside In Viewer)

AddAnnotationHilite

This method allows the developer to add hilited text to the viewed document.

Usage

Void AddAnnotationHilite( long lId, short istyle, short iEvent, short iBackground, short iForeground, VARIANT varData, OixPos StartPos, OixPos EndPos)

Returns

Void

Parameters

Related to

SCCVW_ADDANNOTATION. (Outside In Viewer)

AddAnnotationInsertText

This method allows the developer to insert text in the viewed document. It is only valid when viewing word processing, spreadsheet, database or metafile documents.

Usage

Void AddAnnotationInsertText( long lId, VARIANT varData, OixPos InsertPosition, VARIANT varInsertText)

Returns

Void

Parameters

Related to

SCCVW_ADDANNOTATION (Outside In Viewer)

AddAnnotationPicture

This method allows the developer to insert a bitmap or icon in the viewed document.

Usage

Void AddAnnotationPicture( long lId, LPPICTUREDISP pdPicture, short iEvent, VARIANT varData, OixPos Pos)

Returns

Void

Parameters

Related to

SCCVW_ADDANNOTATION (Outside In Viewer)

AnnotationSetPos

This method sets the caret to the position of the last annotation added or found. Optionally, it can select the text the annotation hilites or hides. This method is more accurate than using the Start and End positions to set the location. If there isn’t a current annotation Start and End position, then nothing happens.

Usage

Void AnnotationSetPos( bool bSelect )

Returns

Void

Parameters

Related to

SCCVW_DISPLAYPOSITION (Outside In Viewer)

ArchiveSave

Initiates a save when dealing with an archive document.

Usage

Void ArchiveSave(short nSaveType)

Returns

Void

Parameters

nSaveType can be one of the following values:

Related to

SCCID_ARCSAVEEVENT (Outside In Viewer)

Clear

Use this method to close the currently viewed file and reset the control window to its non-viewing state.

Usage

void Clear()

Related to

SCCVW_CLOSEFILE (Outside In Viewer)

ClearAnnotations

This message allows the developer to selectively remove annotations.

Usage

Void ClearAnnotations( short iMask, long lRemoveId )

Returns

Void

Parameters

Related to

SCCVW_CLEARANNOTATIONS (Outside In Viewer)

ClipboardOptions

Displays a dialog that lets the user set a number of aspects of how files are copied to the clipboard.

Usage

Short ClipboardOptions()

Returns

Parameters

none

Related to

SCCVW_DODIALOG (Outside In Viewer)

ComparePositions

This method allows the developer to compare two Position objects. The return value is -1 if PositionA is less than the PositionB, 0 if the two positions are equal, and 1 if PositionA is more than PositionB.

Usage

Short ComparePositions(OixPos PositionA, OixPos PositionB)

Returns

Parameters

Related to

SCCVW_COMPPOSITIONS (Outside In Viewer)

Copy

This method allows the developer to copy the area defined by the two position indices into memory in a given format. The return value is TRUE if the method is successful, otherwise the value is FALSE.

Usage

Void Copy(long lFormatId, OixPos StartPos, OixPos EndPos)

Returns

Void

Parameters

Related to

SCCVW_COPY (Outside In Viewer)

CopyPosition

Use this method to set the value of one position to the value of another position.

Usage

Void CopyPosition(OixPos DestPos, OixPos SourcePos)

Returns

Void

Parameter

CopyToClip

This method cause the viewer to copy the current selection (if any) to the clipboard.

Usage

Void CopyToClip()

Returns

Void

Parameters

none

Related to

SCCVW_COPYTOCLIP (Outside In Viewer)

DeinitDrawPage

This function cleans up the memory allocated by InitDrawPage (see InitDrawPage). After calling DeinitDrawPage, InitDrawPage must be called again before DrawPage or GetDrawPageInfo can be called (see DeinitDrawPage, InitDrawPage, DrawPage, and GetDrawPageInfo).

Usage

Void DeinitDrawPage()

Returns

Void

Related to

SCCVW_DEINITDRAWPAGE (Outside In Viewer)

DisplayOptions

Displays a dialog that lets the user set a number of aspects of how files are viewed.

Usage

BOOL DisplayOptions()

Returns

Related to

SCCVW_DODIALOG (Outside In Viewer)

DisplayPosition

This method allows the developer to bring any Position into view and provides some control over the placement of the position object in the view.

Usage

Void DisplayPosition(OixPos Position, short iDisplayOptions)

Returns

Void

Parameters

Related to:

SCCVW_DISPLAYPOSITION (Outside In Viewer)

DrawPage

This method will draw a specified page and return that page as a Picture Object in the PagePicture property (see PagePicture). If the sizing information is not provided, appropriate defaults will be used in conjunction with SCCVW_GETDRAWPAGEINFO to create the image. The InitDrawPage method (see InitDrawPage) must be called before attempting DrawPage invocation (see DrawPage).

Usage

BOOL DrawPage (long lPageNumber, long lTop, long lLeft, long lBottom, long lRight, long lFormatWidth, long lFormatHeight, short iUnitsPerInch)

Returns

Boolean indicating success.

Parameters

Related to

SCCVW_DRAWPAGE (Outside In Viewer)

DrawPageEx

This method draws a page of the currently viewed file to a rectangle and device of the developer’s choice. The rectangle that is actually filled with by the rendered output is placed in the properties PageResultTop, PageResultLeft, PageResultBottom, PageResultRight (see PageResultTop, PageResultLeft, PageResultBottom, and PageResultRight).

Usage

BOOL DrawPageEx(long lPageNumber, long lFlags, long lTop, long lLeft, long lBottom, long lRight, long lFormatHeight, long lFormatWidth, short iUnitsPerInch, OLE_HANDLE hOutputDC, OLE_HANDLE hFormatDC, OLE_HANDLE hPalette)

Returns

Parameters

Related to

SCCVW_DRAWPAGE (Outside In Viewer)

ExtDrawPage

This method will draw a specified page and return that page as a Picture Object in the PagePicture property. If the sizing information is not provided, appropriate defaults will be used in conjunction with SCCVW_GETDRAWPAGEINFO to create the image. The InitDrawPage method must be called before attempting DrawPage invocation.

Usage

BOOL ExtDrawPage (long lPageNumber, long lTop, long lLeft, long lBottom, long lRight, long lFormatWidth, long lFormatHeight, short iUnitsPerInch, short sFormatID)

Returns

Boolean indicating success.

Parameters

Related to

SCCVW_DRAWPAGE (Outside In Viewer)

FindAnnotation

This method allows the developer to find an annotation and retrieve information associated with the annotation. If no matching annotations are found, then the method returns FALSE, else the method returns TRUE. The information for the found annotation can be retrieved from the various Annotation properties.

Usage

bool FindAnnotation( short iFindType, short iMask, long lFindId, OixPos SearchPos )

Returns

Boolean indicating success.

Parameters

Related to

SCCVW_FINDANNOTATION (Outside In Viewer)

FindPosition

Use this method to set a Position relative to another position. Many of the methods of finding the position are only supported for word processing file types.

Usage

Void FindPosition(OixPos StartPos, OixPos DestPos, short iFindMethod)

Returns

Boolean indicating success.

Parameters

Related to

SCCVW_FINDPOSITION (Outside In Viewer)

GetActualCount

This method will return the actual character count when passed a position object.

Usage

long GetActualCount(OixPos Position)

Returns

Long

Parameters

Related to

SCCVW_MAPPOSITION (Outside In Viewer)

GetAnnotationData

This method provides the developer a way to retrieve extended data associated with annotations that are internally created by the viewer technology. The technology currently creates annotations to support hyperlinks and bookmarks defined in the original file. The data for the annotation is returned in the various Annotation properties. If the annotation is not found, the method returns FALSE. If the annotation is found the method returns TRUE.

Usage

BOOL GetAnnotationData(long lId, short iAnnotationType)

Returns

Boolean indicating found

Parameters

Related to

SCCVW_GETANNOTATIONDATA (Outside In Viewer)

GetCustomEMailHeader

This method will allow the developer to query the custom email headers that are visible or hidden. This information is only used when WPEmailHeaderOutput is set to SCCUT_WP_EMAILHEADERCUSTOM.

Usage

BOOL GetCustomEMailHeader (BOOL bVisible, LONG lHeaderID, long *lSubType, BSTR *strMimeHeaderName, BSTR *strMimeHeaderLabel)

Returns

TRUE: Indicates success

FALSE: Could not retrieve the information

Parameters

Note:

Support for user-defined MIME headers is intended to allow Outside In to selectively display MIME headers that are not included in the predefined set of email headers known to Outside In. It is likely that most developers using Outside In will not need to specify user-defined MIME headers. Knowledge of the particular MIME headers present in the input email files is necessary in order to take advantage of this capability.

Related to

SCCID_MAILHEADERVISIBILE and SCCID_MAILHEADERHIDDEN (Outside In Viewer)

GetDrawPageInfo

This method will get page information about the requested page. It is to be used within calls to the InitDrawPage and DeinitDrawPage methods to get the best page size information before a call is made to DrawPageEx. This returns the calculated FormatWidth and FormatHeight in the PageFormatWidth and PageFormatHeight properties. If the information is not retrieved the method returns FAL

Usage

BOOL GetDrawPageInfo (LONG lPageNumber, SHORT iUnitsPerInch, OLE_HANDLE hOutputDC, OLE_HANDLE hFormatDC)

Returns

Parameters

Related to

SCCVW_GETDRAWPAGEINFO (Outside In Viewer)

GetPageCount

This method counts the number of pages in the currently viewed file, as paginated to fit a rectangle and device of the OEM’s choice. As this requires that the view window wrap every page in the document, this message can take some time to complete when processing extremely large documents.

Usage

BOOL GetPageCount (LONG lTop, LONG lLeft, LONG lBottom, LONG lRight,
                                     LONG lFormatWidth, LONG lFormatHeight,
                                     SHORT iUnitsPerInch, OLE_HANDLE hFormatDC,
                                     LONG *lNumPages)

Returns

Parameters

GetProperty

This method retrieves any property information generated by the import filter. If a property is available, this function returns FALSE, otherwise it returns TRUE.

Usage

BOOL GetProperty(long lPropMode, BSTR *pPropName, BSTR *pPropData, long lPropId)

Returns

Boolean indicating success

Parameters

Related to

SCCID_GETPROPERTY(Outside In Viewer)

GetRawText

This method allows the developer to get the raw text buffer that contains the character identified by its actual character count from the beginning of the document. The RawText properties will be updated with the requested text block. Returns TRUE if the raw text block was found, otherwise returns FALSE.

Usage

BOOL GetRawText(long lTextOffset)

Returns

Boolean indicating found

Parameters

Related to

SCCVW_GETRAWTEXT (Outside In Viewer)

GoToAnnotation

This method allows the developer to move the view/selection from annotation to annotation. If no matching annotations are found, then the method returns FALSE, otherwise the method returns TRUE.

Usage

BOOL GoToAnnotation( short iFindType, short iMask, long lFindId )

Return

Boolean indicating success.

Parameters

Related to

SCCVW_GOTOANNOTATION (Outside In Viewer)

HiliteStyle

This method allows the developer a unique StyleId that indicates a custom hiliting style. The method returns TRUE if the style cannot be set. FALSE is returned if the method is successful.

Usage

BOOL HiliteStyle( long lStyleid, long lOptions, OLE_COLOR dwForeColor, OLE_COLOR dwBackColor, short iCharAttr )

Returns

Boolean indicating success

Parameters

Related to

SCCVW_HILITESTYLE (Outside In Viewer)

HScroll

This method is used by the developer to cause horizontal scrolling. dwScrollOp directs the control to scroll one line left or right, one page left or right, or to a specific position. If this parameter specifies that the view should scroll to a specific position, lPosition specifies that position, which must be within the scroll range.

Usage

LONG HScroll( ULONG dwScrollOp, LONG lPosition )

Returns

Parameters

Related to

SCCVW_HSCROLL (Outside In Viewer)

IdleBitmap

This method may be called to set the bitmap for display when the view window is idle (no document loaded).

Usage

Void IdleBitmap(HINSTANCE hModule, UINT ResID);

Returns

Void

Parameters

Related to

SCCVW_SETIDLEBITMAP (Outside In Viewer)

ImgShowFullScreen

If the show parameter is TRUE, then the image will be displayed using the entire screen until either the method is called again with a parameter of FALSE, or the user presses a key.

Usage

Void ImageShowFullScreen (BOOL bShow)

Returns

Void

Parameters

Related to

SCCID_VECSHOWFULLSCREEN, SCCID_BMPSHOWFULLSCREEN (Outside In Viewer)

ImgZoom

This method is used to zoom the image.

Usage

Void ImgZoom (short iZoomType)

Returns

Void

Parameters

Related to

SCCID_VECZOOMEVENT, SCCID_BMPZOOMEVENT (Outside In Viewer)

InitDrawPage

This function prepares the control to execute the DrawPage or GetDrawPageInfo methods. If these methods are called without calling InitDrawPage, they will fail. If the method is able to allocate the necessary memory to call DrawPage or GetDrawPageInfo, then it returns TRUE. Otherwise, it will return FALSE and an error will be fired.

Usage

BOOL InitDrawPage()

Returns

Related to

SCCVW_INITDRAWPAGE (Outside In Viewer)

PrintOI

This method causes the viewer to print the file currently being viewed. The developer may want direct control of some of the printing process. PrintOI uses the values of some of the printer properties to control the printing process. Originally, these properties have values corresponding to the default behavior of the printing process. These properties include:

Usage

Void PrintOI ( BOOL bDoSetupDialog, ULONG dwFlags, BOOL bDoAbortDialog, BOOL bStartDocAlreadyDone)

Returns

Void

Parameters

Related to

SCCVW_PRINTEX (Outside In Viewer)

PrintOptions

This method displays a dialog that lets the user set a number of aspects for printing files.

Usage

short PrintOptions()

Returns

OIX_DIALOG_OK: Dialog successful

OIX_DIALOG_CANCEL: Dialog canceled by user

Parameters

none

Related to

SCCVW_DODIALOG (Outside In Viewer)

Figure: Figure A-1 Print Options Dialogs Description of image follows

PrintSetup

This method brings up the Print Setup Common Dialog from which the user may select printers and change their settings.

Usage

Void PrintSetup()

Returns

Void

Parameters

none

Related to

SCCVW_PRINTSETUP (Outside In Viewer)

Search

Use this method to search for text inside the currently viewed document. The search can be performed either with or without a dialog box. The function will return 0 if the search string was found, -1 if an error occurred, or 1 if the search reached either end of the file before finding the search string.

Usage

Short Search(BOOL bDialog, String szSearchText, short iSearchType, short iSearchFrom, short iSearchDirection)

Returns

Parameters

Related to

SCCVW_SEARCH, SCCVW_SEARCHDIALOG (Outside In Viewer)

SearchNext

Use this method to scan the file for the same text string specified in a previous call to the Search method. The function will return 0 if the search string was found, -1 if an error occurred, or 1 if the search reached either end of the file before finding the search string.

Usage

Short SearchNext(short iSearchDirection)

Returns

Parameters

Related to

SCCVW_SEARCHNEXT (Outside In Viewer)

SelectAll

This method causes the view window to select all contained data.

Usage

Void SelectAll()

Returns

Void

Parameters

none

Related to

SCCVW_SELECTALL (Outside In Viewer)

SetActualCount

This method will set the position object to a location count characters from the beginning of the document.

Usage

Void SetActualCount(OixPos Position, long Count)

Returns

Void

Parameters

Related to

SCCVW_MAPPOSITION (Outside In Viewer)

SetCustomEmailHeader

This method will allow the developer fine-grained control over what email headers are rendered. This information is only used when WPEmailHeaderOutput is set to SCCUT_WP_EMAILHEADERCUSTOM.

Usage

BOOL SetCustomEMailHeader (BOOL bVisible, LONG lHeaderID, long lSubType, BSTR strMimeHeaderName, BSTR strMimeHeaderLabel)

Returns

TRUE: Indicates success

FALSE: Could not set custom header.

Parameters

Note:

Support for user-defined MIME headers is intended to allow Outside In to selectively display MIME headers that are not included in the predefined set of email headers known to Outside In. It is likely that most developers using Outside In will not need to specify user-defined MIME headers. Knowledge of the particular MIME headers present in the input email files is necessary in order to take advantage of this capability.

Related to

SCCID_MAILHEADERVISIBILE and SCCID_MAILHEADERHIDDEN (Outside In Viewer)

SetPositionToCurrent

This method allows the developer to set a position object to the location of the caret in the currently viewed document.

Usage

Void SetPositionToCurrent(OixPos Position)

Returns

Void

Parameters

SetPositionToSelection

This method allows the developer to set two position objects based on the currently selected text.

Usage

Void SetPositionToSelection(OixPos StartPos, OixPos EndPos)

Returns

Void

Parameters

Related to

SCCVW_DISPLAYPOSITION (Outside In Viewer)

SystemIdle

This method should be called repeatedly by the developer to the control during the viewing process. This message allows the control to blink the cursor and read ahead in the file being viewed. This message is only needed if the SystemTimer property (see SystemTimer) has been set to FALSE.

Usage

SystemIdle()

Related to

SCCVW_IDLE (Outside In Viewer)

ViewFile

Call this method to open and display the contents of a file. If another file is already open, it will be closed automatically.

Usage

BOOL ViewFile(BOOL bDialog, VARIANT FileSpec, SHORT iSpecType, SHORT iViewAs, BOOL bUseDisplayName, BSTR szDisplayName, BOOL bDeleteOnClose, Ioixredirect *pIoRedir)

Returns

Parameters

Related to

SCCVW_VIEWFILE (Outside In Viewer)

VScroll

This method is used by the developer to cause vertical scrolling. It has two parameters. dwScrollOp directs the control to scroll one line up or down, one page up or down, or to a specific position. If this parameter specifies that the view should scroll to a specific position, lPosition specifies that position, which must be within the scroll range.

Usage

LONG VScroll( ULONG dwScrollOp, LONG lPosition )

Returns

Parameters

Related to

SCCVW_VSCROLL (Outside In Viewer)

Events

The following events occur during actions.

AnnotationEvent

This event informs the developer that some user action has been taken on an annotation.

Usage

Void AnnotationEvent(long lEvent, long lId, VARIANT varData)

Returns

Void

Parameters

Related to

SCCVW_ANNOTATIONEVENT (Outside In Viewer)

Close

The developer needs to respond to this event by closing the file identified by the varFile parameter and cleaning up all memory associated with it. The pResult parameter should be set to IOERR_OK if the operation is successful, and IOERR_UNKNOWN if the operation is not.

Usage

Close( VARIANT FileSpec, VARIANT varData, VARIANT varFile, long *pResult)

Parameters

ContextMenu

This event signals the container application in the event that a right-mouse click has occurred inside the view. The developer may decide to handle this interaction, or let Outside In pop up its own context menu. See the DoContextMenu property (see DoContextMenu) for information on disabling the built-in context menu.

Usage

ContextMenu ( int iXPos, int iYPos )

Parameters

Related to

SCCVW_CONTEXTMENU (Outside In Viewer)

DisplayEngineChange

This event is generated whenever the display engine changes. The new information for the display engine will be updated in the DisplayEngine properties at the same time.

Usage

DisplayEngineChange()

Related to

SCCVW_DISPLAYCHANGE (Outside In Viewer)

DoHelp

This event is generated whenever a help button has been pressed in one of the control’s dialogs.

Usage

DoHelp(SHORT iDialog)

Parameters

Related to

SCCVW_DOHELP (Outside In Viewer)

EnableApp

This event is generated whenever the developer application should be disabled/enabled. This message is sent before and after dialogs and printing. It allows the developer to disable any part of the application that could affect the view window.

Usage

EnableApp(BOOL bEnable, short *iReturn)

Parameters

Related to

SCCVW_ENABLEAPP (Outside In Viewer)

Error

This event is generated when an error condition has occurred either in the control or the Outside In Viewer. The ErrorCode and ErrorMsg properties (see ErrorCode, and ErrorMsg) will be filled with the appropriate values. This event is generated regardless of the state of ErrorShowMsg (see ErrorShowMsg).

Usage

Error()

Related to

SCCVW_BAILOUT (Outside In Viewer)

FileChange

This event is generated when the file being viewed is changed, such as with a ViewFile or Clear method (see ViewFile, and Clear). The FileInfo properties will be updated at the same time.

Usage

FileChange (BOOL bOpen, BOOL bOpenFollowing)

Parameters

Related to

SCCVW_FILECHANGE (Outside In Viewer)

GenSecond

If a secondary file needs to be opened (for example, a .gif graphic in an HTML file), then the control will fire this event. The developer needs to assign the pFileSpec parameter the same file specification as for the FileSpec parameter of the ViewFile method (see ViewFile). The SpecType parameter also corresponds to the iSpecType parameter of the ViewFile method. If the developer wants to use IO redirect for the secondary file, then the SpecType must be IOTYPE_REDIRECT, just as with the ViewFile method. Finally, the pvarData parameter is the same as the Redirect parameter for the ViewFile method. Should everything be filled out OK, then the developer should return IOERR_OK in the pResult parameter. If the secondary file cannot be processed, then the developer should return IOERR_UNKNOWN.

Usage

GenSecond(VARIANT FileSpec, VARIANT varData, VARIANT varFile, BSTR FileName, VARIANT *pFileSpec, long *SpecType, VARIANT *pvarData, long *pResult)

Parameters

GetCredentials

The developer responds to this event by returning the requested information in the buffer provided. If the requested information is not available, the value SCCERR_CANCEL should be assigned to pResult. If redirected I/O is being used, this event requires that IOGETINFO_PATHNAME and IOGETINFO_PATHTYPE be handled. The information that is provided in response to these calls is what is passed back through the pSpec and dwSpecType in the FileAccess callback. Note that the pSpec that is being passed back is not the one that was given to the technology originally.

Usage

GetCredentials(BSTR Filename, long lRequestID, long lAttemptNumber, long lMaxLength, VARIANT *pStrCredentials, long *pResult)

Parameters

Note:

Not all formats that use passwords are supported. Only Microsoft Office binary (97-2003), Microsoft Office 2007, Microsoft Outlook PST 97-2013, Lotus NSF, PDF (with RC4 & AES 128-bit encryption), and Zip (with AES 128- & 256-bit, ZipCrypto) are currently supported.

GetInfo

Usage

GetInfo(VARIANT FileSpec, VARIANT varData, VARIANT varFile, long InfoId, VARIANT *pInfo, long *pResult)

Parameters

GetTechPath

The developer can respond to this event if a technology path other than the one referenced in the registry’s FilterPath entry is to be used. If the registry entry is to be used, SCCERR_CANCEL should be assigned to pResult.

Note:

GetTechPath does not work with VB6 applications.

Usage

GetTechPath(VARIANT *pStrTechPath, long * pResult)

Parameters

HScrollPageSize

This event is generated when the page (thumb) size of the horizontal scroll bar changes. This allows the developer to establish correct thumb sizes of scroll bars external to the view window.

Usage

HScrollPageSize( int iPageSize )

Parameters

Related

SCCVW_SETHSCROLLPAGESIZE (Outside In Viewer)

HScrollPosition

This event is generated when the position of the horizontal scroll bar changes. This allows the developer to establish correct positioning of scroll bars external to the view window.

Usage

HScrollPosition( LONG lPosition )

Parameters

Related to

SCCVW_SETHSCROLLPOSITION (Outside In Viewer)

HScrollRange

This event is generated when the range of the horizontal scroll bar changes. It allows the developer to establish correct scroll ranges external to the view window.

Usage

HScrollRange(int iMin int iMax )

Parameters

Related to

SCCVW_SETHSCROLLRANGE (Outside In Viewer)

HScrollState

This event is generated when the state of the horizontal scroll bar changes. It allows the developer to establish the correct state of scroll bars external to the view window.

Usage

HScrollState( BOOL bEnabled )

Parameters

Related to

SCCVW_SETHSCROLLSTATE (Outside In Viewer)

InformationMessage

This event is generated during processing of the document. Each message indicates that the Viewer has identified a situation that it knows it is unable to correctly render. As re-rendering a page may cause the view window to reprocess the cause of a message, these messages should not be considered unique instances of a problem.

Usage

void InformationMessage(long lStatus)

Parameters

lStatus: Value indicating the type of problem that has been encountered. One of the following values:

Keydown

This event is generated whenever a key is pressed while the view window has focus. This allows developers to define their own handlers for specific keys.

Usage

Keydown ( int iVKey )

Parameters

Related to

SCCVW_KEYDOWN (Outside In Viewer)

Open

This event is generated after the developer calls ViewFile (or responds to a GenSecond event). The developer needs to respond by opening the requested file and placing a meaningful value into the pvarFile variant. The developer needs to set the pResult parameter to IOERR_OK if the open operation is successful, or IOERR_UNKNOWN if the open operation fails.

Usage

ViewThisFile(VARIANT FileSpec, VARIANT varData, VARIANT *pvarFile, long *pResult)

Parameters

OptionChange

This event is generated whenever an option has been changed. It can be used to monitor the current state of options.

Usage

OptionChange (short iOptionId)

Parameters

Related to

SCCVW_OPTIONCHANGE (Outside In Viewer)

PrinterAbort

When the USEABORTPROC flag is set in the PrintOI method (see PrintOI), this event is generated periodically during the printing process. This allows the developer to handle the abort procedure.

Usage

PrinterAbort(HDC hDC, int iError, bool *bContinue )

Parameters

Related to

SCCVW_PRINTEX (Outside In Viewer)

RawTextEvent

This event is generated repeatedly during the initial read of a document. Each event passes the 0 based offset of the next block of raw text available from the control. The last RawTextEvent (see RawTextEvent) contains a text offset of ‐1 to indicate it is done extracting text from the file. Use the GetRawText method (see GetRawText) to retrieve the text buffer.

Usage

Void RawTextEvent(long lTextOffset)

Parameters

Related to

SCCVW_RAWTEXTEVENT (Outside In Viewer)

Read

The developer responds to this event by reading in the requested amount of data from the current file position. After reading the requested data, the file pointer should be set to the byte after the last byte read. The data read should be returned to the control by assigning a SAFEARRAY of bytes to the pData variant. The actual count of bytes read should be assigned to the pCount parameter. If all or some of the data can be read, then IOERR_OK should be assigned to pResult. If the read failed because the file pointer was beyond the end of the file at the time of the read, then IOERR_EOF should be assigned to pResult. If the read failed for some reason other than being beyond the end of the file, then the value IOERR_UNKNOWN should be assigned to pResult.

Usage

Read(VARIANT FileSpec, VARIANT varData, VARIANT varFile, VARIANT *pData, long Size, long *pCount, long *pResult)

Parameters

ReadAheadDone

Signals that the chunker is done reading the document. This means that the Outside In Viewer has completely read to the end of the document. This doesn’t mean that rendering is done. It may also be necessary for the Outside In Viewer to access the file again while the user scrolls through the document.

Usage

ReadAheadDone()

Seek

The developer responds to this event by moving the file pointer. If the seek is successful, then the value IOERR_OK should be assigned to pResult. If the seek is not successful, then the value IOERR_UNKNOWN should be assigned to pResult.

Usage

Seek(VARIANT FileSpec, VARIANT varData, VARIANT varFile, short From, long Offset, long *pResult)

Parameters

SelChange

This event is generated when the selection state of the contents of the view window has changed.

Usage

SelChange()

Parameters

None

Related to

SCCVW_SELCHANGE (Outside In Viewer)

Stat

This event is generated repeatedly during the read of a document. This event is periodically generated to verify that the file is still being processed. Use this with a monitoring process to help identify files that may be hung.

Usage

Void Stat(long *pResult)

Parameters

pResult - Set this variable to OIT_STATUS_WORKING to indicate continuation, or to OIT_STATUS_ABORT to interrupt viewing of the file.

Related to

VWSetStatCallback (Outside In Viewer)

Tell

The developer should respond to this event by assigning the current file position to the pOffset parameter. If successful, the developer should also assign the value IOERR_OK to the pResult parameter. If not successful, the developer should assign the value IOERR_UNKNOWN to pResult.

Usage

Tell(VARIANT FileSpec, VARIANT varData, VARIANT varFile, long *pOffset, long *pResult)

Parameters

ViewThisFile

This event is generated when another file should be viewed. Currently, this occurs when the user double-clicks or hits return on a file entry in an Archive view and on a hyperlink to a referenced document. The developer must return a value indicating whether the file is to be viewed or not.

Do not use the ViewFile method (see ViewFile) with the same view window when handling the ViewThisFile event (see ViewThisFile).

Usage

ViewThisFile(VARIANT FileSpec, SHORT iSpecType, SHORT *iReturn)

Parameters

Related to

SCCVW_VIEWTHISFILE (Outside In Viewer)

VScrollPageSize

This event is generated when the page (thumb) size of the vertical scroll bar changes. This allows the developer to establish correct thumb sizes of scroll bars external to the view window.

Usage

VScrollPageSize( int iPageSize )

Parameters

Related to

SCCVW_SETVSCROLLPAGESIZE (Outside In Viewer)

VScrollPosition

This event is generated when the position of the vertical scroll bar changes. This allows the developer to establish correct positioning of scroll bars external to the view window.

Usage

VScrollPosition( LONG lPosition )

Parameters

Related to

SCCVW_SETVSCROLLPOSITION (Outside In Viewer)

VScrollRange

Obsolete - replaced by VScrollRangeMin and VScrollRangeMax.

VScrollRangeMin

Usage

VScrollRangeMin(long lRangeMin)

Parameters

Related to

SCCVW_SETVSCROLLRANGEMIN (Outside In Viewer)

VScrollRangeMax

Usage

VScrollRangeMax(long lRangeMax)

Parameters

Related to

SCCVW_SETVSCROLLRANGEMAX (Outside In Viewer)

VScrollState

This event is generated when the range of the vertical scroll bar changes. It allows the developer to establish correct scroll ranges external to the view window.

Usage

VScrollState( BOOL bEnabled )

Parameters

Related to

SCCVW_SETVSCROLLSTATE (Outside In Viewer)