64
PDF Export C/C++ Options
PDF Export Options s B-25
■
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.
45
PDF Export C/C++ Options
B-26 Oracle Outside In PDF Export Developer's Guide
B.1.6.8 SCCOPT_DOLINEARIZATION
Linearization is a method by which PDF renderers are able to render pages of the PDF
file before the entire document is loaded. Linearized output is both larger and takes
longer to produce; this option allows you to produce non-linearized PDF so that the
export process will be quicker and result in a smaller output file.
Type
VTBOOL
Default
FALSE
B.1.6.9 SCCOPT_WPEMAILHEADEROUTPUT
The former option SCCOPT_WPMIMEHEADEROUTPUT has been deprecated. This
option controls rendering of email headers.
Scope
Global
Data Type
VTDWORD
Data
One of these values:
■
SCCUT_WP_EMAILHEADERSTANDARD: Displays "To," "From," "Subject," "CC,"
"BCC," "Date Sent," and "Attachments" header fields only. The filter outputs any
fields not listed above as hidden fields, so they will not display.
■
SCCUT_WP_EMAILHEADERNONE: Displays no email header fields.
■
SCCUT_WP_EMAILHEADERALL: Displays all available email headers.
Default
SCCUT_WP_EMAILHEADERSTANDARD
B.1.6.10 SCCOPT_MAILHEADERVISIBLE
Along with SCCOPT_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
SCCOPT_WPEMAILHEADEROUTPUT. To implement a fully customized set of email
headers for display, your code should first set the SCCOPT_
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
43
PDF Export C/C++ Options
PDF Export Options s B-27
Data Type
SCCUTEMAILHEADERINFO structure
SCCUTEMAILHEADERINFO structure
This structure is used by the SCCOPT_WPMAILHEADERVISIBLE/SCCOPT_
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.
C# TIFF: C#.NET Code to Convert JPEG Images to TIFF string[] imagePaths = { @"C:\demo1.jpg", @"C:\demo2.jpg", @"C:\demo3.jpg" }; // Construct List<REImage> object. Use C# Code to Convert Gif to Tiff.
conversion of pdf to jpg; convert multiple pdf to jpg online
44
PDF Export C/C++ Options
B-28 Oracle Outside In PDF Export Developer's Guide
Default
Not used
B.1.6.11 SCCOPT_MAILHEADERHIDDEN
Along with SCCOPT_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
SCCOPT_WPEMAILHEADEROUTPUT. To implement a fully customized set of email
headers for display, your code should first set the SCCOPT_
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 SCCOPT_MAILHEADERVISIBLE.
Default
Not used
B.1.6.12 SCCOPT_EXPORTEMAILATTACHMENTS
This option toggles whether or not email attachments will be output as PDF. For input
files in all OIT-supported email formats that contain attachments, this option instructs
the PDF Export process to export the contents of the attachments to PDF. The contents
of the export are attached to the end of the email message so that only one PDF output
file is produced. In addition, hyperlinks are provided that link to bookmarks marking
the beginning of each attachment in the resulting PDF.
Data Type
VTBOOL
Data
■
TRUE: Email attachments are output as PDF.
■
FALSE: Email attachments are not included in the PDF.
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.
45
PDF Export C/C++ Options
PDF Export Options s B-29
Default
FALSE
B.1.7 Font Rendering
This section discusses font rendering options.
B.1.7.1 SCCOPT_DEFAULTPRINTFONT
This is an advanced option that casual users of PDF Export may ignore.
This option sets the font to use when the chunker-specified font is either excluded by
SCCOPT_FONTFILTER or is not available on the system. It is also the font used when
the font in the source file is not available on the system performing the conversion.
Handle Types
VTHDOC, VTHEXPORT
Scope
Local
Data Type
SCCVWFONTSPECstructure
B.1.7.1.1 SCCVWFONTSPEC Structure 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
■
szFace: The name of the font. For example, "Helvetica Compressed." The default is
"Arial", however this default is constrained by the fonts available on the system.
■
wHeight: Size of the font in half points. For example, a value of 24 will produce a
12-point font. This size is only applied when the font size is not known. The
default is 10-point, however this default is constrained by the font sizes available
on the system.
■
wAttr: The attributes of the font. This parameter is used primarily by the Oracle
Outside In Viewer Technology and is currently ignored by PDF Export.
■
wType: Should be set to 0.
B.1.7.2 SCCOPT_EMBEDFONTS
This option allows the developer to specify whether or not fonts should be embedded
in the file. In order to comply with the PDF/A-1a spec, this option is forced to a value
of TRUE when FI_PDFA is selected for the output type.
38
PDF Export C/C++ Options
B-30 Oracle Outside In PDF Export Developer's Guide
Handle Type
VTHDOC, VTHEXPORT
Scope
local
Data Type
VTBOOL
Data
A Boolean value indicating if fonts should be embedded.
Default Value
TRUE
B.1.7.3 SCCOPT_FONTDIRECTORY
This option allows the developer to specify one or more font directories where fonts
are located for use by PDF Export. If multiple font directories are specified, they
should be delimited by a colon on Linux and UNIX systems and a semi-colon on
Windows systems.
This option must be set prior to performing any exports. Please note that PDF Export
supports single TrueType fonts (*.ttf, *.TTF) and TrueType collections (*.ttc, *.TTC), not
Windows bitmap fonts (*.fon, *.FON), or any other type of font. Also, PDF Export does
not require case-sensitive font filenames on UNIX systems.
Handle Types
VTHDOC, VTHEXPORT
Scope
Local
Data Type
VTLPBYTE
Data
A path to the fonts.
Default
NONE - the option must be set.
B.1.7.4 SCCOPT_FONTFILTER
This option allows the developer to specify a list of fonts to be included or excluded
during the export process.
Handle Types
VTHDOC, VTHEXPORT
Scope
Local
46
PDF Export C/C++ Options
PDF Export Options s B-31
Data Type
FONTFILTERLIST Structure
Data
A structure containing the list of fonts and an attribute indicating whether the list is an
inclusion list or exclusion list.
Default
All fonts included during the export process.
B.1.7.4.1 FONTFILTERLIST Structure
typedef struct FONTFILTERLISTtag
{
BOOL bExclude;
PFONTNAMELIST pFontList;
}FONTFILTERLIST;
Parameters
■
bExclude: If true, then the accompanying font list is an exclusion list. If false, the
list is an inclusion list.
■
pFontList: Pointer to a FONTNAMELIST structure (see SectionB.1.7.4.2,
"FONTNAMELIST Structure") that contains the names of the fonts to include or
exclude.
B.1.7.4.2 FONTNAMELIST Structure
typedef struct FONTNAMELISTtag *PFONTNAMELIST;
typedef struct FONTNAMELISTtag
{
BYTE szFontName[SCCUT_FILENAMEMAX];
PFONTNAMELIST pNextFont;
}FONTNAMELIST;
Parameters
■
szFontName: Name of font to include or exclude.
■
pNextFont: Pointer to a FONTNAMELIST structure that contains the name of the
next font to include or exclude. The pointer in the final structure in this linked list
should point to NULL.
B.1.7.5 SCCOPT_PRINTFONTALIAS
This option sets or gets printer font aliases according to the SCCVWFONTALIAS
structure.
Handle Types
VTHDOC, VTHEXPORT
Scope
Local
Data Type
The SCCVWFONTALIAS structure.
63
PDF Export C/C++ Options
B-32 Oracle Outside In PDF Export Developer's Guide
B.1.7.5.1 SCCVWFONTALIAS Structure This structure is used in the SCCOPT_
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. In PDF Export, the
default is that no alias is applied.
■
dwFlags: The usage of these flags depends on whether this structure is being used
with the DASetOption or DAGetOption message. It should be set to one of the
following:
–
SCCVW_FONTALIAS_COUNT (DAGetOption): dwAliasID will be filled with
the count of current font aliases for that device.
–
SCCVW_FONTALIAS_ALIASNAME (DASetOption): 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 (DAGetOption): szwAlias will be filled
if there is an alias in the alias list for the font in szwOriginal on that device.
–
SCCVW_FONTALIAS_GETALIASBYID (DAGetOption): szwAlias and
szwOriginal will be filled by the technology for the alias in the numbered slot
identified by the ID.
–
SCCVW_FONTALIAS_GETALIASID (DAGetOption): dwAliasID will be set
for the font in szwOriginal. If none exists, the dwAliasID will be 0xFFFFFFF.
–
SCCVW_FONTALIAS_REMOVEALIASBYID (DASetOption): 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 (DASetOption): 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 (DASetOption): The alias list will be
cleared out and the count will be zero.
–
SCCVW_FONTALIAS_USEDEFAULTS (DASetOption): 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.
Documents you may be interested
Documents you may be interested
