| Oracle® Outside In Viewer for ActiveX Developer's Guide Release 8.4.1 Part Number E12847-05 |
|
|
View PDF |
| Oracle® Outside In Viewer for ActiveX Developer's Guide Release 8.4.1 Part Number E12847-05 |
|
|
View PDF |
This chapter serves as a reference for the Software Developer's Kit.
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.
This section contains properties, methods and events used when viewing documents.
This section describes user interface options.
This section presents Display Engine options.
The following tables describe more advanced topics.
The following properties are used in the SDK.
Note:
All property options are Local in scope except where noted.
Read only. This contains the user data value of the last annotation accessed.
Type
VARIANT
Default
0
Related to
SCCVW_FINDANNOTATION (Outside In Viewer)
Read only. This contains the format of the last annotation accessed. Valid values are:
ADTYPE_NODATA: User Data. The annotation was created by using one of the AddAnnotation* methods.
ADTYPE_URL: URL. The annotation is a URL hyperlink that was present in the original file format.
ADTYPE_BOOKMARK: Bookmark. The annotation is a named bookmark that was present in the original file format.
Type
Short
Default
ADTYPE_NODATA
Related to
SCCVW_GETANNOTATIONDATA (Outside In Viewer)
Read only. This contains the position object of the last annotation accessed.
Type
OixPos
Default
none
Related to
SCCVW_FINDANNOTATION (Outside In Viewer)
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)
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)
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
False
Related to
SCCID_ANTIALIAS (Outside In Viewer)
If the archive listing is sorted (see Section A.2.8, "ArchiveSortOrder"), this property determines the direction that the list will be sorted.
Type
BOOL
Default
FALSE
Related to
SCCID_ARCSORTORDER (Outside In Viewer)
Determines the order in which the files are displayed in the archive display engine. One of the following values:
SCCVW_SORT_NONE: Display files in the order they appear in the archive.
SCCVW_SORT_NAME: Display files sorted by their name.
SCCVW_SORT_SIZE: Display files sorted by their size.
SCCVW_SORT_DATE: Display files sorted by their date.
Type
Short
Default
SCCVW_SORT_NONE
Related to
SCCID_ARCSORTORDER (Outside In Viewer)
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:
TRUE: Use dithering algorithm.
FALSE: Do not use dithering algorithm.
Type
BOOL
Default
FALSE
Related to
SCCID_BMPDITHER (Outside In Viewer)
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:
TRUE: Current image can be dithered.
FALSE: Current image cannot be dithered.
Type
BOOL
Default
TRUE
Related to
SCCID_BMPDITHERAVAILABLE (Outside In Viewer)
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:
SCCVW_FITMODE_BEST: If the view window is smaller than the original image, this option will fit it to the window. If the view window is larger than the original image, the image will be displayed at its original size.
SCCVW_FITMODE_IMAGESIZE: Scale to image size.
SCCVW_FITMODE_PIXELS: The size of the window has no effect.
SCCVW_FITMODE_WINDOW: The image will be stretched to fill as much of the window as possible while maintaining its proper aspect ratio.
SCCVW_FITMODE_WINDOWHEIGHT: Height of the window. Depending on the image, its full width may or may not fit inside the window.
SCCVW_FITMODE_WINDOWWIDTH: The bitmap will be stretched so its full width fits in the width of the window.
Invalid values are reset to the last set value.
Type
Short
Default
SCCVW_FITMODE_ORIGINAL
Related to
SCCID_BMPFITMODE (Outside In Viewer)
The option indicates how the image will be stretched when printed. It can be one of the following values:
SCCVW_PRINTASPECT_IMAGESIZE: Uses the size as specified by the image.
SCCVW_PRINTASPECT_SCALE (previously referred to as SCCVW_PRINTASPECT_ORIGINAL): The image will be sized up to fill as much of the area inside the print margins as possible while still maintaining the original aspect ratio.
SCCVW_PRINTASPECT_STRETCH: The image will be stretched horizontally and vertically to totally fill the area inside the print margins.
Invalid values will be reset to the last set value.
Type
Short
Default
SCCVW_PRINTASPECT_SCALE
Related to
SCCID_BMPPRINTASPECT (Outside In Viewer)
Determines if a one-pixel border is to be printed around images. One of the following values:
TRUE: Print a one-pixel border.
FALSE: Do not print a one-pixel border.
Type
BOOL
Default
TRUE
Related to
SCCID_BMPPRINTBORDER (Outside In Viewer)
Determines how the bitmap is to be rotated. These rotations are absolute from the graphics initial state. One of the following values:
SCCVW_ROTATION_NONE: Bitmaps should have no rotation.
SCCVW_ROTATION_90: Bitmaps should be rotated 90 degrees clockwise.
SCCVW_ROTATION_180: Bitmaps should be rotated 180 degrees clockwise.
SCCVW_ROTATION_270: Bitmaps should be rotated 270 degrees clockwise.
Type
Short
Default
SCCVW_ROTATION_NONE
Related to
SCCID_BMPROTATION (Outside In Viewer)
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 Section A.2.101, "ToClipboard") to RTF (0x2) to copy text to the clipboard in this font.
Type
LPFONTDISP
Related to
SCCID_DEFAULTCLIPBOARDFONT (Outside In Viewer)
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:
SCCVW_NOTREADYCOPYTOCLIP: Not ready to copy to clipboard
SCCVW_CANCOPYTOCLIP: Ready to copy to clipboard
SCCVW_CANCUTTOCLIP: Ready to cut to clipboard
SCCVW_CANPASTEFROMCLIP: Items available on clipboard for pasting
Type
ULONG
Default
SCCVW_NOTREADYCOPYTOCLIP
Related to
SCCVW_GETCLIPINFO (Outside In Viewer)
Read only. This property contains a string that contains the data requested by a call to the Copy method (see Section A.3.11, "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)
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 Section A.3.11, "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)
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)
Determines which format the database takes when it is copied to the clipboard. One of the following values:
SCCVW_CLIPSUBFORMAT_TABLE: In supporting clipboard formats (RTF & AMI), the form will be copied as a table.
SCCVW_CLIPSUBFORMAT_OPTIMIZEDTABS: The form will be copied using a tab stop for each field, except when a field is empty.
SCCVW_CLIPSUBFORMAT_TABS: The form will be copied using a tab stop for each field.
Type
Short
Default
SCCVW_CLIPSUBFORMAT_TABLE
Related to
SCCID_DBCLIPBOARD (Outside In Viewer)
Determines how much formatting information is included when displaying a database or spreadsheet. One of the following values:
TRUE: A limited set of formatting information is included.
FALSE: All supported formatting information is included.
Type
BOOL
Default
TRUE
Related to
SCCID_DBDRAFTMODE (Outside In Viewer)
Determines if field headings / row and column names will the copied to the clipboard along with the data. One of the following values:
TRUE: Field headings will be copied.
FALSE: Field headings will not be copied.
Type
BOOL
Default
TRUE
Related to
SCCID_DBFIELDNAMESTOCLIP (Outside In Viewer)
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:
SCCVW_DBPRINTFITMODE_NOMAP: Printing will occur in its original size onto as many pages as are required to fit the data.
SCCVW_DBPRINTFITMODE_FITTOPAGE: The form will be fitted onto one page, scaling to the image width or height depending on the page size and database size.
SCCVW_DBPRINTFITMODE_FITTOWIDTH: The form will be scaled on the printed page so it is no larger than one page wide.
SCCVW_DBPRINTFITMODE_FITTOHEIGHT: The form will be scaled on the printed page so it is no larger than one page high
Type
Short
Default
SCCVW_DBPRINTFITMODE_NOMAP
Related to
SCCID_DBPRINTFITTOPAGE (Outside In Viewer)
Determines if a dotted line is printed between fields. One of the following values:
TRUE: A dotted line is printed between fields.
FALSE: A dotted line is not printed between fields.
Type
BOOL
Default
TRUE
Related to
SCCID_DBPRINTGRIDLINES (Outside In Viewer)
Determines if field headings will be printed along with the data. One of the following values:
TRUE: Field headings will be printed.
FALSE: Field headings will not be printed.
Type
BOOL
Default
TRUE
Related to
SCCID_DBPRINTHEADINGS (Outside In Viewer)
Determines if a dotted line is displayed between fields. One of the following values:
TRUE: A dotted line is displayed between fields.
FALSE: A dotted line is not displayed between fields.
Type
BOOL
Default
TRUE
Related to
SCCID_DBSHOWGRIDLINES (Outside In Viewer)
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)
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.
SCCVW_DIALOG_NO3D: The dialogs available in the Viewer should not use Microsoft's CTL3DV2.DLL to give its dialogs a 3D effect. If CTL3DV2.DLL is not available, this flag has no effect. Note: CTL3DV2.DLL is loaded dynamically (LoadLibrary) so systems without it will not cause a problem.
SCCVW_DIALOG_NOADDOPTIONSTOMENU: The dialog menu retrieved from SCCVW_GETDISPLAYINFO contains a popup with three additional items called Display..., Print..., and Clipboard.... Setting this flag will disable this extra popup.
SCCVW_DIALOG_NOADDDISPLAYTOMENU: The dialog should not display just the Display... item from the menu just described.
SCCVW_DIALOG_NOADDFONTZOOMTOMENU: Normally, the menu retrieved from SCCVW_GETDISPLAYINFO includes a popup menu called Font Size, which allows the user to enlarge, reduce or reset the font size relative to its original size. This flag disables this popup menu item.
SCCVW_DIALOG_NOADDPRINTTOMENU: The dialog should not display just the Print... item from the menu just described.
SCCVW_DIALOG_NOADDCLIPBOARDTOMENU: The dialog should not display just the Clipboard... item from the menu just described.
SCCVW_DIALOG_NOADDDOPRINTTOMENU: The dialog menu retrieved from SCCVW_GETDISPLAYINFO should not display the Print... menu item.
SCCVW_DIALOG_NOADDDOCOPYTOMENU: The dialog menu retrieved from SCCVW_GETDISPLAYINFO should not display the Copy menu item.
SCCVW_DIALOG_NOHELP: The dialogs available in the viewer technology should not display "Help" buttons.
SCCVW_DIALOG_NOMORE: The dialogs available in the viewer technology should not display "More" buttons. A "More" button allows access to another dialog with more obscure options.
SCCVW_DIALOG_NOADDSHOWFULLSCREEN: The dialog should not display the "Show Full Screen" menu option from the context menu
Type
Short
Default
0
Related to
SCCID_DIALOGFLAGS (Outside In Viewer)
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)
Read only. This property contains a numeric identifier for the type of display engine in use. The types are as follows:
SCCVWTYPE_NONE: No Display Engine is loaded
SCCVWTYPE_UNKNOWN: Unknown Display Engine
SCCVWTYPE_WP: Word Processor Display Engine
SCCVWTYPE_SS: Spreadsheet Display Engine
SCCVWTYPE_DB: Database Display Engine
SCCVWTYPE_HEX: Hexadecimal Display Engine
SCCVWTYPE_IMAGE: Bitmap graphics Display Engine
SCCVWTYPE_ARCHIVE: Archive Display Engine
SCCVWTYPE_VECTOR: Vector Display Engine
Type
SHORT
Default
SCCVWTYPE_NONE
Related to
SCCVW_GETDISPLAYINFO (Outside In Viewer)
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)
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 Section A.4.3, "ContextMenu") in order to provide one.
Type
BOOL
Default
TRUE
Related to
SCCVW_CONTEXTMENU (Outside In Viewer)
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:
SCCDOCUMENTMEMORYMODE_SMALLEST : 4MB
SCCDOCUMENTMEMORYMODE_SMALL : 16MB
SCCDOCUMENTMEMORYMODE_MEDIUM : 64MB
SCCDOCUMENTMEMORYMODE_LARGE : 256MB
SCCDOCUMENTMEMORYMODE_LARGEST : 1 GB
Note:
This option is Global in scope.
Type
LONG
Default
SCCDOCUMENTMEMORYMODE_SMALL
Related to
SCCID_DOCUMENTMEMORYMODE (Outside In Viewer)
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)
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)
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)
Read only. Contains an error message that corresponds to error status reported by the ErrorCode property (see Section A.2.36, "ErrorCode"). It is a zero length string if there is no error.
Type
BSTR
Default
0
Related to
SCCVW_BAILOUT (Outside In Viewer)
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)
This property defines how the viewer displays unidentifiable documents. Valid values for this property are as follows:
FI_ANSI: ANSI
FI_ANSI8: ANSI18
FI_ASCII: ASCII
FI_ASCII8: ASCII8
FI_CHINESEBIG5: CHINESEBIG5
FI_CHINESEGB: CHINESEGB
FI_DONTVIEW: DONTVIEW
FI_HANGEUL: HANGEUL
FI_HEX: HEX
FI_MAC: MAC
FI_MAC8: MAC 8
FI_SHIFTJIS: SHIFTJIS
FI_UNICODE: Unicode
Note:
This option is Global in scope.
Type
Int
Default
FI_ANSI
Related to
SCCID_FALLBACKFORMAT (Outside In Viewer)
This property is set to use flags related to File Identification behavior. It can be one of the following:
FALSE: The File Identification code will identify all formats that are supported by the ActiveX control without performing extended file identification on unknown files.
TRUE: The File Identification code will run an extended test on all files that are not identified (for example, FI_UNKNOWN). This will try to identify files as 7-bit text file (FI_7BITTEXT) or as an ANSI text file (FI_ANSI8).
Note:
This option is Global in scope.
Type
Bool
Default
FALSE
Related to
SCCID_FIFLAGS (Outside In Viewer)
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 Section A.3.46, "ViewFile") or is generated by the viewer based on the real name of the file. This property is updated whenever the FileChange event (see Section A.4.8, "FileChange") occurs.
Type
BSTR
Default
Null
Related to
SCCVW_GETFILEINFO, SCCVW_SETDISPLAYNAME (Outside In Viewer)
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)
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)
Read only. The full path to the actual file being viewed.
Type
BSTR
Default
Null
Related to
SCCVW_GETFILEINFO (Outside In Viewer)
This property determines the behavior of certain filters. This property can contain one or more of the following values OR-ed together:
OIX_ENABLEJPG : Enable access to any files using JPEG compression.
OIX_ENABLELZW : Enable access to any files using LZW compression.
OIX_FILTER_REORDERED_BIDI : Enable reordering of bi-directional text from PDF files in correct reading order.
OIX_IGNOREPASSWORD : Disable password verification of files where the contents can be processed without validation of the password.
The following is a list of file types affected when OIX_ENABLELZW option is turned off:
GIF files
TIF files using LZW compression
PDF files that use internal LZW compression
TAZ and TAR archives containing files that are identified as FI_UNIXCOMP
ZIP and self-extracting archive (.EXE) files containing "shrunk" files
Postscript files using LZW compression
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:
JPG files
Postscript files containing JPG images
PDFs containing JPEG images
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)
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)
This option determines the formatting options of data. It can be one of the following values:
SCCOPT_FLAGS_ALLISODATETIMES: 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.
0: All flags turned off
Type
LONG
Default
0
Related to
SCCOPT_FORMATFLAGS (Outside In Viewer)
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)
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
One or more of the following values OR-ed together:
HTML_COND_COMMENT_NONE: Don't output any conditional comments. Note: setting any other flag will negate this.
HTML_COND_COMMENT_IE5: include the IE 5 comments
HTML_COND_COMMENT_IE6: include the IE 6 comments
HTML_COND_COMMENT_IE7: include the IE 7 comments
HTML_COND_COMMENT_IE8: include the IE 8 comments
HTML_COND_COMMENT_IE9: include the IE 9 comments
HTML_COND_COMMENT_ALL: include all conditional comments including the versions listed above and any other versions that might be in the HTML.
Default
HTML_COND_COMMENT_NONE
Related to
SCCID_HTML_COND_COMMENT_MODE (Outside In Viewer)
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)
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)
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
SCCVW_ENGLISHUNITS: If set, the print margins are displayed to the users in inches. If not set, the print margins are displayed in metric units.
SCCVW_12HOURTIME: If set, time variables are formatted for display using a 12-hour clock. If not set, time variables are formatted for display using a 24-hour clock.
Read only. This property is filled with the formatted page height in logical units after a call to DrawPage, GetDrawPageInfo, or DrawPageEx (see DrawPage Section A.3.25, "GetDrawPageInfo," and Section A.3.18, "DrawPageEx").
Type
LONG
Default
0
Related to
SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)
Read only. This property is filled with the formatted page width in logical units after a call to DrawPage, GetDrawPageInfo, or DrawPageEx (see DrawPage Section A.3.25, "GetDrawPageInfo," and Section A.3.18, "DrawPageEx").
Type
LONG
Default
0
Related to
SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)
This property is filled with a palette handle after a call to DrawPage (see Section A.3.17, "DrawPage").
Type
OLE_HANDLE
Default
none
Related to
SCCVW_DRAWPAGE (Outside In Viewer)
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 Section A.3.17, "DrawPage").
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 Section A.3.18, "DrawPageEx").
Type
LONG
Default
0
Related to
SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)
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 Section A.3.18, "DrawPageEx").
Type
LONG
Default
0
Related to
SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)
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 Section A.3.18, "DrawPageEx").
Type
LONG
Default
0
Related to
SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)
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 Section A.3.18, "DrawPageEx").
Type
LONG
Default
0
Related to
SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)
Read only. This property is filled with the units per inch that PageFormatHeight and PageFormatWidth properties (see Section A.2.53, "PageFormatHeight," and Section A.2.54, "PageFormatWidth") represent after a call to DrawPage, GetDrawPageInfo, or DrawPageEx (see Section A.3.17, "DrawPage," Section A.3.25, "GetDrawPageInfo," and Section A.3.18, "DrawPageEx").
Type
LONG
Default
0
Related to
SCCVW_GETDRAWPAGEINFO, SCCVW_DRAWPAGE (Outside In Viewer)
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:
TRUE: Parse the XMP data into normal OIT document properties.
FALSE: Do not parse XMP data.
Type
BOOL
Default
FALSE
Related to
SCCID_PARSEXMPMETADATA (Outside In Viewer)
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
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)
This property indicates the page printing should end on. It is only valid if the WhatToPrint property (see Section A.2.110, "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)
This property holds the handle of the printer device context that may be used with the PrintOI method (see Section A.3.35, "PrintOI"), if the developer chooses to control printing in this way.
Type
OLE_HANDLE
Default
NULL
Related to
SCCVW_PRINTEX (Outside In Viewer)
This property is used with the PrinterName and PrinterPort properties (see Section A.2.68, "PrinterName," and Section A.2.69, "PrinterPort") to optionally specify a printer in the PrintOI method (see Section A.3.35, "PrintOI").
Type
BSTR
Default
NULL
Related to
SCCVW_PRINTEX (Outside In Viewer)
This property contains the name for a printer. This may be used in the PrintOI method (see Section A.3.35, "PrintOI"), if the developer chooses to control printing in this way.
Type
BSTR
Default
NULL
Related to
SCCVW_PRINTEX (Outside In Viewer)
This property is used in conjunction with the PrinterName property (see Section A.2.68, "PrinterName") to specify a printer in the PrintOI method (see Section A.3.35, "PrintOI").
Type
BSTR
Default
NULL
Related to
SCCVW_PRINTEX (Outside In Viewer)
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)
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)
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)
This property indicates the page on which printing should start. It is only valid if the WhatToPrint property (see Section A.2.110, "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)
Read only. This is a value that represents which character set the RawTextString (see Section A.2.77, "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)
Read Only. This is a value that represents the size of the RawTextString (see Section A.2.77, "RawTextString") buffer created when requested through GetRawText (see Section A.3.27, "GetRawText").
Type
Long
Default
0
Related to
SCCVW_GETRAWTEXT (Outside In Viewer)
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 Section A.2.77, "RawTextString").
Type
Long
Default
0
Related to
SCCVW_GETRAWTEXT (Outside In Viewer)
Read only. This is the string that represents the raw text requested by GetRawText (see Section A.3.27, "GetRawText").
Type
BSTR
Default
NULL
Related to
SCCVW_GETRAWTEXT (Outside In Viewer)
This property indicates how the viewer reorders bidirectional text.
It can be one of the following values:
SCCVW_REORDER_NOVALUE has been replaced by SCCUT_REORDER_UNICODE_OFF: No bidirectional support.
SCCVW_REORDER_NONE is obsolete.
SCCVW_REORDER_UNICODE has been replaced by SCCUT_REORDER_UNICODE_RTOL: Characters are reordered using the Unicode bidirectional algorithm in right-to-left order.
SCCVW_REORDER_FULL is obsolete.
SCCUT_REORDER_UNICODE_OFF: This disables any processing for unicode characters. This option is the default.
SCCUT_REORDER_UNICODE_LTOR: Characters displayed using the Unicode bidirectional algorithm in left-to-right order.
SCCUT_REORDER_UNICODE_RTOL: Characters displayed using the Unicode bidirectional algorithm in right-to-left order.
Type
Short
Default
SCCVW_REORDER_NONE
Related to
SCCID_REORDERMETHOD (Outside In Viewer)
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)
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 Section 5.2, "Positions." This property is also populated with the start of user-selected text.
Type
OixPos
Default
none
Related to
SCCVW_SETSELECTION (Outside In Viewer)
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 Section 5.2, "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)
Determines what format the database or spreadsheet takes when it is copied to the clipboard.
SCCVW_CLIPSUBFORMAT_TABLE: In supporting clipboard formats (RTF & AMI), the form will be copied as a table.
SCCVW_CLIPSUBFORMAT_OPTIMIZEDTABS: The form will be copied using a tab stop for each field, except when a field is empty.
SCCVW_CLIPSUBFORMAT_TABS: The form will be copied using a tab stop for each field.
Type
Short
Default
SCCVW_CLIPSUBFORMAT_TABLE
Related to
SCCID_SSCLIPBOARD (Outside In Viewer)
Determines how much formatting information is included when displaying a database or spreadsheet.
TRUE: A limited set of formatting information is included.
FALSE: All supported formatting information is included.
Type
BOOL
Default
TRUE
Related to
SCCID_SSDRAFTMODE (Outside In Viewer)
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:
SCCVW_SSPRINTDIRECTION_ACROSS: Print spreadsheet across first, then down
SCCVW_SSPRINTDIRECTION_DOWN: Print spreadsheet down first, then across
Type
Long
Default
SCCVW_SSPRINTDIRECTION_ACROSS
Related to
SCCID_SSPRINTSCALEXWIDE (Outside In Viewer)
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:
SCCVW_SSPRINTFITMODE_NOMAP: Printing will occur in its original size onto as many pages as are required to fit the data.
SCCVW_SSPRINTFITMODE_SCALE: The spreadsheet will be scaled on the printed page using the scale value in the SSPrintScalePercent property (see Section A.2.88, "SSPrintScalePercent"). This value is valid for spreadsheets only.
SCCVW_SSPRINTFITMODE_FITTOPAGES: The spreadsheet will be scaled on the printed page to fit to the number of pages specified in the SSPrintScaleXHigh and SSPrintScaleXWide (see Section A.2.89, "SSPrintScaleXHigh," and Section A.2.90, "SSPrintScaleXWide"). This value is valid for spreadsheets only.
SCCVW_SSPRINTFITMODE_FITTOPAGE: Fit to one page.
SCCVW_SSPRINTFITMODE_FITTOWIDTH: Scale to one page width.
SCCVW_SSPRINTFITMODE_FITTOHEIGHT: Scale to one page height.
SCCVW_SSPRINTFITMODE_SCALE: Scale to value specified in SSPrintScalePercent (see Section A.2.88, "SSPrintScalePercent").
Type
Short
Default
SCCVW_SSPRINTFITMODE_NOMAP
Related to
SCCID_SSPRINTFITTOPAGE (Outside In Viewer)
Determines if a dotted line is printed between fields. The following values are valid:
TRUE: A dotted line is printed between fields.
FALSE: A dotted line is not printed between fields.
Type
BOOL
Default
TRUE
Related to
SCCID_SSPRINTGRIDLINES (Outside In Viewer)
Determines if field headings will be printed along with the data. The following values are valid:
TRUE: Field headings will be printed.
FALSE: Field headings will not be printed.
Type
BOOL
Default
TRUE
Related to
SCCID_SSPRINTHEADINGS (Outside In Viewer)
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)
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)
This option will fit the printing to the number of horizontal pages specified.
Type
Long
Default
1
Related to
SCCID_SSPRINTSCALEXWIDE (Outside In Viewer)
Determines if a dotted line is displayed between fields. The following values are valid:
TRUE: A dotted line is displayed between fields.
FALSE: A dotted line is not displayed between fields.
Type
BOOL
Default
TRUE
Related to
SCCID_SSSHOWGRIDLINES (Outside In Viewer)
Determines whether hidden rows and columns will be shown when displaying a spreadsheet. This can be one of the following values:
TRUE: Show hidden cells.
FALSE: Do not show hidden cells
Type
BOOL
Default
FALSE
Related to
SCCID_SSSHOWHIDDENCELLS (Outside In Viewer)
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:
OIT_STATUS_CONTINUE: Tells Outside In to continue processing the current document.
OIT_STATUS_ABORT: Tells Outside In to stop processing the current document.
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)
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)
If set to TRUE then the developer will receive the RawTextEvent (see Section A.4.21, "RawTextEvent") as new text becomes available.
Note:
This option is Global in scope.
Type
BOOL
Default
FALSE
Related to
SCCID_SYSTEMFLAGS (Outside In Viewer)
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)
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 Section A.3.45, "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)
If this property is set to TRUE, then Unicode will be enabled. This affects the methods GetRawText, Search, and Get AnnotationData (see Section A.3.27, "GetRawText," Section A.3.38, "Search," and Section A.3.23, "GetAnnotationData").
Note:
This option is Global in scope.
Type
long
Default
FALSE
Related to
SCCID_SYSTEMFLAGS (Outside In Viewer)
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:
This option does not apply for spreadsheet files.
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)
This property controls the format that the viewer copies to the clipboard when the CopyToClip method (see Section A.3.13, "CopyToClip") is called. This property can contain one or more of the following values OR-ed together:
SCCVW_CLIPFORMAT_TEXT: Text in whatever character set is appropriate for the operating system
SCCVW_CLIPFORMAT_RTF: Rich Text Format
SCCVW_CLIPFORMAT_UNICODE: Unicode text format
SCCVW_CLIPFORMAT_WINBITMAP: Windows Bitmap
SCCVW_CLIPFORMAT_WINDIB: Windows Device Independent Bitmap
SCCVW_CLIPFORMAT_WINMETAFILE: Windows Metafile
SCCVW_CLIPFORMAT_WINPALETTE: Windows Palette
Type
ULONG
Default
SCCVW_CLIPFORMAT_WINMETAFILE
Related to
SCCID_TOCLIPBOARD (Outside In Viewer)
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)
Used to select the document's page layout information when printing.
Type
BOOL
Default
TRUE
Related to
SCCID_USEDOCPAGESETTINGS (Outside In Viewer)
Data
TRUE: The document's native page margins and paper size are used when available from the filter.
FALSE: The printer's page margins and paper size are used instead of those of the native document.
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:
SCCVW_FITMODE_IMAGESIZE: Scale to the image size.
SCCVW_FITMODE_ORIGINAL: The size of the window has no effect.
SCCVW_FITMODE_WINDOW: The image will be stretched to fill as much of the window as possible while maintaining its proper aspect ratio.
SCCVW_FITMODE_WINDOWHEIGHT: The image will be stretched so its full height fits in the height of the window. Depending on the image, its full width may or may not fit inside the window.
SCCVW_FITMODE_WINDOWWIDTH: The bitmap will be stretched so its full width fits in the width of the window.
SCCVW_FITMODE_STRETCHWINDOW: The image will be stretched to fill the window. The image's aspect ratio is NOT maintained.
SCCVW_FITMODE_BEST: If the view window is smaller than the original image, this option will fit it to the window. If the view window is larger than the original image, the image will be displayed at its original size.
Invalid values will be reset to the last set value.
Type
Short
Default
SCCVW_FITMODE_ORIGINAL
Related to
SCCID_VECFITMODE (Outside In Viewer)
The option indicates how the image will be stretched when printed. It can be one of the following values:
SCCVW_PRINTASPECT_SCALE (previously referred as SCCVW_PRINTASPECT_ORIGINAL): The image will be sized up to fill as much of the area inside the print margins as possible while still maintaining the original aspect ratio.
SCCVW_PRINTASPECT_STRETCH: The image will be stretched horizontally and vertically to totally fill the area inside the print margins.
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)
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)
Determines if a one-pixel border is to be printed around images. One of the following values:
TRUE: Print a one-pixel border.
FALSE: Do not print a one-pixel border.
Type
BOOL
Default
TRUE
Related to
SCCID_VECPRINTBORDER (Outside In Viewer)
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)
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)
This option indicates how much of a file should be printed when the PrintOI method (see Section A.3.35, "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
SCCVW_PRINT_ALLPAGES: The entire document will be printed
SCCVW_PRINT_SELECTION: Just the selected area will be printed
SCCVW_PRINT_PAGERANGE: The pages in the range PrintStartPage and PrintEndPage (see Section A.2.73, "PrintStartPage," and Section A.2.65, "PrintEndPage") will be printed.
SCCVW_PRINT_CURSECTION: The current section will be printed.
This property indicates how the word processor display engine displays the document. It can be one of the following:
SCCVW_WPMODE_DRAFT: The document is displayed using only a single font and size (determined by the DisplayFont property. For more information, see Section A.2.31, "DisplayFont"). It does not display embedded graphics, graphic borders, or table borders. Text is wrapped to the size of the view window.
SCCVW_WPMODE_NORMAL: All supported formatting is displayed. The text is wrapped to the size of the view window.
SCCVW_WPMODE_PREVIEW: All supported formatting is displayed. The text is wrapped as it will be printed.
Type
Short
Default
SCCVW_WPMODE_PREVIEW
Related to
SCCID_WPDISPLAYMODE (Outside In Viewer)
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:
SCCUT_WP_EMAILHEADERSTANDARD: Displays a standardized set of headers based on the type of document being viewed. These are:
Emails - "To", "From", "Subject", "CC", "BCC", "Date Sent", "Importance", and "Attachments"
Journal Entries - "Entry Type", "Subject", "Start", "Duration", "Company", "Categories", and "Attachments"
Tasks - "Subject", "Start Date", "Due Date", "Status", "Priority", "Percent Complete", "Owner", "Categories", and "Attachments"
Contacts - "First Name", "Family Name", "Middle Name", "Title", "Suffix", "Job Title", "File As", "Email", "Business Phone", "Home Phone", "Business Address", "Home Address", "Mobile Phone", "Business Fax", "IM Address", "Company", "Webpage", and "Attachments"
Appointments - "To", "Location", "Subject", "Start Time", "End Time", "Required Attendee", "Optional Attendee", "Importance", "Categories", and "Attachments"
Posts - "From", "Creation Time", "Subject", "Conversation Topic", and "Attachments"
Notes - "Creation Time", "Categories", and "Attachments"
Distribution Lists - "Subject" and "Attachments".
SCCUT_WP_EMAILHEADERALL: Displays all available email headers.
SCCUT_WP_EMAILHEADERNONE : Display no email headers.
SCCUT_WP_EMAILHEADERCUSTOM : Custom headers are displayed (Cannot use this to value set this property - but the control would return this value if custom headers are being used).
Type
Long
Default
SCCUT_WP_EMAILHEADERSTANDARD
Related to
SCCID_WPEMAILHEADEROUTPUT (Outside In Viewer)
This property controls the size of word processor pages when using the preview mode. One of the following values:
SCCVW_FITMODE_ORIGINAL: Sizes the preview page to the actual size.
SCCVW_FITMODE_WINDOW: Sizes the preview page to the window.
SCCVW_FITMODE_WINDOWWIDTH: Sizes the preview page to the width of the window.
Type
Short
Default
SCCVW_FITMODE_ORIGINAL
Related to
SCCID_WPFITMODE (Outside In Viewer)
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)
The following methods are used in the SDK.
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
lId: Unique positive number that may be used later to remove, jump to, or otherwise identify the particular annotation or set of annotations. Initialize this value to 0 or a negative number if you are not using this functionality. This parameter is required. There are no invalid values. Negative values are not recommended because they may conflict with the hyperlink and bookmark masks.
varData: Additional user data associated with the annotation.
lStartPos: Starting text position for the hidden area expressed as a position object. If the value is invalid, then the method will generate an error and not create an annotation. If the value is not passed, then it will use the currently selected text. If no text is selected, then no annotation will be placed.
lEndPos: Ending text position for the hidden area expressed as a position object. If the value is invalid, then the method will generate an error and not create an annotation. If the value is not passed, then it will use the currently selected text. If no text is selected, then no annotation will be placed.
Related to
SCCVW_ADDANNOTATION (Outside In Viewer)
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
lId: Unique number that may be used later to remove, jump to, or otherwise identify the particular annotation or set of annotations. Initialize this value to 0 or a negative number if you are not using this functionality. This parameter is required. The use of the high bit is reserved for internal annotation tagging.
iStyle: Set the hilite to a previously defined style from the method HiliteStyle (see Section A.3.29, "HiliteStyle"). If this parameter is set to zero, then the Background and Foreground values will be used to determine the hilite style. If this value is negative, then an error will occur.
iEvent: Indicates the type of events the developer would like to receive for this annotation. The following values may be combined. If the value is 0 the developer will receive no events:
SCCVW_EVENTDOUBLECLICK: Double click on Annotation
SCCVW_EVENTSINGLECLICK: Single click on Annotation
SCCVW_EVENTSINGLERIGHTCLICK : Single right click on Annotation
SCCVW_EVENTTRANSITIONINTO: Transition Cursor into the Annotation
SCCVW_EVENTTRANSITIONOUTOF: Transition Cursor out of the Annotation
This parameter is required. There are no invalid values.
iBackground: Set to a value to determine the text background color. The following values are valid:
OIX_BDEFAULT: Do not change background color
OIX_BBLACK: Black background
OIX_BDARKRED: Dark Red background
OIX_BDARKGREEN: Dark Green background
OIX_BDARKYELLOW: Dark Yellow background
OIX_BDARKBLUE: Dark Blue background
OIX_BDARKMAGENTA: Dark Magenta background
OIX_BDARKCYAN: Dark Cyan background
OIX_BLIGHTGRAY: Light Gray background
OIX_BGRAY: Gray background
OIX_BRED: Red background
OIX_BGREEN: Green background
OIX_BYELLOW: Yellow background
OIX_BBLUE: Blue background
OIX_BMAGENTA: Magenta background
OIX_BCYAN: Cyan background
OIX_BWHITE: White background
If the value is invalid, the method will generate an error and not create an annotation. If the style parameter is non-zero, then this parameter will be ignored.
iForeground: Set to a value to determine the text foreground color.
OIX_FDEFAULT: Do not change foreground color
OIX_FBLACK: Black foreground
OIX_FDARKRED: Dark Red foreground
OIX_FDARKGREEN: Dark Green foreground
OIX_FDARKYELLOW: Dark Yellow foreground
OIX_FDARKBLUE: Dark Blue foreground
OIX_FDARKMAGENTA: Dark Magenta foreground
OIX_FDARKCYAN: Dark Cyan foreground
OIX_FLIGHTGRAY: Light Gray foreground
OIX_FGRAY: Gray foreground
OIX_FRED: Red foreground
OIX_FGREEN: Green foreground
OIX_FYELLOW: Yellow foreground
OIX_FBLUE: Blue foreground
OIX_FMAGENTA: Magenta foreground
OIX_FCYAN: Cyan foreground
OIX_FWHITE: White foreground
If the value is invalid, then the method will generate an error and not create an annotation. If the style parameter is non-zero, then the value of this parameter will be ignored.
varData: Additional user data associated with the annotation. This parameter is not required.
StartPos: Starting text position for the hilited area expressed as a position object (see Section 5.2, "Positions"). If the value is invalid, then the method will generate an error and not create an annotation. If the value is not passed, then it will use the currently selected text. If no text is selected, then no annotation will be placed.
EndPos: Ending text position for the hilited area expressed as a position object. If the value is invalid, then the method will generate an error and not create an annotation. If the value is not passed, then it will use the currently selected text. If no text is selected, then no annotation will be placed.
Related to
SCCVW_ADDANNOTATION. (Outside In Viewer)
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
lId: Unique number that may be used later to remove, jump to or otherwise identify the particular annotation or set of annotations. Initialize this value to 0 or a negative number if you are not using this functionality. This parameter is required. There are no invalid values.
varData: Additional user data associated with the annotation. This parameter can be NULL.
InsertPosition: The position at which the text is to be inserted.
varInsertText: The UNICODE text to be inserted. This is passed by reference.
Related to
SCCVW_ADDANNOTATION (Outside In Viewer)
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
lId: Unique positive number that may be used later to remove, jump to, or otherwise identify the particular annotation or set of annotations. Initialize this value to 0 or a negative number if you are not using this functionality. This parameter is required. There are no invalid values.
pdPicture: Pointer to an IPictureDisp (Picture Object) interface that contains the image to be inserted into the viewed document. This parameter is required. If the Picture is an Icon, then an icon will be inserted into document. Otherwise, a bitmap will be inserted into the document. If the Picture is invalid, then an error will be generated and no annotation will be placed.
iEvent: Indicates the type of events the developer would like to receive for this annotation. These values may be combined. If the value is 0 the developer will receive no events. The following values are valid:
SCCVW_EVENTSINGLECLICK: Single click on annotation
SCCVW_EVENTDOUBLECLICK: Double click on annotation
SCCVW_EVENTSINGLERIGHTCLICK : Single right click on Annotation
SCCVW_EVENTTRANSITIONINTO: Transition cursor into the annotation
SCCVW_EVENTTRANSITIONOUTOF: Transition cursor out of the annotation
This parameter is required. If the value is invalid, then the method will generate an error and not create an annotation.
varData: Text associated with this annotation. Allows the developer to easily associate text with the annotation. This parameter is not required. If the parameter is not passed then no text will be associated with the annotation. Any attempt to retrieve the text will return a zero-length string. If a zero length string or a NULL string pointer is passed, then no text will be associated with the annotation. There are no invalid values.
Pos: Text position for the annotation expressed as a position object. If the value is invalid, then the method will fire an error and not create an annotation. If the value is not passed, then it will use the current caret position. If there is no current position, then no annotation will be placed.
Related to
SCCVW_ADDANNOTATION (Outside In Viewer)
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
bSelect: If this is TRUE, then the annotated document text is selected. Otherwise, the caret is placed at the start of the annotation. For picture annotations, this parameter has no effect. This parameter is required and has no invalid values.
Related to
SCCVW_DISPLAYPOSITION (Outside In Viewer)
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:
SCCVW_ARCHIVE_SAVESELECTION: Saves the selected files to the directory of choice.
SCCVW_ARCHIVE_SAVEALL: Saves all the files to the directory of choice.
Related to
SCCID_ARCSAVEEVENT (Outside In Viewer)
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)
This message allows the developer to selectively remove annotations.
Usage
Void ClearAnnotations( short iMask, long lRemoveId )
Returns
Void
Parameters
iMask: This must be set to one of the following values:
OIX_CLEARANNO_ALL
OIX_CLEARANNO_MASK
OIX_CLEARANNO_ABSOLUTE
If RemoveId is used as a mask to remove annotations, then any annotation for which Id & RemoveId = RemoveId will be removed. This parameter is required. If it is invalid, then an error will be generated and no annotations will be removed.
lRemoveId: This parameter specifies which annotations to remove in conjunction with the mask. RemoveId must be a positive number if the value for the Mask parameter is OIX_CLEARANNO_ALL or OIX_CLEARANNO_MASK. This parameter is required. If the value is invalid (a negative number with Mask of OIX_CLEARANNO_ALL or OIX_CLEARANNO_MASK), then an error will be generated and no annotations will be removed.
Related to
SCCVW_CLEARANNOTATIONS (Outside In Viewer)
Displays a dialog that lets the user set a number of aspects of how files are copied to the clipboard.
Usage
Short ClipboardOptions()
Returns
OIX_DIALOG_OK: Dialog successful
OIX_DIALOG_CANCEL: Dialog canceled by user
Parameters
none
Related to
SCCVW_DODIALOG (Outside In Viewer)
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
-1: if PositionA is less than PositionB
0: if PositionA equals PositionB
1: if PositionA is greater than PositionB
Parameters
PositionA: This value indicates the previously set position object to use in the comparison.
PositionB: This value indicates the previously set position object to use in the comparison. If either PositionA or PositionB is invalid, an error will occur.
Related to
SCCVW_COMPPOSITIONS (Outside In Viewer)
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
lFormatId: This parameter indicates the output format. It must be one of the following values:
SCCVW_CLIPFORMAT_TEXT: Clipboard Text, text in whatever character set is appropriate for the operating system.
SCCVW_CLIPFORMAT_RTF: Rich Text Format
This parameter is required. If the parameter is invalid, then an error will occur.
StartPos: This parameter indicates the starting position object of the area to be copied. This parameter is required. If the parameter is invalid, then an error will occur.
EndPos: This parameter indicates the ending position object of the area to be copied. This parameter is required. If the parameter is invalid, then an error will occur.
Related to
SCCVW_COPY (Outside In Viewer)
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
DestPos: This is a number that designates the position object to copy into.
SourcePos: This is a number that designates the position object to copy from.
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)
This function cleans up the memory allocated by InitDrawPage (see Section A.3.34, "InitDrawPage"). After calling DeinitDrawPage, InitDrawPage must be called again before DrawPage or GetDrawPageInfo can be called (see Section A.3.14, "DeinitDrawPage," Section A.3.34, "InitDrawPage," Section A.3.17, "DrawPage," and Section A.3.25, "GetDrawPageInfo").
Usage
Void DeinitDrawPage()
Returns
Void
Related to
SCCVW_DEINITDRAWPAGE (Outside In Viewer)
Displays a dialog that lets the user set a number of aspects of how files are viewed.
Usage
BOOL DisplayOptions()
Returns
OIX_DIALOG_OK: Dialog successful.
OIX_DIALOG_CANCEL: Dialog canceled by user.
Related to
SCCVW_DODIALOG (Outside In Viewer)
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
Position: This is the Position object to use to adjust the display.
iDisplayOptions: This option determines where in the display the indicated position should appear. If it is set to some other value or not passed at all, then the control will display the position with as little scrolling of the screen as possible. The options are:
SCCVW_DISPLAYNEARTOP: The position will be displayed near the top of the view.
SCCVW_DISPLAYNEARMIDDLE: The position will be displayed near the middle of the view.
SCCVW_DISPLAYNEARBOTTOM: The position will be displayed near the bottom of the view.
Related to:
SCCVW_DISPLAYPOSITION (Outside In Viewer)
This method will draw a specified page and return that page as a Picture Object in the PagePicture property (see Section A.2.56, "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 Section A.3.34, "InitDrawPage") must be called before attempting DrawPage invocation (see Section A.3.17, "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
lPageNumber: The zero-based page number to draw into the picture. The parameter is required. If the parameter is invalid, then an error will be fired and the operation will abort.
lTop, lLeft, lBottom, lRight: These parameters specify a rectangle in HIMETRIC units (.01 mm ) that is equivalent to FormatHeight and FormatWidth. If these parameters indicate a zero width or zero height rectangle, then an error will be fired and the operation will be aborted.
lFormatWidth: This is the width of the wrappable part of the page. For instance, if your page is 8.5 inches wide and you want .5 inch margins, then FormatWidth should represent 7.5 inches. If the parameter is zero or negative, then an error will be fired and the operation will be aborted.
lFormatHeight: This is the height of the wrappable part of the page. For instance, if your page is 11 inches wide and you want .5 inch margins, the FormatHeight should represent 10 inches. If the parameter is zero or negative, then an error will be fired and the operation will be aborted.
iUnitsPerInch: This is the number of units per inch that FormatWidth and FormatHeight are in. For instance, if FormatHeight and FormatWidth are in twips, then UnitsPerInch would be 1440. If UnitsPerInch is zero or less, then an error will be fired and the operation will abort.
Related to
SCCVW_DRAWPAGE (Outside In Viewer)
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 Section A.2.60, "PageResultTop," Section A.2.58, "PageResultLeft," Section A.2.57, "PageResultBottom," and Section A.2.59, "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
TRUE: Indicates Success
FALSE: The page was not drawn
Parameters
lPageNumber: The zero-based page number to draw into the picture. The parameter is required. If the parameter is invalid, then an error will be generated and the operation will abort.
lFlags: This parameter contains options for the how the page is drawn. The values may be OR-ed together to select more than one option at a time.
SCCVW_DPFLAG_RETURNPALETTE: Return a Palette in the PagePaletteHandle property (see Section A.2.55, "PagePaletteHandle").
SCCVW_DPFLAG_NOTMETAFILE: Assume hOutputDC is not a metafile DC, even if Windows says it is.
SCCVW_DPFLAG_IGNOREBACKGROUND: Ignore the background when rendering the page.
SCCVW_DPFLAG_DETERMINEOUTPUTTYPE: Attempt to determine the output device context type at runtime and emulate either a screen or printer. By default, draw page will emulate a printer. This is useful for enabling transparency effects when using creating a metafile.
This parameter is required. There are no invalid values.
lTop, lLeft, lBottom, lRight: These parameters specify a rectangle in HIMETRIC units (.01 mm) that is equivalent to lFormatHeight and lFormatWidth. If these parameters indicate a zero width or zero height rectangle, then an error will be generated and the operation will be aborted.
lFormatWidth: This is the width of the wrappable part of the page. For instance, if your page is 8.5 inches wide and you want .5 inch margins, then lFormatWidth should represent 7.5 inches. If the parameter is zero or negative, then an error will be generated and the operation will be aborted.
lFormatHeight: This is the height of the wrappable part of the page. For instance, if your page is 11 inches wide and you want .5 inch margins, the lFormatHeight should represent 10 inches. If the parameter is zero or negative, then an error will be generated and the operation will be aborted.
iUnitsPerInch: This is the number of units per inch that FormatWidth and FormatHeight are in. For instance, if FormatHeight and FormatWidth are in twips, then UnitsPerInch would be 1440. If UnitsPerInch is zero or less, then an error will be generated and the operation will abort.
hOutputDC: This is a handle to the device context to draw into. This parameter is required and an invalid value will cause an error.
hFormatDCA: This is a handle to a device (or information) context used to wrap text and retrieve other formatting information. This may not be the same as hOutputDC. This parameter is required and an invalid value will cause an error.
hPalette: The handle to the palette to be used for drawing the picture. An invalid value will cause an error.
Related to
SCCVW_DRAWPAGE (Outside In Viewer)
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
lPageNumber: The zero-based page number to draw into the picture. The parameter is required. If the parameter is invalid, then an error will be fired and the operation will abort.
lTop, lLeft, lBottom, lRight: These parameters specify a rectangle in HIMETRIC units (.01 mm ) that is equivalent to FormatHeight and FormatWidth. If these parameters indicate a zero width or zero height rectangle, then an error will be fired and the operation will be aborted.
lFormatWidth: This is the width of the wrappable part of the page. For instance, if your page is 8.5 inches wide and you want .5 inch margins, then FormatWidth should represent 7.5 inches. If the parameter is zero or negative, then an error will be fired and the operation will be aborted.
lFormatHeight: This is the height of the wrappable part of the page. For instance, if your page is 11 inches wide and you want .5 inch margins, the FormatHeight should represent 10 inches. If the parameter is zero or negative, then an error will be fired and the operation will be aborted.
iUnitsPerInch: This is the number of units per inch that FormatWidth and FormatHeight are in. For instance, if FormatHeight and FormatWidth are in twips, then UnitsPerInch would be 1440. If UnitsPerInch is zero or less, then an error will be fired and the operation will abort.
sFormatID: This should be one of the following:
OIX_DRAWPAGE_FORMAT_WMF: Draw the specified page as a Windows Metafile.
OIX_DRAWPAGE_FORMAT_EMF: Draw the specified page as an Enhanced Windows Metafile.
Related to
SCCVW_DRAWPAGE (Outside In Viewer)
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
iFindType: Indicates the type of find operation to be performed. The following values are valid:
OIX_FINDFIRST: Find first or only matching annotation.
OIX_FINDLAST: Find last or only matching annotation.
OIX_FINDPREV: Find previous matching annotation.
OIX_FINDNEXT: Find next matching annotation.
This parameter is required. If the value is invalid, then the method will generate an Error event (see Section A.4.7, "Error") and the operation will abort.
iMask: Indicates how the annotations will be matched. The following values are valid:
OIX_ANNOTATION_ALL: Find all annotations - this includes internal annotations.
OIX_MASK: Use FindId as a mask to find annotations.
OIX_ABSOLUTE: Find annotations whose Id's match FindId.
OIX_ANNOTATION_HYPERTAG
OIX_ANNOTATION_BOOKMARKTAG
If FindId is used as a mask to find annotations, then any annotation for which Id & FindId = FindId will be removed. This parameter is required. If it is invalid then an error will be generated and the operation will abort.
lFindId: This parameter specifies which annotations to find in conjunction with the mask value. FindId must be a positive number if the value for the Mask parameter is OIX_ANNOTATION_MASK or OIX_ANNOTATION_ABSOLUTE. This parameter is required. If the value is invalid (a negative number with Mask of OIX_ANNOTATION_MASK or OIX_ANNOTATION_ABSOLUTE), an error will be generated and the operation will abort.
SearchPos: Indicates the starting position for the search as a position object. This parameter is not required. If no value is passed, then the starting position will be the start of the document. If the value is invalid, then an error will be generated and the operation will abort.
For finding previous or next annotations, an updated SearchPos must be provided as a starting position.
Related to
SCCVW_FINDANNOTATION (Outside In Viewer)
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
StartPos: Use this Position object to determine where to start from.
DestPos: The Position object that will be set by this method.
iFindMethod: How to find the position used to set the DestPos. The follow values are valid:
SCCVW_FINDFIRSTPOS: Find the first position in the current section (page).
SCCVW_FINDLASTPOS: Find the last position in the current section (page).
SCCVW_FINDPREVPOS: Find the position in the document that appears before the position identified by StartPos.
SCCVW_FINDNEXTPOS: Find the position in the document that appears after the position identified by StartPos.
SCCVW_FINDANCHORSELECTPOS: Find the position in the document that identifies the start of the current selection.
SCCVW_FINDENDSELECTPOS: Find the position in the document that identifies the end of the current selection.
SCCVW_FINDSTARTDISPLAYPOS: Find the position in the document that identifies the top/left most position in the currently displayed area.
SCCVW_FINDENDDISPLAYPOS: Find the position it the document that identifies the bottom/right most position in the currently displayed area.
SCCVW_FINDSTARTLINEPOS: Find the position in the document that identifies the start of the line that contains StartPos.
SCCVW_FINDENDLINEPOS: Find the position in the document that identifies the end of the line that contains StartPos.
SCCVW_FINDPREVLINEPOS: Find the position in the document that identifies the start of the line previous to the line that contains StartPos.
SCCVW_FINDNEXTLINEPOS: Find the position in the document that identifies the start of the line following the line that contains StartPos.
SCCVW_FINDPREVWORDPOS: Find the position in the document that identifies the start of the word previous to StartPos.
SCCVW_FINDNEXTWORDPOS: Find the position in the document that identifies the start of the word that follows StartPos.
SCCVW_FINDPREVSECTION: Find the section previous to the current position.
SCCVW_FINDNEXTSECTION: Find the section that follows the current section.
SCCVW_FINDPREVSELECTPOS: Find the position in the document that identifies the previous selected node when there are multiple selections (Archive files only).
SCCVW_FINDNEXTSELECTPOS:Find the the position in the document that identifies the next selected node when there are multiple selections (Archive files only).
Related to
SCCVW_FINDPOSITION (Outside In Viewer)
This method will return the actual character count when passed a position object.
Usage
long GetActualCount(OixPos Position)
Returns
Long
Parameters
Position: This is a position object. It needs to be an allocated object, not an object reference.
Related to
SCCVW_MAPPOSITION (Outside In Viewer)
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
lId: This is the Id of the annotation. If the annotation type is User, then this is the Id of that was used to add the annotation. For URL and Bookmark types, this number is the zero-based index of the URLs/Bookmarks in the file. This parameter is required. Any value will be accepted.
iAnnotationType: This is the type of annotation to get. The following values are valid:
ADTYPE_NODATA: User
ADTYPE_URL: URL
ADTYPE_BOOKMARK: Bookmark
Related to
SCCVW_GETANNOTATIONDATA (Outside In Viewer)
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
bVisible: Flag indicating whether information about a header that is visible (rendered) or invisible is being requested.
lHeaderID: Either the ID of a predefined email header field (SCCCA_MAIL_*) or an identifer between NONSTANDARD_HEADER_ID_BASE and NONSTANDARD_HEADER_ID_TOP for tracking a user-defined header.
lSubType: The type(s) of documents in which to either show or hide this header. These can be joined with a bitwise OR operator. Available subtypes are:
SCCUT_MAILTYPE_EMAIL
SCCUT_MAILTYPE_JOURNAL
SCCUT_MAILTYPE_CONTACT
SCCUT_MAILTYPE_NOTE
SCCUT_MAILTYPE_APPOINTMENT
SCCUT_MAILTYPE_TASK
SCCUT_MAILTYPE_POST
SCCUT_MAILTYPE_DISTROLIST
strMimeHeaderName : A Unicode string containing the value of a user-specified MIME header name.
strMimeHeaderLabel: Unicode string that will be used as the label for a user-defined MIME header. This value is only used for user-defined headers.
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)
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
TRUE: Indicates Success
FALSE: The Draw Page Info could not be calculated
Parameters
lPageNumber: This is the zero-based number of the page to get information about. This parameter is required. An invalid value will cause an error and the operation will abort.
iUnitsPerInch: This is the number of units per inch that PageFormatWidth and PageFormatHeight will be returned in. This parameter is required. An invalid (less than 1) value will cause an error and the operation will abort.
hOutputDC: This is a handle to the device context to draw into. This parameter is required and an invalid value will cause an error.
hFormatDC: This is a handle to a device (or information) context used to wrap text and retrieve other formatting information. This may not be the same as hOutputDC. This parameter is required and an invalid value will cause an error.
Related to
SCCVW_GETDRAWPAGEINFO (Outside In Viewer)
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
lPropMode: One of the following:
SCCVW_GETPROP_FIRST: Retrieves the information for the first property generated by the filter.
SCCVW_GETPROP_NEXT: Retrieves the information for the next property generated by the filter.
SCCVW_GETPROP_PREV: Retrieves the information for the next property generated by the filter.
SCCVW_GETPROP_BYID: Retrieves the information (if any) for a property specified in the structure. Values are specified in the header files as SCCCA_*. User defined properties can not be specified.
SCCVW_GETPROP_BYINDEX: Retrieves a property specified by a zero-based index from the property array.
pPropName : Pointer to string containing Property Name. This pointer needs to be freed if applicable.
pPropData : Pointer to string containing Property Value. This pointer needs to be freed if applicable.
lPropId : The property index or ID - required if retrieving by ID or index.
Related to
SCCID_GETPROPERTY(Outside In Viewer)
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
lTextOffset: Set this to the actual character count, 0 based from the beginning of the document, that defines the raw text buffer being requested. This parameter is required. Invalid values will always cause the method to return FALSE.
Related to
SCCVW_GETRAWTEXT (Outside In Viewer)
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
iFindType: Indicates the type of GoToAnnotation operation to be performed. The following values are valid:
OIX_GOTOFIRST: Goto first or only matching annotation.
OIX_GOTOLAST: Goto last or only matching annotation.
OIX_GOTOPREV: Goto previous matching annotation.
OIX_GOTONEXT: Goto next matching annotation.
This parameter is required. If the value is invalid, then the method will generate an Error event (see Section A.4.7, "Error") and the operation will abort.
iMask: Indicates how the annotations will be matched. The following values are valid:
OIX_ANNOTATION_ALL: Find all annotations - this includes internal annotations.
OIX_MASK: Use FindId as a mask to find annotations.
OIX_ABSOLUTE: Find annotations whose Id's match FindId.
OIX_ANNOTATION_HYPERTAG
OIX_ANNOTATION_BOOKMARKTAG
If FindId is used as a mask to find annotations, then any annotation for which Id & FindId = FindId will be removed. This parameter is required. If it is invalid then an error will be fired and operation will abort.
lFindId: This parameter specifies which annotations to goto in conjunction with the mask value.
Related to
SCCVW_GOTOANNOTATION (Outside In Viewer)
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
lStyleId: A unique ID for this style that can be used when adding highlight annotations with the AddAnnotationHilite method. This parameter is required. A negative value will result in an error.
lOptions: This parameter defines the options that are being set with this method. The following values may be OR-ed together. This parameter is required. There are no invalid values.
SCCVW_USEFOREGROUND: Use the ForeColor parameter to set the style.
SCCVW_USEBACKGROUND: Use the BackColor parameter to set the style.
SCCVW_USECHARATTR: Use the CharAttr parameter to set the style.
dwForeColor: The color to use for the foreground of the hilited area. The parameter is required and there are no invalid values.
dwBackColor: The color to use for the background of the hilited area. The parameter is required and there are no invalid values.
iCharAttr: Defines the font attribute to be used for the highlight text if CharAttr was specified in the Options parameter. The valid values for CharAttr are listed in the header files.
Related to
SCCVW_HILITESTYLE (Outside In Viewer)
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
0: Indicates success (ERROR_SUCCESS)
>0: Indicates failure, lPosition out of HScroll range (ERROR_INVALID_SCROLLBAR_RANGE)
Parameters
dwScrollOp: May be one of the following values:
SCCSB_LINELEFT: Scroll one line left
SCCSB_LINERIGHT: Scroll one line right
SCCSB_PAGELEFT: Scroll one page left
SCCSB_PAGERIGHT: Scroll one page right
SCCSB_POSITION: Scroll to an absolute position
lPosition: If dwScrollOp = SB_THUMBPOSITION, this parameter contains the absolute position to scroll to.
Related to
SCCVW_HSCROLL (Outside In Viewer)
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
HModule: The instance handle of the .dll or .exe module containing the bitmap resource.
ResID: The resource ID of the bitmap resource.
Related to
SCCVW_SETIDLEBITMAP (Outside In Viewer)
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
bShow: If this is set to TRUE, then the image is shown full screen. If this is set to FALSE, then the image is shown normally. The parameter is required.
Related to
SCCID_VECSHOWFULLSCREEN, SCCID_BMPSHOWFULLSCREEN (Outside In Viewer)
This method is used to zoom the image.
Usage
Void ImgZoom (short iZoomType)
Returns
Void
Parameters
iZoomType: This parameter indicates what kind of zoom operation to perform on the image. The valid options are:
SCCVW_ZOOM_NOP: Zoom to percent set in ImgX(&Y)ZoomPercent properties
SCCVW_ZOOM_IN: Zooms In
SCCVW_ZOOM_OUT: Zooms Out
SCCVW_ZOOM_SELECTION: Zooms to the current selection
SCCVW_ZOOM_RESET: Restores the display to its original state (as determined by BMPFitMode and VecFitMode)
The parameter is required. An invalid value will result in an error.
Related to
SCCID_VECZOOMEVENT, SCCID_BMPZOOMEVENT (Outside In Viewer)
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
TRUE: Indicates Success
FALSE: Indicates Error (fires Error Event)
Related to
SCCVW_INITDRAWPAGE (Outside In Viewer)
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:
PrintCollate
PrintCopies
PrinterDC
PrinterDriver
PrinterName
PrinterPort
PrintFont
PrintMarginLeft, Right, Top, Bottom
WhatToPrint
Usage
Void PrintOI ( BOOL bDoSetupDialog, ULONG dwFlags, BOOL bDoAbortDialog, BOOL bStartDocAlreadyDone)
Returns
Void
Parameters
bDoSetupDialog: If TRUE, the Windows Print Setup common dialog appears before printing.
dwFlags: These flags determine if and how the print properties will be used. This parameter may have any of the following values OR-ed together:
USECOLLATE 0x00000200: Use the value of the PrintCollate property.
USECOPIES 0x00000400: Use the value of the PrintCopies property.
USEPRINTERDC 0x00000001: Use the device handle stored in PrinterDC (see Section A.2.66, "PrinterDC") as the output device instead of the default printer.
USEPRINTERNAME 0x00000002: If USEPRINTERDC is not set, use PrinterName, PrinterPort, and PrinterDriver as the output device (see Section A.2.68, "PrinterName," Section A.2.69, "PrinterPort," and Section A.2.67, "PrinterDriver") instead of the default printer. If USEPRINTERDC is set, PrinterName, PrinterPort, and PrinterDriver are used for display in the standard Abort dialog.
USEABORTPROC 0x00000080: Fire the PrinterAbort event (see Section A.4.20, "PrinterAbort") instead of using the default Windows abort procedure.
USEPRINTHEADER: Print a header containing the page number and the text specified in the PrintJobName property.
bDoAbortDialog: If TRUE, an abort dialog will be displayed with page numbers while the file is being printed.
bStartDocAlreadyDone: This needs to be set only if the USEPRINTERDC flag is set. This parameter tells the viewer that a StartDoc has already been called for the printer device context (DC). The viewer will not do a StartDoc or EndDoc itself, assuming that the developer will call these functions.
Related to
SCCVW_PRINTEX (Outside In Viewer)
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)
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)
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
0: If the search string was found
-1: If an error occurred
1: If the search reached either end of the file before finding the search string
Parameters
bDialog: If Dialog is set to TRUE, then a search dialog will be displayed for user input. The search dialog is initialized from the other parameters. The SearchFrom parameter will be ignored and the search will take place from the current position if the dialog is used. If Dialog is set to FALSE, then the search will start without displaying a dialog. This parameter is required and does not have any invalid values.
szSearchText: The text to search for. This parameter is required and will produce an error event if it is invalid.
iSearchType: This parameter indicates whether the search should be case sensitive or not. The valid values are:
SCCVW_SEARCHCASE: Case-sensitive search
SCCVW_SEARCHNOCASE: Case-insensitive search
The parameter is required and will produce an error event if it is invalid.
iSearchFrom: This parameter tells the control where to start the search. The parameter will be ignored if the search dialog is used. When the dialog is used, the search always starts from the current caret position. The valid values are:
SCCVW_SEARCHTOP: Search From Top
SCCVW_SEARCHBOTTOM: Search From Bottom
SCCVW_SEARCHCURRENT: Search From Current Caret Position
The parameter is required and will produce an error event if it is invalid.
ISearchDirection: This parameter indicates in which direction to perform the search. The valid values are:
SCCVW_SEARCHFORWARD: Search forward
SCCVW_SEARCHBACK: Search backward
The parameter is required and will produce an error if it is invalid.
Related to
SCCVW_SEARCH, SCCVW_SEARCHDIALOG (Outside In Viewer)
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
0: If the search string was found
-1: If an error occurred
1: If the search reached either end of the file before finding the search string
Parameters
ISearchDirection: This parameter indicates in which direction to perform the search. The valid values are:
SCCVW_SEARCHSAME: Search in same direction as original search
SCCVW_SEARCHFORWARD: Search forward
SCCVW_SEARCHBACK: Search backward
The parameter is required and will produce an error if it is invalid.
Related to
SCCVW_SEARCHNEXT (Outside In Viewer)
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)
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
Position: This is a position object. It needs to be an allocated object, not an object reference.
Count: This is the actual character count to set the Position object to.
Related to
SCCVW_MAPPOSITION (Outside In Viewer)
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
bVisible: Flag indicating whether the header that is visible (rendered) or hidden.
lHeaderID: Either the ID of a predefined email header field (SCCCA_MAIL_*) or an identifer between NONSTANDARD_HEADER_ID_BASE and NONSTANDARD_HEADER_ID_TOP for tracking a user-defined header.
lSubType: The type(s) of documents in which to either show or hide this header. These can be joined with a bitwise OR operator. Available subtypes are:
SCCUT_MAILTYPE_EMAIL
SCCUT_MAILTYPE_JOURNAL
SCCUT_MAILTYPE_CONTACT
SCCUT_MAILTYPE_NOTE
SCCUT_MAILTYPE_APPOINTMENT
SCCUT_MAILTYPE_TASK
SCCUT_MAILTYPE_POST
SCCUT_MAILTYPE_DISTROLIST
strMimeHeaderName : A Unicode string containing the value of a user-specified MIME header name.
strMimeHeaderLabel: Unicode string that will be used as the label for a user-defined MIME header. This value is only used for user-defined headers.
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)
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
Position: This is the Position object to set to the current location of the caret.
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
StartPos: This is the Position object that will be set to the location of the beginning of the current selection. If there is no current selection, it will be set to the beginning of the document.
EndPos: This is the Position object that will be set to the location of the end of the current selection. If there is no current selection, it will be set to the end of the document.
Related to
SCCVW_DISPLAYPOSITION (Outside In Viewer)
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 Section A.2.98, "SystemTimer") has been set to FALSE.
Usage
SystemIdle()
Related to
SCCVW_IDLE (Outside In Viewer)
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
TRUE: Indicates success
FALSE: The file could not be viewed
Parameters
bDialog: If this parameter is TRUE, then a View File dialog will be displayed by the control. The file selected from this dialog will then be viewed. If FALSE, then no dialog will be displayed and the file specified by the szFileSpec parameter will be viewed. This parameter is required. There are no invalid values. Note that no dialog will appear if the iSpecType parameter is IOTYPE_REDIRECT.
FileSpec: This is the fully qualified path of the file to be viewed. If the Dialog parameter has been set to TRUE, then the specification passed in this parameter will be used to initialize the View File dialog. This parameter is required. If the bDialog parameter is set to FALSE and the path is invalid, then an error will be produced. If the bDialog parameter is true, then there are no invalid values from the szFileSpec. If the FileSpec type is "IO Redirect," then the FileSpec will represent some sort of user data that identifies the data to import.
iSpecType: This indicates what kind of information is in the FileSpec. The valid values are:
IOTYPE_OEMPATH
IOTYPE_UNICODEPATH
IOTYPE_REDIRECT
iViewAs: Indicates which format to force the file to be viewed in. The valid formats are:
FI_ANSI: Display as text and assume the ANSI character set.
FI_ANSI8: Display as text and assume the ANSI character set. Ignore characters over 0x7F.
FI_ASCII: Display as text and assume the PC character set.
FI_ASCII8: Display as text and assume the PC character set. Ignore characters over 0x7F.
FI_MAC: Display as text and assume the MAC character set.
FI_MAC8: Display as text and assume the MAC character set. Ignore characters over 0x7F.
FI_UNICODE: Display as text and assume the Unicode character set.
FI_HEX: Display as hexadecimal.
FI_SHIFTJIS: Display as text and assume the Japanese ShiftJis character set.
FI_CHINESEGB: Display as text and assume the Chinese GB character set.
FI_HANGEUL: Display as text and assume the Korean Hangeul character set.
FI_CHINESEBIG5: Display as text and assume the Chinese big 5 character set.
Invalid values default to 0.
bUseDisplayName: If TRUE, then use the display name that follows. Otherwise, the control will generate a display name based on the file name. There are no invalid values. If this parameter is set to true and DisplayName is not passed, then an error will occur.
szDisplayName: The name to be used for the file, should it be displayed. If the bUseDisplayName parameter is true, then this value will be used as the name of the file. If the bUseDisplayName parameter is FALSE, then this parameter will be ignored.
bDeleteOnClose: Set this parameter to true if the file being viewed should be deleted after the control is finished viewing it.
pIoRedir: If iSpecType is "IO Redirect," this parameter represents user data that will be passed to all of the Redirected IO events.
Related to
SCCVW_VIEWFILE (Outside In Viewer)
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
0: Indicates success (ERROR_SUCCESS)
>0: Indicates failure, lPosition out of VScroll range (ERROR_INVALID_SCROLLBAR_RANGE)
Parameters
dwScrollOp: May be one of the following values:
SCCSB_LINEUP: Scroll one line up
SCCSB_BOTTOM: Scroll to bottom of page
SCCSB_LINEDOWN: Scroll one line down
SCCSB_PAGEUP: Scroll one view window page up
SCCSB_PAGEDOWN: Scroll one view window page down
SCCSB_NEXTDOCPAGE: Scroll to the beginning of the next document page or section
SCCSB_PREVDOCPAGE: Scroll to the beginning of the previous document page or section
SCCSB_TOP: Scroll to top of page
SCCSB_POSITION: Scroll to an absolute position
lPosition: If dwScrollOp = SB_THUMBPOSITION, this parameter contains the absolute position to scroll to.
Related to
SCCVW_VSCROLL (Outside In Viewer)
The following events occur during actions.
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
lEvent: Passes the action that triggered the event. See Section A.3.2, "AddAnnotationHilite," or Section A.3.4, "AddAnnotationPicture" for valid values.
lId: Unique positive number that indicates which annotation fired the event.
varData: Data value associated with the annotation.
Related to
SCCVW_ANNOTATIONEVENT (Outside In Viewer)
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
FileSpec: Contains the file specification passed to the ViewFile method in the FileSpec parameter.
varData: Contains the variable passed to the ViewFile method in the Redirect parameters.
varFile: This contains the variant set by the developer in the Open event.
pResult: This developer sets this variable to return the result of the operation.
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 Section A.2.32, "DoContextMenu") for information on disabling the built-in context menu.
Usage
ContextMenu ( int iXPos, int iYPos )
Parameters
int iXPos: x coordinate of right mouse click
int iYPos: y coordinate of right mouse click
Related to
SCCVW_CONTEXTMENU (Outside In Viewer)
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)
This event is generated whenever a help button has been pressed in one of the control's dialogs.
Usage
DoHelp(SHORT iDialog)
Parameters
iDialog: This parameter is a number that identifies the dialog box in which the help button has been pressed. The possible values are as follows:
SCCID_DISPLAYOPTIONSDIALOG: Display Options Dialog
SCCID_DISPLAYMOREDIALOG: Display More Dialog
SCCID_PRINTOPTIONSDIALOG: Print Options Dialog
SCCID_PRINTMOREDIALOG: Print More Dialog
SCCID_CLIPBOARDOPTIONSDIALOG: Clipboard Options Dialog
SCCID_CLIPBOARDMOREDIALOG: Clipboard More Dialog
SCCID_PRINTDIALOG: Print Dialog
SCCID_PRINTSETUPDIALOG: Print Setup Dialog
SCCID_SELECTFONTDIALOG: Select Font Dialog
Related to
SCCVW_DOHELP (Outside In Viewer)
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
bEnable: If TRUE, then the developer application should be enabled. If FALSE, then the developer application should be disabled.
iReturn: If the developer handles the enable/disable, return 24. If the default enable/disable behavior is desired, return 0.
Related to
SCCVW_ENABLEAPP (Outside In Viewer)
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 Section A.2.36, "ErrorCode," and Section A.2.37, "ErrorMsg") will be filled with the appropriate values. This event is generated regardless of the state of ErrorShowMsg (see Section A.2.38, "ErrorShowMsg").
Usage
Error()
Related to
SCCVW_BAILOUT (Outside In Viewer)
This event is generated when the file being viewed is changed, such as with a ViewFile or Clear method (see Section A.3.46, "ViewFile," and Section A.3.7, "Clear"). The FileInfo properties will be updated at the same time.
Usage
FileChange (BOOL bOpen, BOOL bOpenFollowing)
Parameters
bOpen: If TRUE, indicates that the file is being opened. Otherwise, the file is being closed.
bOpenFollowing: If the file is being closed because another file is being opened, then the OpenFollowing parameter will be TRUE. If this is the case, then another FileChange event should be coming immediately.
Related to
SCCVW_FILECHANGE (Outside In Viewer)
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 Section A.3.46, "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
FileSpec: Contains the file specification passed to the ViewFile FileSpec parameter.
varData: Contains the variable passed to the ViewFile method in the Redirect parameters.
varFile: This contains the variant set by the developer in the Open event.
FileName: The file name of the secondary file to be opened.
pFileSpec: The file specification to be used to open the secondary file.
SpecType: The type of file specification contained in pFileSpec.
pvarData: The user data for the file as would be passed to the Redirect parameter of the ViewFile method.
pResult: This developer sets this variable to return the result of the operation.
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
FileName: The filename of the file whose credentials are being requested.
lRequestID: The ID of the information being requested. This can be one of the following values:
OIT_FILEACCESS_PASSWORD – Requesting the password of the file
OIT_FILEACCESS_NOTESID – Requesting the notes ID file location
lAttemptNumber: The number of times the information has already been requested for the currently requested item.
lMaxLength: The size of the buffer provided for the credentials information.
pStrCredentials : Buffer to hold the information. For the 2 RequestIDs currently supported, this is a string buffer.
pResult : The developer sets this variable to return the result of the operation.
SCCERR_OK: Tells Outside In that the requested information is provided.
SCCERR_CANCEL: Tells Outside In that the requested information is not available.
Note:
Not all formats that use passwords are supported. Only Microsoft Office binary (97-2003), Microsoft Office 2007, Lotus NSF, PDF (with RC4 & AES 128-bit encryption), and Zip (with AES 128- & 256-bit, ZipCrypto) are currently supported.
Usage
GetInfo(VARIANT FileSpec, VARIANT varData, VARIANT varFile, long InfoId, VARIANT *pInfo, long *pResult)
Parameters
FileSpec: Contains the file specification passed to the ViewFile method in the FileSpec parameter.
varData: Contains the variable passed to the ViewFile method in the Redirect parameters.
varFile: This contains the variant set by the developer in the Open event.
InfoId: A value that indicates what information needs to be returned. It indicates the action that the developer needs to take to respond to the event. The following values are valid:
IOGETINFO_FILENAME: The base file name (no path) of the open file has been requested. If the file name cannot be determined, then pResult should be assigned IOERR_UNKNOWN. However, if the file name can be determined; then the developer should assign pInfo the file name and pResult should be assigned IOERR_OK.
IOGETINFO_PATHNAME: The fully qualified file path (including the file name) of the open file has been requested. If the file path cannot be determined, then pResult should be assigned IOERR_UNKNOWN. However, if the file path can be determined; then the developer should assign pInfo the file name and pResult should be assigned IOERR_OK.
IOGETINFO_ISOLE2STORAGE: The value IOERR_FALSE should be assigned to pResult.
For other values for InfoId, the value IOERR_BADINFOID should be assigned to pResult.
pInfo: The developer needs to assign the requested information (identified by InfoId) to this parameter.
pResult: The developer sets this variable to return the result of the operation.
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
pStrTechPath : Buffer to hold the new technology path. This is a string buffer.
pResult: The developer sets this variable to return the result of the operation.
SCCERR_OK: Tells Outside In that a new technology path is to be used
SCCERR_CANCEL: Tells Outside In that the registry entry FilterPath is to be used.
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
int iPageSize: Value of the new thumb size
Related
SCCVW_SETHSCROLLPAGESIZE (Outside In Viewer)
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
LONG lPosition: New absolute position of the scroll bar.
Related to
SCCVW_SETHSCROLLPOSITION (Outside In Viewer)
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
int iMin: New minimum position for scroll bar
int iMax: New maximum position for scroll bar
Related to
SCCVW_SETHSCROLLRANGE (Outside In Viewer)
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
BOOL bEnabled: State of horizontal scroll bar
Related to
SCCVW_SETHSCROLLSTATE (Outside In Viewer)
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
int iVKey: Virtual key code for the key pressed
Related to
SCCVW_KEYDOWN (Outside In Viewer)
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
FileSpec: Contains the file specification passed to the ViewFile method in the FileSpec parameter.
VarData: Contains the variable passed to the ViewFile method in the Redirect parameters.
pvarFile: The developer needs to set this variable to whatever information is generated by opening the file (for example, a handle).
pResult: This developer sets this variable to return the result of the operation.
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
iOptionId: The Id number of the option that changed. The possible values are included in the header files.
Related to
SCCVW_OPTIONCHANGE (Outside In Viewer)
When the USEABORTPROC flag is set in the PrintOI method (see Section A.3.35, "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
hDC: Identifies the device context for the print job.
iError: Specifies whether an error has occurred. This parameter is zero if no error has occurred; it is SP_OUTOFDISK if Windows Print Manager is currently out of disk space and more disk space will become available if the application waits.
bContinue: The developer must set this value to TRUE to continue the print job, or FALSE to abort the print job.
Related to
SCCVW_PRINTEX (Outside In Viewer)
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 Section A.4.21, "RawTextEvent") contains a text offset of -1 to indicate it is done extracting text from the file. Use the GetRawText method (see Section A.3.27, "GetRawText") to retrieve the text buffer.
Usage
Void RawTextEvent(long lTextOffset)
Parameters
lTextOffset: The 0-based offset of the next block of raw text available from the control. Pass this parameter to GetRawText (see Section A.3.27, "GetRawText") to set the RawText properties to this new block.
Related to
SCCVW_RAWTEXTEVENT (Outside In Viewer)
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
FileSpec: Contains the file specification passed to the ViewFile method in the FileSpec parameter.
varData: Contains the variable passed to the ViewFile method in the Redirect parameters.
varFile: This contains the variant set by the developer in the Open event.
pData: Variable that needs to be assigned a SAFEARRAY of bytes that contains the requested data.
Size: The amount of data to be read.
pCount: The actual count of bytes read.
pResult: This developer sets this variable to return the result of the operation.
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()
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
FileSpec: Contains the file specification passed to the ViewFile method in the FileSpec parameter.
varData: Contains the variable passed to the ViewFile method in the Redirect parameters.
varFile: This contains the variant set by the developer in the Open event.
From: This value indicates the starting point for moving the file pointer. The values are:
IOSEEK_TOP: Move the file position Offset bytes from the top of the file.
IOSEEK_BOTTOM: Move the file position Offset bytes from the bottom of the file.
IOSEEK_CURRENT: Move the file position Offset bytes from the current file position.
Offset: The number of bytes to move the file pointer. A positive value moves the file pointer forward in the file and a negative value moves the file pointer backward.
pResult: The developer sets this variable to return the result of the operation.
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)
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)
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
FileSpec: Contains the file specification passed to the ViewFile method in the FileSpec parameter.
varData: Contains the variable passed to the ViewFile method in the Redirect parameters.
varFile: This contains the variant set by the developer in the Open event.
pOffset: This parameter is assigned the current file position.
pResult: This developer sets this variable to return the result of the operation.
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 Section A.3.46, "ViewFile") with the same view window when handling the ViewThisFile event (see Section A.4.28, "ViewThisFile").
Usage
ViewThisFile(VARIANT FileSpec, SHORT iSpecType, SHORT *iReturn)
Parameters
szFileSpec: Contains the file specification for the new file. This specification may be passed to the ViewFile method to view the file.
iSpecType: The type of file spec information contained in the FileSpec variable. See the ViewFile method for more information.
iReturn: The developer must set this value to indicate whether the file is viewed or not.
Related to
SCCVW_VIEWTHISFILE (Outside In Viewer)
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
int iPageSize: New size of vertical page
Related to
SCCVW_SETVSCROLLPAGESIZE (Outside In Viewer)
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
LONG lPosition: New absolute position of the scroll bar.
Related to
SCCVW_SETVSCROLLPOSITION (Outside In Viewer)
Usage
VScrollRangeMin(long lRangeMin)
Parameters
long lRangeMin : New minimum position for scroll bar.
Related to
SCCVW_SETVSCROLLRANGEMIN (Outside In Viewer)
Usage
VScrollRangeMax(long lRangeMax)
Parameters
long lRangeMax : New maximum position for scroll bar.
Related to
SCCVW_SETVSCROLLRANGEMAX (Outside In Viewer)
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
BOOL bEnabled: State of vertical scroll bar
Related to
SCCVW_SETVSCROLLSTATE (Outside In Viewer)
|
 Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
