| Oracle® Outside In Viewer Developer's Guide Release 8.4.0 Part Number E12845-03 |
|
|
View PDF |
| Oracle® Outside In Viewer Developer's Guide Release 8.4.0 Part Number E12845-03 |
|
|
View PDF |
All SCCID values are VTDWORDs (4 bytes long).
Options are parameters affecting the behavior of the Viewer. These options are available to the developer when using Viewer.
The following character mappings are used.
This option is used in cases where Oracle Outside In cannot determine the character set used to encode the text of an input file. When all other means of determining the file's character set are exhausted, Oracle 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. The possible character sets are listed in charsets.h.
When "extended test for text" is enabled (see Section B.2.2, "SCCID_FIFLAGS"), this option will still apply to plain-text input files that are not identified as EBCDIC or Unicode.
This option supersedes the SCCOPT_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 SCCOPT_FALLBACKFORMAT, though internally such values will be translated into equivalent values for the SCCOPT_DEFAULTINPUTCHARSET. As a result, if an application were to set both options, the last such value set for either option will be the value that takes effect.
Scope
Global
Data Type
VTDWORD
Default
CS_SYSTEMDEFAULT: Query the operating system.
Data
The data types are listed in charsets.h.
When the Oracle Outside In Viewer Technology is displaying a character and cannot find that character in any font on the system, it will display a replacement character. This value is the Unicode value for this character. The default value for this character is 0x002a "*".
Scope
Local
Data Type
VTWORD
Data
The Unicode value for the character to use.
Default
0x002a = "*"
The following sections pertain to input handling.
This option controls how files are handled when their specific application type cannot be determined. This normally affects all plain-text files, because plain-text files are generally identified by process of elimination, for example, when a file isn't identified as having been created by a known application, it is treated as a plain-text file.
Note:
A number of values that were formerly allowed for this option have been deprecated. Specifically, the values that selected specific plain-text character sets are no longer to be used. Instead, applications should use the SCCID_DEFAULTINPUTCHARSET option for such functionality.
Scope
Global
Data Type
VTDWORD
Data
The high VTWORD of this value is reserved and should be set to 0, and the low VTWORD must have one of the following values:
FI_TEXT: Unidentified file types will be treated as text files.
FI_NONE: Oracle Outside In will not attempt to process files whose type cannot be identified. This will include text files. When this option is selected, an attempt to process a file of unidentified type will cause Oracle Outside In to return an error value of DAERR_FILTERNOTAVAIL (or SCCERR_NOFILTER).
Default
FI_TEXT
This option affects how an input file's internal format (application type) is identified when the file is first opened by the Oracle Outside In technology. When the extended test flag is in effect, and an input file is identified as being either 7-bit ASCII, EBCDIC, or Unicode, the file's contents will be interpreted as such by the viewing process.
The extended test is optional because it requires extra processing and cannot guarantee complete accuracy (which would require the inspection of every single byte in a file to eliminate false positives.)
Scope
Global
Data Type
VTDWORD
Data
One of the following values:
SCCVW_FI_NORMAL: This is the default value. When this is set, standard file identification behavior occurs.
SCCVW_FI_EXTENDEDTEST: If set, the File Identification code will run an extended test on all files that are not identified.
Default
SCCUT_FI_NORMAL
This option allows the developer to set flags that span multiple Oracle Outside In products.
Scope
Local
Data Type
VTDWORD
Data
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
Default
0: All flags turned off
This option controls a number of miscellaneous interactions between the developer and the Outside In Technology.
Handle Type
VTHDOC
Scope
Local
Data Type
VTDWORD
Data
SCCVW_SYSTEM_UNICODE: This flag causes the strings in SCCDATREENODE to be returned in Unicode.
Default
0
This option allows the developer to specify the location of a Lotus Notes or Domino installation for use by the NSF filter. A valid Lotus installation directory must contain the file nnotes.dll.
Note:
Please see section 2.1.1 for NSF support on Win x86-32 or Win x86-64 or section 3.1.1 for NSF support on Linux x86-32 or Solaris Sparc 32.
Handle Types
NULL
Scope
Global
Data Type
VTLPBYTE
Data
A path to the Lotus Notes directory.
Default
If this option isn't set, then OIT will first attempt to load the Lotus library according to the operating system's PATH environment variable, and then attempt to find and load the Lotus library as indicated in HKEY_CLASSES_ROOT\Notes.Link.
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 enables parsing of the XMP data 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).
Scope
Local
Data Type
VTBOOL
Data
TRUE: This setting enables parsing XMP.
FALSE: This setting disables parsing XMP.
Default
FALSE
This option controls whether or not the PDF filter will attempt to reorder bidirectional text runs so that the output is in standard logical order as used by the Unicode 2.0 and later specification. This additional processing will result in slower filter performance according to the amount of bidirectional data in the file.
Scope
Global
Data Type
VTDWORD
Data
SCCUT_FILTER_STANDARD_BIDI
SCCUT_FILTER_REORDERED_BIDI
Default
SCCUT_FILTER_STANDARD_BIDI
This option allows the user to define an offset to GMT that will be applied during date formatting, allowing date values to be displayed in a selectable time zone. This option affects the formatting of numbers that have been defined as date values (e.g., most dates in spreadsheet cells). This option will not affect dates that are stored as text.
Note:
This option does not apply for spreadsheet files.
Scope
Global
Data Type
VTLONG
Data
Integer parameter from -96 to 96, representing 15-minute offsets from GMT. To query the operating system for the time zone set on the machine, specify SCC_TIMEZONE_USENATIVE.
Default
0: GMT time
Some HTML includes a special type of comment that will be read by particular versions of browsers or other products. This option allows you to control which of those comments are included in the output.
Handle Type
VTHDOC
Scope
Local
Data Type
VTDWORD
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
The following information pertains to compression.
This option can disable access to any files using JPEG compression, such as JPG graphic files or TIFF files using JPEG compression, or files with embedded JPEG graphics. Attempts to read such files when this option is enabled will fail and return the error SCCERR_UNSUPPORTEDCOMPRESSION if the entire file is JPEG compressed, and grey boxes for embedded JPEG-compressed graphics Unlike many other options, this option must be set programmatically, as it is not stored or read on startup.
The following is a list of file types affected when this option is disabled:
JPG files
Postscript files containing JPG images
PDFs containing JPEG images
Scope
Local
Data Type
VTDWORD
Data
SCCVW_FILTER_JPG_ENABLED: Allow access to files that use JPEG compression
SCCVW_FILTER_JPG_DISABLED: Do not allow access to files that use JPEG compression
Default
SCCVW_FILTER_JPG_ENABLED
This option can disable access to any files using Lempel-Ziv-Welch (LZW) compression, such as .GIF files, .ZIP files or self-extracting archive (.EXE) files containing "shrunk" files. Attempts to read such files when this option is enabled will fail and return the error SCCERR_UNSUPPORTEDCOMPRESSION if the entire file is LZW compressed, and grey boxes for embedded LZW-compressed graphics. Unlike many other options, this option must be set programmatically, as it is not stored or read on startup.
The following is a list of file types affected when this option is disabled:
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
Note:
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.
Scope
Local
Data Type
VTDWORD
Data
SCCVW_FILTER_LZW_ENABLED: LZW compressed files will be read normally.
SCCVW_FILTER_LZW_DISABLED: LZW compressed files will not be read.
Default
SCCVW_FILTER_LZW_ENABLED
The following information pertains to spreadsheets and database file rendering.
This option controls the format the database data takes when copied to the clipboard.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_CLIPSUBFORMAT_TABLE: In clipboard formats that support it (RTF and Ami), the database selection will be copied as a table.
SCCVW_CLIPSUBFORMAT_TABS: The database selection will be copied using a tab stop for each field.
SCCVW_CLIPSUBFORMAT_OPTIMIZEDTABS: The database selection will be copied using a tab stop for each field, except when a field is empty.
If this option is TRUE, the display of a database includes a limited set of formatting information. If FALSE, the display includes all supported formatting.
Data Type
VTBOOL
Default
FALSE
If this option is TRUE, field headings will be copied to the clipboard along with the data.
Data Type
VTBOOL
Default
TRUE
This option scales a spreadsheet file to a certain percent or to a page width or height. However, in an effort to preserve readability after scaling, the Viewer Technology will not shrink a database document to under approximately one-third of its original size.
It should be noted that when this option is set to SCCVW_DBPRINTFITMODE_NOMAP, the pages of the database file are printed down first and then across.
Note:
Any margins applied as a result of settings for the SCCOPT_DEFAULTPRINTMARGINS option will be included in any scaling that is applied to the viewed image as a result of settings for this option.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_DBPRINTFITMODE_NOMAP: This will not do any scaling of the database image. It will render in its original size onto as many pages as are required to fit the data.
SCCVW_DBPRINTFITMODE_FITTOPAGES: This will fit the database to one page, scaling to the image width or height depending on the page size and database size.
SCCVW_DBPRINTFITMODE_FITTOWIDTH: This will scale the database on the rendered image so it is no larger than one page wide.
SCCVW_DBPRINTFITMODE_FITTOHEIGHT: This will scale the database on the rendered image so it is no larger than one page high.
Default
SCCVW_DBPRINTFITMODE_FITTOPAGES
If this option is TRUE, field headings will be printed along with the data.
Data Type
VTBOOL
If this option is TRUE, a dotted grid is displayed between fields.
Data Type
VTBOOL
This option controls the format the spreadsheet data takes when copied to the clipboard.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_CLIPSUBFORMAT_TABLE: In clipboard formats that support it (RTF & Ami), the spreadsheet selection will be copied as a table.
SCCVW_CLIPSUBFORMAT_TABS: The spreadsheet selection will be copied using a tab stop for each cell.
SCCVW_CLIPSUBFORMAT_OPTIMIZEDTABS: The spreadsheet selection will be copied using a tab stop for each cell, except when a cell is empty.
If this option is TRUE, the display of a spreadsheet includes a limited set of formatting information. If FALSE, the display includes all supported formatting.
Data Type
VTBOOL
This option controls the pattern in which the pages are printed, either across first and then down, or down first and then across.
This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and print direction is specified in the input document.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_SSPRINTDIRECTION_ACROSS: Will specify that pages are printed across first and then down.
SCCVW_SSPRINTDIRECTION_DOWN: Will specify that pages are printed down first and then across.
Default
SCCVW_SSPRINTDIRECTION_DOWN
This option requests that the spreadsheet file be fit to one page.
Note:
Any margins applied as a result of settings for the SCCID_DEFAULTPRINTMARGINS option will be included in any scaling that is applied to the output image as a result of settings for this option.
This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and fitting the page to the printer's image limits is specified in the input document.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_SSPRINTFITMODE_NOMAP: No scaling is performed on the spreadsheet image. It will render in its original size onto as many pages as are required to fit the data.
SCCVW_SSPRINTFITMODE_FITTOPAGES: Will scale the spreadsheet in the rendered image to fit to the number of pages specified in the SCCOPT_SSPRINTSCALEXHIGH and SCCOPT_SSPRINTSCALEXWIDE options. Since aspect ratio is maintained, the lesser of the two dimensions (width or height) will determine the scale factor. Note that if either SCCOPT_SSPRINTSCALEXHIGH or SCCOPT_SSPRINTSCALEXWIDE is set to 0, the value in the other option will be nullified.
SCCVW_SSPRINTFITMODE_FITTOWIDTH: Will scale the spreadsheet in the rendered image so it is no larger than one page wide.
SCCVW_SSPRINTFITMODE_FITTOHEIGHT: Will scale the spreadsheet in the rendered image so it is no larger than one page high.
SCCVW_SSPRINTFITMODE_SCALE: Will scale the spreadsheet in the rendered image using the scale value stored in the SCCOPT_SSPRINTSCALEPERCENT option.
Default
SCCVW_SSPRINTFITMODE_SCALE: Scales the rendered image of the spreadsheet using the scale value stored in the SCCOPT_SSPRINTSCALEPERCENT option (which is 100 by default).
If this option is TRUE, a dotted grid is printed between cells.
This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and printing grid lines between cells is specified in the input document.
Data Type
VTBOOL
If this option is TRUE, row and column headings will be printed along with the data.
This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and printing column and row headers is specified in the input document.
Data Type
VTBOOL
This option will scale spreadsheet pages by the percentage specified. The option has no effect unless the SCCID_SSPRINTFITTOPAGE option is set to SCCVW_SSPRINTFITMODE_SCALE.
This option must take a value between 1 and 100. If any value outside of this range is used, the option will be ignored.
Data Type
VTDWORD
This option will fit the spreadsheet image to the number of vertical pages specified. The setting for this option will have no effect unless the SCCID_SSPRINTFITTOPAGE option is set to SCCVW_SSPRINTFITMODE_FITTOPAGES.
Data Type
VTDWORD
This option will fit the spreadsheet image to the number of horizontal pages specified. The setting for this option will have no effect unless the SCCID_SSPRINTFITTOPAGE option is set to SCCVW_SSPRINTFITMODE_FITTOPAGES.
Data Type
VTDWORD
If this option is TRUE, blank spreadsheet pages will not be produced when printing a file or rendering it with the SCCVW_DRAWPAGE message.
Data Type
VTBOOL
If this option is TRUE, a dotted grid is displayed between cells.
Data Type
VTBOOL
This option lets you determine whether or not to show hidden rows or columns when rendering spreadsheets. This is a BOOLEAN option that will leave the data hidden when it is FALSE, and show all hidden rows and columns when it is TRUE, displayed using the default row width or default column height.
Data Type
VTBOOL
Default
FALSE
The following information pertains to graphics file rendering.
This option determines the way the viewer stretches bitmaps. Antialiased bitmaps may appear smoother and can be easier to read, but rendering when this option is set will require additional processing time.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_ANTIALIAS_OFF: Do not antialias bitmaps.
SCCVW_ANTIALIAS_ALL: Antialias all bitmaps.
This option tells the bitmap display engine to use a dithering algorithm on bitmaps with higher color resolution than the screen in order to get better color display. It can have the value SCCVW_DITHER_ON or SCCVW_DITHER_OFF.
Data Type
VTBOOL
This option is a read only option that indicates the bitmap display engine's ability to dither the current bitmap. For instance dithering is not possible or necessary for a 16-color bitmap on a 256-color display, but it is possible for a 256-color bitmap on a 16-color display.
Data Type
VTBOOL
This option sets the way the bitmap display engine stretches or shrinks a bitmap in relation to the size of the view window.
Data Type
VTDWORD
Data
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_ORIGINAL: The bitmap is displayed bit for bit on the screen, the size of the window has no effect.
SCCVW_FITMODE_WINDOW: The bitmap will be stretched to fill as much of the window as possible while maintaining its proper aspect ratio.
SCCVW_FITMODE_WINDOWHEIGHT: The bitmap will be stretched so its full height fits in the height of the window. Depending on the bitmap, 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. Depending on the bitmap, its full height may or may not fit inside the window.
This option indicates how the bitmap will be stretched when printed.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_PRINTASPECT_ORIGINAL: The bitmap 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 bitmap will be stretched horizontally and vertically to totally fill the area inside the print margins.
If set to TRUE, a 1-pixel border will be printed around bitmaps.
Data Type
VTBOOL
This option indicates how bitmaps should be rotated.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_ROTATION_NONE: Do not rotate the bitmap.
SCCVW_ROTATION_90: Rotate the bitmap 90 degrees clockwise.
SCCVW_ROTATION_180: Rotate the bitmap 180 degrees clockwise.
SCCVW_ROTATION_270: Rotate the bitmap 270 degrees clockwise.
These rotations are absolute from the initial state of the graphic.
This option indicates the X and Y ratios used to stretch/shrink the original image. For instance, setting the X ratio to 1 and the Y ratio to 2 displays the image pixel for pixel horizontally, but two display pixels for every one-bitmap pixel in the vertical direction.
Data Type
SCCVWIMAGEZOOM structure
This structure is used in the SCCID_BMPZOOM and SCCID_VECZOOM options.
SCCVWIMAGEZOOM is a C data structure defined in sccvw.h as follows.
typedef struct
{
VTDWORD dwXNu;
VTDWORD dwXDe;
VTDWORD dwYNu;
VTDWORD dwYDe;
} SCCVWIMAGEZOOM;
The image is zoomed in the X (horizontal) direction by a factor of dwXNu/dwXDe. The image is zoomed in the Y (vertical) direction by a factor of dwYNu/dwYDe.
This option acts like an event. Normally, its value is SCCVW_ZOOM_NOP.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_ZOOM_IN: Zooms in (more magnification).
SCCVW_ZOOM_OUT: Zooms out (less magnification).
SCCVW_ZOOM_SELECTION: Zooms to the current selection.
SCCVW_ZOOM_RESET: Restores the display to its original state (based on the value SCCID_BMPFITMODE).
This option sets the way the vector display engine stretches or shrinks an image in relation to the size of the view window.
Data Type
VTDWORD
Data
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_ORIGINAL: The image is displayed one bit on the screen for every unit in the images coordinate system, 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 image will be stretched so its full width fits in the width of the window. Depending on the image, its full height may or may not fit inside the window.
SCCVW_FITMODE_STRETCHWINDOW: The image will be stretched to fill the window. The images aspect ratio is not maintained.
This option indicates how the vector image will be stretched when printed.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_PRINTASPECT_ORIGINAL: The bitmap 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 bitmap will be stretched horizontally and vertically to totally fill the area inside the print margins.
If TRUE, the background of a vector image will be printed. If it is FALSE the background will not be printed.
Data Type
VTBOOL
If TRUE, a one-pixel border will be printed around vector images.
Data Type
VTBOOL
If TRUE, the background of a vector image will be displayed using as defined in the file. If it is FALSE the background will not be displayed.
Data Type
VTBOOL
Note:
This option is only valid on Windows systems.
This option acts like an event. Normally its value is FALSE, but when set to TRUE the image will be displayed using the entire screen until the user presses ESC.
The default value of this option has no meaning.
Data Type
VTBOOL
This option indicates the X and Y ratios used to stretch/shrink the original image. For instance, setting the X ratio to 1 and the Y ratio to 2 displays the image pixel for pixel horizontally but 2 display pixels for every one-bitmap pixel in the vertical direction.
Data Type
SCCVWIMAGEZOOM structure
This structure is used in the SCCID_BMPZOOM and SCCID_VECZOOM options.
SCCVWIMAGEZOOM is a C data structure defined in sccvw.h as follows:
typedef struct
{
VTDWORD dwXNu;
VTDWORD dwXDe;
VTDWORD dwYNu;
VTDWORD dwYDe;
} SCCVWIMAGEZOOM;
The image is zoomed in the X (horizontal) direction by a factor of dwXNu/dwXDe.
The image is zoomed in the Y (vertical) direction by a factor of dwYNu/dwYDe.
This option acts like an event. Normally, its value is SCCVW_ZOOM_NOP.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_ZOOM_IN: Zooms in (more magnification).
SCCVW_ZOOM_OUT: Zooms out (less magnification).
SCCVW_ZOOM_SELECTION: Zooms to the current selection.
SCCVW_ZOOM_RESET: Restores the display to its original state (based on the value SCCID_VECFITMODE).
The following information pertains to page rendering.
This option specifies the top, left, bottom and right margins in twips from the edges of the page. For instance, setting all the values to 1440 creates a 1-inch margin on all sides. Page margins will only be applied when formatting word processing, database and spreadsheet files.
Please note all margins are applied before scaling with the SCCID_SSPRINTFITTOPAGE or SCCID_SSPRINTFITTOPAGE options.
This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and print margins are specified in the input document.
This option does not affect the output of bitmap, presentation, vector or archive files.
Data Type
The SCCVWPRINTMARGINS structure.
This structure is used by the SCCID_DEFAULTPRINTMARGINS option to specify margin settings.
SCCVWPRINTMARGINS is a C data structure defined in sccvw.h as follows:
typedef struct SCCVWPRINTMARGINStag
{
VTDWORD dwTop;
VTDWORD dwBottom;
VTDWORD dwLeft;
VTDWORD dwRight;
} SCCVWPRINTMARGINS, * PSCCVWPRINTMARGINS;
Parameters
dwTop: Margin from the top edge of the page (in twips). Default is 1 inch.
dwBottom: Margin from the bottom edge of the page (in twips). Default is 1 inch.
dwLeft: Margin from the left edge of the page (in twips). Default is 1 inch.
dwRight: Margin from the right edge of the page (in twips). Default is 1 inch.
This option indicates the page that printing should end on. It is only valid if the option SCCID_WHATTOPRINT has the value SCCVW_PRINT_PAGERANGE.
Note:
Page range settings are one-based and inclusive. Therefore, specifying a range with SCCID_PRINTENDPAGE equal to 5 and SCCID_PRINTSTARTPAGE equal to 3 would print any of the three pages that follow, if they exist: 3, 4 and 5.
Data Type
VTDWORD
Default
0: The last page at the end of the document.
This option indicates the page printing should start on. It is only valid if the option SCCID_WHATTOPRINT has the value SCCVW_PRINT_PAGERANGE.
Note:
Page range settings are one-based and inclusive. Therefore, specifying a range with SCCID_PRINTENDPAGE equal to 5 and SCCID_PRINTSTARTPAGE equal to 3 would print any of the three pages that follow, if they exist: 3, 4 and 5.
Data Type
VTDWORD
This option is used to select the document's page layout information when printing.
If TRUE the document's native (or author selected) page margins, paper size, page scaling and page orientation are used when available from the filter.
The values of the SCCID_DEFAULTPRINTMARGINS, SCCID_SSPRINTGRIDLINES, SCCID_SSPRINTHEADINGS, SCCID_SSPRINTDIRECTION, and SCCID_SSPRINTFITTOPAGE options are overridden if this option is set to TRUE and the properties associated with those options are specified in the input document. Additionally, print area and page breaks in spreadsheet documents are ignored unless this option is set to TRUE.
If FALSE, the printer page margins, paper size, orientation and scaling are set to specific values rather than those in the native document. The page size is forced to 8 1/2" x 11" in portrait orientation, but this may be changed by setting the SCCOPT_GRAPHIC_HEIGHT and/or SCCOPT_GRAPHIC_WIDTH options. The margins are forced 1" all around, but may be changed by setting the SCCID_DEFAULTPRINTMARGINS option. The scaling for the document will be set to 100%, although this may be changed by setting any of the various scaling options.
Data Type
VTBOOL
Note:
This option is only valid on the Windows platforms.
This option indicates whether the whole file or a selected range of pages should be printed when the SCCVW_PRINT message is sent.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_PRINT_PAGERANGE: The pages in the one-based, inclusive range from SCCOPT_PRINTSTARTPAGE to SCCOPT_PRINTENDPAGE will be printed.
SCCVW_PRINT_ALLPAGES: The entire document will be printed.
SCCVW_PRINT_SELECTION: Just the selected area will be printed.
Default
SCCVW_PRINT_ALLPAGES
The following information pertains to word processor file rendering.
Enables or disables the email view. If disabled, the Normal and Draft viewing modes will not display email headers. If enabled, the email header will be shown for formats identified as email.
Data Type
VTBOOL
Default
0 (email display feature enabled)
Indicates how the word processor display engine displays documents.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_WPMODE_DRAFT: Display using only a single font and size (SCCID_DEFAULTDISPLAYFONT), do not display embedded graphics, do not display graphic or table borders, wrap the text to the size of the view window.
SCCVW_WPMODE_NORMAL: Display all supported formatting, wrap the text to the size of the view window.
SCCVW_WPMODE_PREVIEW: Display all supported formatting, wrap the text as it will be printed.
Controls the size of word processor pages when using the preview mode.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_FITMODE_ORIGINAL: Sizes the preview page to the actual size.
SCCVW_FITMODE_WINDOWWIDTH: Sizes the preview page to the width of the window.
SCCVW_FITMODE_WINDOW: Sizes the preview page to the window.
This option controls the rendering of headers for email and associated file types (calender entries, contacts, appointments, etc.). For finer control over these headers, see SCCID_MAILHEADERVISIBLE and SCCID_MAILHEADERHIDDEN. It should be noted that setting this option will reset any fields specified with the SCCID_MAILHEADERVISIBLE or SCCID_MAILHEADERHIDDEN options.
Scope
Global
Data Type
VTDWORD
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_EMAILHEADERNONE: Displays no email header fields.
SCCUT_WP_EMAILHEADERALL: Displays all available email headers.
Default
SCCUT_WP_EMAILHEADERSTANDARD
Along with SCCID_MAILHEADERHIDDEN, these options exist to allow the developer fine-grained control over what email headers are rendered. These options modify which email headers are displayed, and are based on the most recent setting of SCCID_WPEMAILHEADEROUTPUT. To implement a fully customized set of email headers for display, your code should first set the SCCID_WPEMAILHEADEROUTPUT option to select a baseline set of headers, then use these options to selectively add or remove headers from that set.
Setting a header to be visible means that it will be rendered when that header is found in a document of the appropriate type. Selected headers that are not present in the input file will not have any corresponding output created for them (no 'empty' headers will be created). Setting a header to be hidden means that it will not be rendered for the document types specified.
Scope
Global
Data Type
SCCUTEMAILHEADERINFO structure
SCCUTEMAILHEADERINFO structure
This structure is used by the SCCID_WPMAILHEADERVISIBLE/SCCID_WPMAILHEADERHIDDEN options to specify the headers to show or hide.
typedef struct SCCUTEMAILHEADERINFOtag
{
VTDWORD dwHeaderID;
VTDWORD dwSubtypeID;
VTWORD wsMimeHeaderName[SCCUT_MAIL_NAMELENGTH];
VTWORD wsMimeHeaderLabel[SCCUT_MAIL_NAMELENGTH];
} SCCUTEMAILHEADERINFO, *PSCCUTEMAILHEADERINFO;
Parameters:
dwHeaderID
Either the ID of a predefined email header field, found in sccca.h (for example SCCCA_MAIL_TO), or an identifer between NONSTANDARD_HEADER_ID_BASE and NONSTANDARD_HEADER_ID_TOP for tracking a user-defined header.
dwSubTypeID
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
wsMimeHeaderName
A Unicode string containing the value of a user-specified MIME header name. This value is only used when the dwHeaderId field contains a user-defined ID value between NONSTANDARD_HEADER_ID_BASE and NONSTANDARD_HEADER_ID_TOP.
wsMimeHeaderLabel
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.
Default
Not used
Along with SCCID_MAILHEADERVISIBLE, these options exist to allow the developer fine-grained control over what email headers are rendered. These options modify which email headers are displayed, and are based on the most recent setting of SCCID_WPEMAILHEADEROUTPUT. To implement a fully customized set of email headers for display, your code should first set the SCCID_WPEMAILHEADEROUTPUT option to select a baseline set of headers, then use these options to selectively add or remove headers from that set.
Setting a header to be visible means that it will be rendered when that header is found in a document of the appropriate type. Selected headers that are not present in the input file will not have any corresponding output created for them (no 'empty' headers will be created). Setting a header to be hidden means that it will not be rendered for the document types specified.
Scope
Global
Data Type
See SCCUTEMAILHEADERINFO structure under SCCID_MAILHEADERVISIBLE
Default
Not used
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 in 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.
Data Type
VTBOOL
The following information pertains to archive rendering.
This option allows prompting the user for input when nodes that are being extracted need to be renamed because the node name already exists, the node name contains illegal characters, or both. The default behavior is for neither of the possible values to be set.
Data Type
VTDWORD
Data
The option can have the following values, OR-ed together if necessary:
SCCVW_ARCHIVE_PROMPTONCOLLISION: If this value is set, a dialog box will appear when two files being extracted have the same name. It will prompt the user to either skip extracting the current file or to overwrite the existing file. If this value is not set, the file will be renamed with a unique number appended to the end.
SCCVW_ARCHIVE_PROMPTONILLEGALCHAR: If this value is set, a dialog box will appear when a file being extracted has illegal characters in it. It will prompt the user to rename the file using only legal characters. The list of illegal characters are operating system dependent (Windows: ? [ ] / \ = + < > : ; " Unix: /) , and are all characters that cannot be included in file names or file paths. If this value is not set, all illegal characters will be stripped out of the file name.
This option acts like an event.
Data Type
VTDWORD
Data
Normally, the value for this option is SCCVW_ARCHIVE_SAVENOP, but it may be set to either of the following values, as well:
SCCVW_ARCHIVE_SAVESELECTION: Allows the user to save the selected files to the directory of their choice.
SCCVW_ARCHIVE_SAVEALL: Allows the user to save all the files to the directory of their choice.
This option sets which attribute to use and the order in which files are displayed in the archive display engine.
Data Type
VTDWORD
Data
One of the following values. Any of these values can be OR-ed with SCCVW_SORT_DESCENDING to force the sorting of the selected attribute to descending order (ascending order is the default when this flag is not set):
SCCVW_SORT_NONE: Display the files in the order they appear in the archive.
SCCVW_SORT_NAME: Display the files sorted by their names.
SCCVW_SORT_SIZE: Display the files sorted by their sizes.
SCCVW_SORT_DATE: Display the files sorted by their dates/times.
The following information pertains to data rendering.
This option sets the full and abbreviated names used to format the days of the week when formatting dates. The default values are retrieved from the localization resource for each platform.
Data Type
SCCVWDAYNAMES structure
This structure is used by the SCCID_DAYNAMES option to specify the format of day names.
SCCVWDAYNAMES is a C data structure defined in sccvw.h as follows:
typedef struct SCCVWDAYNAMEStag
{
VTTCHAR aFullNames[7][16];
VTTCHAR aAbbrevNames[7][16];
} SCCVWDAYNAMES, * PSCCVWDAYNAMES;
Parameters
aFullNames: An array of character strings which identify the full name for each day of the week, starting with Sunday. This option is used when formatting dates which use the full name of the day of the week.
aAbbrevNames: An array of character strings, which identify the abbreviated name for each day of the week, starting with Sunday. This option is used when formatting dates that use the abbreviated name of the day of the week.
This option can disable the password verification of files where the contents can be processed without validation of the password. If this option is not set, the filter should prompt for a password if it handles password-protected files.
Note:
As of Release 8.4.0, only the PST and MDB Filters support this option.
Scope
Global
Data Type
VTBOOL
Data
TRUE: Ignore validation of the password.
FALSE: Prompt for the password.
Default
FALSE
This option is used to set flags related to international support. The default value is retrieved from the operating system for the Windows platform, and defaults to SCCVW_ENGLISHUNITS OR-ed with SCCVW_12HOURTIME on all other platforms.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_ENGLISHUNITS: If set, the print margins are displayed to the user 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.
This option sets the full and abbreviated names used for formatting dates. The default values are retrieved from the localization resource for each platform.
Data Type
SCCVWMONTHNAMES structure
This structure is used to set the SCCID_MONTHNAMES option.
SCCVWMONTHNAMES is a C data structure defined in sccvw.h as follows:
typedef struct
{
VTTCHAR aFullNames[13][16];
VTTCHAR aAbbrevNames[13][16];
} SCCVWMONTHNAMES;
Parameters
aFullNames: An array of character strings which identify the full name for each month of the year starting with January. This option is used when formatting dates which use the full name of the month of the year.
aAbbrevNames: An array of character strings, which identify the abbreviated name for each month of the year, starting with January. This option is used when formatting dates that use the abbreviated name of the month of the year.
This option is used to control the formatting of numbers. It is useful for setting environment dependent variables related to international support. The default values are retrieved from the operating system for the Windows platform, and are set to logical U.S. defaults on all other platforms.
Data Type
SCCVWNUMBERFORMAT and SCCVWNUMBERFORMAT775 structures
SCCVWNUMBERFORMAT775 and SCCVWNUMBERFORMAT Structures
These structures are used to set the SCCID_NUMBERFORMAT option. The fields of the structures allow the developer to control variables related to international support. Please note that the SCCVWNUMBERFORMAT775 structure always assumes 2-digit year data, whereas the SCCVWNUMBERFORMAT structure allows for both 2- and 4-digital year data.
These are C data structures defined in sccvw.h as follows:
typedef struct SCCVWNUMBERFORMAT775tag
{
VTTCHAR cDecimalSep;
VTTCHAR cThousandSep;
VTTCHAR cDateSep;
VTTCHAR cTimeSep;
VTTCHAR szCurrencySymbol[8];
VTTCHAR szAM[8];
VTTCHAR szPM[8];
VTDWORD dwNumBytesAM;
VTDWORD dwNumBytesPM;
VTWORD wCurrencyPosition;
VTWORD wShortDateOrder;
} SCCVWNUMBERFORMAT775, * PSCCVWNUMBERFORMAT775;
typedef struct SCCVWNUMBERFORMATtag
{
VTTCHAR cDecimalSep;
VTTCHAR cThousandSep;
VTTCHAR cDateSep;
VTTCHAR cTimeSep;
VTTCHAR szCurrencySymbol[8];
VTTCHAR szAM[8];
VTTCHAR szPM[8];
VTDWORD dwNumBytesAM
VTDWORD dwNumBytesPM;
VTWORD wCurrencyPosition
VTWORD wShortDateOrder;
VTWORD wShortDateYearDigits;
VTWORD wShortDateMonthDigits;
VTWORD wShortDateDayDigits;
VTWORD wShortDateFlags;
} SCCVWNUMBERFORMAT, * PSCCVWNUMBERFORMAT;
Parameters
cDecimalSep: The character used for the decimal separator when formatting currency.
cThousandSep: The character used for the thousands separator when formatting currency.
cDateSep: The character used to separate years, months, and days when formatting dates. This option only works on variable formats. For example, only one of the several date formats in Microsoft Excel is variable.
cTimeSep: The character used to separate hours, minutes, and seconds when formatting times. This option only works on variable formats. For example, only one of the several time formats in Microsoft Excel is variable.
szCurrencySymbol: The string used for the currency symbol when formatting currency.
szAM: The string used to indicate "AM" when formatting times.
szPM: The string used to indicate "PM" when formatting times.
dwNumBytesAM: Number of bytes of the string stored in szAM.
dwNumBytesPM: Number of bytes of the string stored in szPM.
wCurrencyPosition: Flags that indicate the positioning of the currency symbol when formatting currency. Only six specific filters are supported: SOC6, WG2, WK4, WK6, WPW, and VISO.
SCCVW_CURRENCY_LEADS: The currency symbol is placed before the amount.
SCCVW_CURRENCY_TRAILS: The currency symbol is placed after the amount.
SCCVW_CURRENCY_SPACE: A space is placed between the currency and the amount.
SCCVW_CURRENCY_NOSPACE: A space is not placed between the currency and the amount.
wShortDateOrder: Indicates the order used when formatting short dates (numeric dates). This option only works on variable formats. For example, only one of the several date formats in Microsoft Excel is variable. One of the following:
SCCVW_DATEORDER_MDY: Month, Day, Year
SCCVW_DATEORDER_DMY: Day, Month, Year
SCCVW_DATEORDER_YMD: Year, Month, Date
wShortDateYearDigits: This parameter is specific to the SCCVWNUMBERFORMAT structure. This is the number of digits in the year as specified by the Windows registry entry sShortDate. This option only works on variable formats. For example, only one of the several date formats in Microsoft Excel is variable.
wShortDateMonthDigits: This parameter is specific to the SCCVWNUMBERFORMAT structure. This is the number of digits in the month as specified by the Windows registry entry sShortDate.
wShortDateDayDigits: This parameter is specific to the SCCVWNUMBERFORMAT structure. This is the number of digits in the day as specified by the Windows registry entry sShortDate.
wShortDateFlags: This parameter is specific to the SCCVWNUMBERFORMAT structure. It is reserved for internal use.
This option controls how the viewer reorders bidirectional text.
Data Type
VTDWORD
Data
One of the following values:
SCCUT_REORDER_UNICODE_OFF: This disables any processing for bidirectional characters. This option is the default.
SCCUT_REORDER_UNICODE_LTOR: Characters displayed using the Unicode bidirectional algorithm assuming a base left-to-right order. Use this option to enable bidirectional rendering.
SCCUT_REORDER_UNICODE_RTOL: Characters displayed using the Unicode bidirectional algorithm assuming a base right-to-left order. Use this option to force starting bidirectional rendering in the right-to-left order.
The following information pertains to the View Window.
This option is the font placed on the clipboard (in clipboard formats that support this functionality) when no font is contained within the file being viewed. It is also the font placed on the clipboard for spreadsheets and databases.
Data Type
SCCVWFONTSPEC structure (see the structure documentation in SCCID_DEFAULTPRINTFONT)
This option sets the font used when no font is contained within the file being viewed. It is also the font used in draft mode (when viewing documents) and the font used to display spreadsheets and databases.
Data Type
SCCVWFONTSPEC structure (see the structure documentation in SCCID_DEFAULTPRINTFONT)
This option controls a number of aspects of the method by which dialogs are displayed and by which dialog choices are added to menus.
Data Type
VTDWORD
Data
One or more of the following values OR-ed together:
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_NO3D: Windows only. The dialogs available in the Viewer Technology 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. CTL3DV2.DLL is loaded dynamically (LoadLibrary) so systems without it will not cause a problem.
SCCVW_DIALOG_NOADDDOCOPYTOMENU: Normally, the menu retrieved from SCCVW_GETDISPLAYINFO includes an item called Copy, which copies to the clipboard. This flag disables this menu item.
SCCVW_DIALOG_NOADDDOPRINTTOMENU: Normally, the menu retrieved from SCCVW_GETDISPLAYINFO includes an item called Print..., which prints the file. This flag disables this menu item.
SCCVW_DIALOG_NOADDOPTIONSTOMENU: Normally, the menu retrieved from SCCVW_GETDISPLAYINFO ends in a popup called Options, which has three items: Display..., Print..., and Clipboard.... These items provide access to the options dialogs available in the Viewer Technology. If this is not appropriate for your application, setting this flag will disable this extra popup.
SCCVW_DIALOG_NOADDDISPLAYTOMENU: Setting this flag removes just the Display... item from the option menu described earlier in this bulleted list.
SCCVW_DIALOG_NOADDPRINTTOMENU: Setting this flag removes just the Print... item from the option menu described earlier in this bulleted list.
SCCVW_DIALOG_NOADDCLIPBOARDTOMENU: Setting this flag removes just the Clipboard... item from the option menu described earlier in this bulleted list.
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 the original size. This flag disables this popup menu item.
SCCVW_DIALOG_NOADDSHOWFULLSCREEN: The dialog should not display the "Show Full Screen" menu option from the context menu.
This option sets or gets display font aliases according to the SCCVWFONTALIAS structure.
Data Type
SCCVWFONTALIAS structure
This option scales fonts in the view of a file by a percentage of the original size. The normal size is 100%. The valid range for this factor is from 40 to 300 with 100 as the default.
Note:
For word processor documents, this only affects normal and draft modes. It will not affect paragraph, page or table attributes (for example, margins). For spreadsheet and database documents, the font scaling will affect the row height and column widths. This option will not affect metafile or raster graphics views. For all other document types, only the fonts will be affected
In the context menu, the granularity of an increase/decrease of a font is 20% of the normal size.
Data Type
VTDWORD
This option is used to set flags related to OLE features enabled. This flag has meaning only on systems that have OLE 2.0 available. The default value is to have none of the flags set.
Data Type
VTDWORD
Data
SCCVW_OLE_ENABLEDRAGDROP: If this flag is set, the viewer enables OLE drag-and-drop copying. This allows the user to click on a highlighted selection in a document and drag it to a target application that can accept it.
Note:
This option is only valid on the Windows platforms.
Selects the localization string file based on the Resource ID.
Data Type
SCCVWRESOURCEID structure
This structure is used in the SCCID_RESOURCELIBRARYID option.
SCCVWRESOURCEID is a C data structure defined in sccvw.h as follows:
typedef struct
{
VTDWORD dwSize;
VTBYTE szResourceID [SCCVW_RESOURCEIDMAX];
} SCCVWRESOURCEID;
Parameters
dwSize: Must be set by the developer to sizeof(SCCVWRESOURCEID).
szResourceID: This is a 0-5 character ID defining the new version of the library that has a unique version of the resources.
Note:
szResourceID is not your OEM ID. This ID will be appended to the platform-specific library name to uniquely identify your resource file. If no ID is defined or it is cleared out (NULL), the default library containing English resources will be used
Example
If you use "GR" for a resource file that is localized with German resources the new library must be named as follows:
New Name: SCCLOGR.DLL
Default Name: SCCLO.DLL
This option controls the display of the horizontal and vertical scroll bars. You will need to use both an HSCROLL and a VSCROLL value (from the following list) in the SCCVW_SETOPTION call.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_HSCROLL_NEVER: No horizontal scroll bar will be visible.
SCCVW_HSCROLL_SOMETIMES: Visibility of the horizontal scroll bar is under the control of the display engines.
SCCVW_HSCROLL_ALWAYS: The horizontal scroll bar is always visible.
SCCVW_VSCROLL_NEVER: No vertical scroll bar will be visible.
SCCVW_VSCROLL_SOMETIMES: Visibility of the vertical scroll bar is under the control of the display engines.
SCCVW_VSCROLL_ALWAYS: The vertical scroll bar is always visible.
Note:
The display engines do not currently show/hide the scroll bars, so SOMETIMES and ALWAYS are logically equivalent. This may change in the future.
This option controls a number of miscellaneous interactions between the developer and the Viewer Technology.
Note:
Every new window automatically has this option reset to 0. If you wish to use any of these flags they must be explicitly set for each view window after it is created.
Data Type
VTDWORD
Data
One of the following values:
SCCVW_SYSTEM_RAWTEXT: The developer will receive SCCVW_RAWTEXTEVENT messages.
SCCVW_SYSTEM_NOTIMER: Windows only. Disables the view window's internal timer that controls background reading, caret blinking and auto scroll. If this flag is set, the developer must send SCCVW_IDLE messages to the view window.
SCCVW_SYSTEM_NOOPTIONSSAVE: Normally, when a view window is destroyed, its current options are copied to the default options and saved. If this interaction is not acceptable for the developer's application, this flag may be set to disable it. If this flag is set, the developer may manually cause the current options to be saved into the default set by calling SCCVW_SAVEOPTIONS.
SCCVW_SYSTEM_NOREADAHEAD: This flag disables the view window's process that reads through the rest of the file in the background while the first part of the file is being viewed. When this flag is set, the file will be read "on demand" as the user scrolls down through the document. Please note that use of this flag will cause unusual scroll bar behavior as the user scrolls down.
SCCVW_SYSTEM_UNICODE: This flag will enable the following APIs to process Unicode: SCCVW_GETRAWTEXT, SCCVW_SEARCH, SCCVW_SEARCHDIALOG and SCCVW_GETANNOTATIONDATA.
SCCVW_SYSTEM_TEXTOUTPRINTERDRIVERBUG, SCCVW_SYSTEM_TEXTOUTDISPLAYDRIVERBUG
Windows only. Some device drivers incorrectly implement ExtTextOutW. The fault is tied to the character width array. Turning these flags on causes the Oracle Outside In Viewer Technology to work around the driver bug. Turning these system flags on when the driver bug does not exist will cause incorrect behavior.
This option controls the clipboard formats that the viewer attempts to place on the clipboard in response to a SCCVW_COPYTOCLIP message.
Data Type
VTDWORD
Data
One or more of the following 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: Windows only. Unicode text format.
SCCVW_CLIPFORMAT_WINBITMAP: Windows only. Windows Bitmap.
SCCVW_CLIPFORMAT_WINDIB: Windows only. Windows Device Independent Bitmap.
SCCVW_CLIPFORMAT_WINMETAFILE: Windows only. Windows Metafile.
SCCVW_CLIPFORMAT_WINPALETTE: Windows only. Windows Palette.
The following information pertains to printing.
This option has the same behavior for printing as SCCID_DEFAULTDISPLAYFONT has for display.
This structure is used by various options to specify a font.
SCCVWFONTSPEC is a C data structure defined in sccvw.h as follows:
typedef struct
{
VTTCHAR szFace[40];
VTWORD wHeight;
VTWORD wAttr;
VTWORD wType;
} SCCVWFONTSPEC, * LPSCCVWFONTSPEC;
Parameters
wAttr: The attributes of the font. SCCVW_CHARATTR_NORMAL is the default. Any of the following values can be OR-ed together:
SCCVW_CHARATTR_NORMAL
SCCVW_CHARATTR_UNDERLINE
SCCVW_CHARATTR_ITALIC
SCCVW_CHARATTR_BOLD
SCCVW_CHARATTR_STRIKEOUT
SCCVW_CHARATTR_SMALLCAPS
SCCVW_CHARATTR_OUTLINE
SCCVW_CHARATTR_SHADOW
SCCVW_CHARATTR_CAPS
SCCVW_CHARATTR_SUBSCRIPT
SCCVW_CHARATTR_SUPERSCRIPT
SCCVW_CHARATTR_DUNDERLINE
SCCVW_CHARATTR_WORDUNDERLINE
SCCVW_CHARATTR_DOTUNDERLINE
wType: Should be set to 0.
If TRUE, multiple copies of a printout will be collated. If FALSE, the copies for each page will be printed together.
Data Type
VTBOOL
This option indicates the number of copies of the file, selection or range to print.
Data Type
VTDWORD
This option sets or gets printer font aliases according to the SCCVWFONTALIAS structure.
Data Type
The SCCVWFONTALIAS structure.
This structure is used in the SCCID_PRINTFONTALIAS option.
SCCVWFONTALIAS is a C data structure defined in sccvw.h as follows:
typedef struct SCCVWFONTALIAS
{
VTDWORD dwSize;
VTDWORD dwAliasID;
VTDWORD dwFlags;
VTWORD szwOriginal[SCCVW_FONTNAMEMAX];
VTWORD szwAlias[SCCVW_FONTNAMEMAX];
} SCCVWFONTALIAS;
Parameters
dwSize: Must be set by the developer to sizeof(SCCVWFONTALIAS).
dwAliasID: ID of the aliasing in the current list of aliases.
dwFlags: The usage of these flags depends on whether this structure is being used with the SCCVW_SETOPTION or SCCVW_GETOPTION message. It should be set to one of the following:
SCCVW_FONTALIAS_COUNT (SCCVW_GETOPTION): dwAliasID will be filled with the count of current font aliases for that device.
SCCVW_FONTALIAS_ALIASNAME (SCCVW_SETOPTION): The alias of szwAlias for szwOriginal will be used when szwOriginal is not available on the device. When a font alias is added to the list, this can affect the alias count. If an alias already exists for szwOriginal, the new szwAlias will replace it.
SCCVW_FONTALIAS_ALIASNAME (SCCVW_GETOPTION): szwAlias will be filled if there is an alias in the alias list for the font in szwOriginal on that device.
SCCVW_FONTALIAS_GETALIASBYID (SCCVW_GETOPTION): szwAlias and szwOriginal will be filled by the technology for the alias in the numbered slot identified by the ID.
SCCVW_FONTALIAS_GETALIASID (SCCVW_GETOPTION): dwAliasID will be set for the font in szwOriginal. If none exists, the dwAliasID will be 0xFFFFFFF.
SCCVW_FONTALIAS_REMOVEALIASBYID (SCCVW_SETOPTION): The alias in that slot will be removed if one exists. When a font alias is removed from the list, this can affect the other alias IDs.
SCCVW_FONTALIAS_REMOVEALIASBYNAME (SCCVW_SETOPTION): The alias for the font szwOriginal will be removed from the alias list if one exists. When a font alias is removed from the list, this can affect the other alias IDs.
SCCVW_FONTALIAS_REMOVEALL (SCCVW_SETOPTION): The alias list will be cleared out and the count will be zero.
SCCVW_FONTALIAS_USEDEFAULTS (SCCVW_SETOPTION): This clears the existing alias list and sets it to a list of default aliases that is variable by platform.
szwOriginal: This represents the original name of a font that will be mapped when this font is not available. This name should be a Unicode string.
szwAlias: This represents the new name of a font that will be used as a replacement for the unmapped font named in szwOriginal. This name should be a Unicode string.
Data
The technology assumes the following default mappings. The first value is the szwOriginal Value, the second is the szwAlias Value.
Chicago = Arial
Geneva = Arial
New York = Times New Roman
Helvetica = Arial
Helv = Arial
times = Times New Roman
Times = Times New Roman
Tms Roman = Times New Roman
Symbol = Symbol
itc zapfdingbats = Zapfdingbats
itc zapf dingbats = Zapfdingbats
If the value is TRUE, a header containing the page number and the text specified by the SCCID_PRINTJOBNAME option will be printed at the top of each page.
Note:
If necessary, the top margin (SCCID_DEFAULTPRINTMARGINS) will be moved down to accommodate the header.
Data Type
VTBOOL
This option is the font used when printing the header if SCCID_PRINTHEADER is TRUE.
Data Type
SCCVWFONTSPEC structure
This option sets the text printed in the header on each page and the job name passed to the OS (if applicable). The characters "%F" appearing in the string will be replaced by the display name of the file being viewed. For instance "My document is [%F]" might result in "My document is [TEST.DOC]."
Data Type
C string of 128 characters (data size is 128 characters, including the terminating zero)
The following information pertains to file systems.
This provides three options that allow the user to adjust buffer sizes to take advantage of faster computers/more memory. This is an advanced option that casual users may ignore. This option allows users to tune memory usage to a particular target machine. The number specified is in kilobytes.
Scope
Global
Data Type
SCCBUFFEROPTIONS Structure
Data
A buffer options structure
typedef struct SCCBUFFEROPTIONStag
{
VTDWORD dwReadBufferSize; /* size of the I/O Read buffer
in KB */
VTDWORD dwMMapBufferSize; /* maximum size for the I/O
Memory Map buffer in KB */
VTDWORD dwTempBufferSize; /* maximum size for the memory-
mapped temp files in KB */
VTDWORD dwFlags; /* use flags */
} SCCBUFFEROPTIONS, *PSCCBUFFEROPTIONS;
Parameters
dwReadBufferSize: Used to define the number of bytes that will read from disk into memory at any given time. Once the buffer has data, further file reads will proceed within the buffer until the end of the buffer is reached, at which point the buffer will again be filled from the disk. This can lead to performance improvements in many file formats, regardless of the size of the document.
dwMMapBufferSize: Used to define a maximum size that a document can be and use a memory-mapped I/O model. In this situation, the entire file is read from disk into memory and all further I/O is performed on the data in memory. This can lead to significantly improved performance, but note that either the entire file can be read into memory, or it cannot. If both of these buffers are set, then if the file is smaller than the dwMMapBufferSize, the entire file will be read into memory; if not, it will be read in blocks defined by the dwReadBufferSize.
dwTempBufferSize: The maximum size that a temporary file can occupy in memory before being written to disk as a physical file. Storing temporary files in memory can boost performance on archives, files that have embedded objects or attachments. If set to 0, all temporary files will be written to disk.
dwFlags
SCCBUFOPT_SET_READBUFSIZE 1
SCCBUFOPT_SET_MMAPBUFSIZE 2
SCCBUFOPT_SET_TEMPBUFSIZE 4
To set any of the three buffer sizes, set the corresponding flag while calling dwSetOption.
Default
The default settings for these options are:
#define SCCBUFOPT_DEFAULT_READBUFSIZE 2: A 2KB read buffer.
#define SCCBUFOPT_DEFAULT_MMAPBUFSIZE 8192: An 8MB memory-map size.
#define SCCBUFOPT_DEFAULT_TEMPBUFSIZE 2048: A 2MB temp-file limit.
Minimum and maximum sizes for each are:
SCCBUFOPT_MIN_READBUFSIZE 1: Read one Kbyte at a time.
SCCBUFOPT_MIN_MMAPBUFSIZE 0: Don't use memory-mapped input.
SCCBUFOPT_MIN_TEMPBUFSIZE 0: Don't use memory temp files
SCCBUFOPT_MAX_READBUFSIZE 0x003fffff, SCCBUFOPT_MAX_MMAPBUFSIZE 0x003fffff, SCCBUFOPT_MAX_TEMPBUFSIZE 0x003fffff: These maximums correspond to the largest file size possible under the 4GB DWORD limit.
From time to time, the technology needs to create one or more temporary files. This option sets the directory to be used for those files.
It is recommended that this option be set as part of a system to clean up temporary files left behind in the event of abnormal program termination. By using this option with code to delete files older than a predefined time limit, the OEM can help to ensure that the number of temporary files does not grow without limit.
Note:
This option will be ignored if SCCOPT_REDIRECTTEMPFILE is set.
Scope
Global
Data Type
SCCUTTEMPDIRSPEC structure
This structure is used in the SCCID_TEMPDIR option.
SCCUTTEMPDIRSPEC is a C data structure defined in sccvw.h as follows:
typedef struct SCCUTTEMPDIRSPEC
{
VTDWORD dwSize;
VTDWORD dwSpecType;
VTBYTE szTempDirName[SCCUT_FILENAMEMAX];
} SCCUTTEMPDIRSPEC, * LPSCCUTTEMPDIRSPEC;
There is a limitation in the current release. dwSpecType describes the contents of szTempDirName. Together, dwSpecType and szTempDirName describe the location of the source file. The only dwSpecType values supported at this time are:
IOTYPE_ANSIPATH: Windows only. szTempDirName points to a NULL-terminated full path name using the ANSI character set and FAT 8.3 (Win16) or NTFS (Win32 and Win64) file name conventions.
IOTYPE_UNICODEPATH: Windows only. szTempDirName points to a NULL-terminated full path name using the Unicode character set and NTFS file name conventions. Note that the length of the path name is limited to SCCUT_FILENAMEMAX bytes, or (SCCUT_FILENAMEMAX / 2) double-byte Unicode characters.
IOTYPE_UNIXPATH: X Windows on UNIX platforms only. szTempDirName points to a NULL-terminated full path name using the system default character set and UNIX path conventions.
Specifically not supported at this time is IOTYPE_REDIRECT.
Parameters
dwSize: Set to sizeof(SCCUTTEMPDIRSPEC).
dwSpecType: IOTYPE_ANSIPATH, IOTYPE_UNICODE or IOTYPE_UNIXPATH
szTempDirName: The path to the directory to use for the temporary files. Note that if all SCCUT_FILENAMEMAX bytes in the buffer are filled, there will not be space left for file names.
This option determines the maximum amount of memory that the chunker may use to store the document's data, from 4 MB to 1 GB. The more memory the chunker has available to it, the less often it needs to re-read data from the document.
Scope
Global
Data Type
VTDWORD
Parameters
SCCDOCUMENTMEMORYMODE_SMALLEST 1: 4MB
SCCDOCUMENTMEMORYMODE_SMALL 2 : 16MB
SCCDOCUMENTMEMORYMODE_MEDIUM 3: 64MB
SCCDOCUMENTMEMORYMODE_LARGE 4: 256MB
SCCDOCUMENTMEMORYMODE_LARGEST 5: 1 GB
Default
SCCDOCUMENTMEMORYMODE_SMALL 2: 16MB
This option is set when the developer wants to use redirected IO to completely take over responsibility for the low level IO calls of the temp file.
Scope
Global (not persistent)
Data Type
VTLPVOID: pCallbackFunc
Function pointer of the redirect IO callback.
Redirect call back function:
typedef
{
VTDWORD (* REDIRECTTEMPFILECALLBACKPROC)
(HIOFILE *phFile,
VTVOID *pSpec,
VTDWORD dwFileFlags);
There is another option to handle the temp directory, SCCOPT_TEMPDIR. Only one of these two can be set by the developer. The SCCOPT_TEMPDIR option will be ignored if SCCOPT_REDIRECTTEMPFILE is set. These files may be safely deleted when the Close function is called.
|
 Copyright © 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|