| Name |
Type |
Description |
| Name |
String |
Profile name. This field is
reserved for future use. |
|
Document interface |
| InterfaceOptions |
Integer |
Bit mask specifying which buttons and
controls should be shown in converted document interface. Should be an OR
combination of flags from
INTERFACE_OPTION enumeration |
| Skin |
Skin object |
The default Skin
object used at document conversions. You may either retrieve this object or
set it to another Skin object obtained from
SkinCollection collection.
If this property is set to null value, it tells Print2Flash that no
skin is used and no skin images are
stored inside the document. It is helpful for reducing of document file size
in case you either don't
need the document toolbar at all or use
your own custom document viewer for
single file or
external viewer output
format. |
| Language |
String |
Specifies document toolbar hint language. Possible
parameter values are listed below.
| Value |
Language |
Value |
Language |
| auto |
Automatic selection of language based on the
user's operating system language |
|
|
| bs |
Bosnian |
it |
Italian |
| cs |
Czech |
nl |
Dutch |
| da |
Danish |
pl |
Polish |
| de |
German |
pt |
Portuguese |
| en |
English |
ru |
Russian |
| es |
Spanish |
sr |
Serbian |
| fr |
French |
sv |
Swedish |
| hr |
Croatian |
zh-CN |
Simplified Chinese |
|
|
Document protection |
|
ProtectionOptions |
Integer |
Bit mask specifying which
protection options should be activated in the converted document. Should be
an OR combination of flags from PROTECTION_OPTION enumeration |
| RestrictionDomains |
String |
Specifies from which domains (sites) the
generated Flash documents are allowed to be viewed. The value must be a
comma-separated list of domains. For example, "mysite.com,print2flash.com"
value allows document display only if the document has been loaded from
mysite.com or print2flash.com domains. Mentioning a domain in the list does
not include all its subdomains so allowed subdomains must be listed
separately, e.g. "mysite.com,www.mysite.com". If document is loaded from
another domain, no document contents is shown to the user.
If this value is set to the empty string, no domain restriction is effective
and documents can be viewed from any domain. See
Restricting Access to Documents help
topic for more information. |
|
Document optimization |
| FlashVersion |
Integer |
The version of Flash Player for
which document output should be optimized. Currently can be a value between
7 and 10. |
| UseJpeg |
Boolean |
Flag specifying whether to
compress mages in the output document to JPEG |
| JpegQuality |
Integer |
JPEG quality level to use for
compression of images in the output document. It should be a number between
1 (lowest quality) and 100 (highest quality). Note that images are
compressed as JPEG only if UseJpeg property is set to true as well. |
|
Hyperlinks |
| ParseLinks |
Boolean |
Flag specifying if Print2Flash should parse
hyperlinks out of document text and convert them to clickable hyperlinks in
the generated Flash document. See Hyperlinks
topic for more information. |
| ExtractLinks |
Integer |
Specifies from which types of documents
Print2Flash should extract hyperlinks for insertion in the generated Flash
document. Currently it could be MSWORD, MSPOWERPOINT or
ACROBAT values from
APPLICATIONTYPE enumeration. If
you use Print2Flash Service and
Server2 object, you cannot use MSWORD flag. To
extract links from MS Word and PowerPoint documents, special application conversion method must
be activated. See Hyperlinks topic for more
information. |
| LinkTargetAuto |
Boolean |
If true, hyperlink targets are taken from
source documents. If a source document does not specify a target or a link
has been parsed from document text, _blank target is used.
If false, the target is specified by LinkTarget
property. See Hyperlinks Tab of Document Options Window
help topic. |
| LinkTarget |
String |
Specifies the target to be used for
hyperlinks. This property is used only if
LinkTargetAuto property is false. |
|
Output format |
| OutputFormat |
Integer |
Output format for the generated Flash
documents. It should be set to one of the values from
OUTPUTFORMAT enumeration. See
Output Formats
topic for more information. |
| DocTemplate |
String |
Specifies the name of the custom document
viewer template file to use for
single file output format. Note that this custom document template is used
only if TemplateType property is set to
TEMPLATE_CUSTOM. See
Designing your Own Document Viewer for Single File Format topic for more information. |
| TemplateType |
Integer |
Specifies the type of document
template to use for single file
output format.. The value must belong to
TEMPLATETYPE enumeration. If
TEMPLATE_CUSTOM is specified, you must supply a custom document template
with DocTemplate
property. |
| PageFileName |
String |
The template of the name and path of page
files if "Single file per page" output format is used. The template format
may include these placeholders:
- %name% main output document full path and name without extension;
- %page% page number (this is a required placeholder).
See Designing your
Own Document Viewer for Single File per Page Format topic for more information. |
| OutputResolution |
Integer |
Resolution used for the generated page
Flash files if "Single file per page" output format
is used. Zero value means output resolution is always equal to printing
resolution. See
Designing your Own Document Viewer for Single File per Page Format topic for more information. |
| ASVersion |
Integer |
Version of ActionScript to use for the generated page
Flash files if "Single file per page" output format
is used. Can be 2 or 3. |
|
Watermarks |
| WatermarkImage |
String |
Path to the graphic file of PNG format
which should be placed on each document page as a
watermark. See Watermarks topic for more
information. |
| WatermarkScale |
Integer |
Specifies how the image
watermark should be scaled relative to the page
size. The value represents the percentage of the page size and should be
between 1 and 100. |
| WatermarkTransparency |
Integer |
Specifies the transparency correction for
the watermark image. This property affects
watermark image transparency (alpha channel). The value should be between 0
(transparency of image is not affected) to 255 (full transparency). |
|
WatermarkAnchor |
Integer |
Specifies the position on the page the
watermark should be placed at. It must be a value from the
WATERMARKANCHOR enumeration. |
|
WatermarkXOffset |
String |
Specifies the horizontal offset of the
watermark from the position denoted by
WatermarkAnchor property. The value must be specified either in pixels
or as a percentage in these formats:
- -10px for pixels;
- 20% for percentage. Percentage is calculated relative to page
width.
If the unit is not specified, the default unit is
percentage. The numeric value may be either positive or negative. |
| WatermarkYOffset |
String |
Specifies the vertical offset of the
watermark from the position denoted by
WatermarkAnchor property. The format of the value is similar to
WatermarkXOffset property except that if it
is specified as a percentage, it is calculated relative to page height. |
|
Page thumbnails |
|
ThumbnailPageRange |
String |
String describing the pages for which
page thumbnails must be created. The acceptable
values are the following:
- (empty string) no thumbnails is generated;
- All thumbnails are generated for each page;
- Arbitrary page range. The string should be in the following format:
[Range1Start[-][Range1End]] [,Range2Start[-][Range2End]] [, ... ]
See documentation on
PageRange property of
BatchProcessingOptions object.
|
| ThumbnailFileName |
String |
The template of the name and path of
page thumbnails files. If it includes the path,
it is interpreted relative to the output folder (see
ConvertDir and
ConvertFile methods). The
template format may include these placeholders:
- %name% main output document full path and name without extension;
- %page% page number (this is a required placeholder);
- %ext% file format extension (for
example, "jpg" or
"png").
In order to create page thumbnails,
ThumbnailPageRange property should specify
which thumbnails should be created. |
|
ThumbnailFormat |
Integer |
Page thumbnail
image file format. It should be set to one of the values from
IMAGEFORMAT enumeration. |
| ThumbnailJpegQuality |
Integer |
JPEG quality level to use for
compression of thumbnails images if the image
format is JPEG. It should be a number between 1 (lowest quality) and 100
(highest quality). |
| ThumbnailImageHeight |
Integer |
Page thumbnail
image file height. See Page Thumbnails topic
for more information. |
| ThumbnailImageWidth |
Integer |
Page thumbnail
image file width. See Page Thumbnails topic for
more information. |
|
Metadata file |
|
CreateMetaDataFile |
Boolean |
If true, metadata
file is created at conversion. The name and path to the file is
specified by the MetaDataFileName property. |
| MetaDataFileFormat |
Integer |
Format of the
metadata file. It should be set to one of the values from
METADATAFORMAT enumeration. |
|
MetaDataFileName |
String |
The template of the name and path of
metadata file. If it includes the path, it is
interpreted relative to the output folder (see
ConvertDir and
ConvertFile methods). The
template format may include these placeholders:
- %name% main output document full path and name without extension;
- %ext% - file format extension (for
example, "xml" or
"txt").
For example, if the output document name is c:\test\mydoc.swf, template is
"%name%.%ext%" and metadata file
format is XML, the metadata file name will be
c:\test\mydoc.xml.
In order to create metadata file
CreateMetaDataFile property should be set
to true. |