Dcpro API
Dcpro API
NEEVIA
Document Converter
Professional Edition
API Reference
version 7.5
Title .................................................................................................................................................... 1
Table of Contents ................................................................................................................................ 2
License ............................................................................................................................................. 13
Document Converter API Reference .................................................................................................. 17
Methods .................................................................................................................................................... 18
doSleep .................................................................................................................................................. 18
submitFile .............................................................................................................................................. 18
submitFileEx ........................................................................................................................................... 19
submitURL.............................................................................................................................................. 19
convertFile ............................................................................................................................................. 19
checkStatus ............................................................................................................................................ 20
checkStatusEx ........................................................................................................................................ 20
getDefaultInputFolder ........................................................................................................................... 21
getOutputFolder .................................................................................................................................... 21
getErrorFolder ....................................................................................................................................... 21
getOrigFolder ......................................................................................................................................... 21
setParameter ......................................................................................................................................... 21
getParameter ......................................................................................................................................... 22
setParserParameter ............................................................................................................................... 22
getParserParameter............................................................................................................................... 22
setAddinParameter................................................................................................................................ 22
getAddinParameter ............................................................................................................................... 22
linearizePDF ........................................................................................................................................... 23
deletePDFpages ..................................................................................................................................... 23
rotatePDFpages ..................................................................................................................................... 23
encryptPDF ............................................................................................................................................ 24
decryptPDF ............................................................................................................................................ 24
mergePDF .............................................................................................................................................. 24
mergeMultiplePDF ................................................................................................................................. 24
splitPDF .................................................................................................................................................. 25
extractPDFpages .................................................................................................................................... 25
mergeTIFF .............................................................................................................................................. 25
mergeMultipleTIFF ................................................................................................................................ 26
splitTIFF .................................................................................................................................................. 26
extractTIFFpages .................................................................................................................................... 26
stampPDF ............................................................................................................................................... 27
getNumPages ......................................................................................................................................... 27
getBaseName ......................................................................................................................................... 27
getExtensionName................................................................................................................................. 27
fileExists ................................................................................................................................................. 27
isFileInUse .............................................................................................................................................. 28
fileCopy .................................................................................................................................................. 28
fileDelete ............................................................................................................................................... 28
createFolder........................................................................................................................................... 28
copyFolder ............................................................................................................................................. 28
deleteFolder........................................................................................................................................... 29
converterPath ........................................................................................................................................ 29
Neevia Document Converter Pro v7.5 API Reference
© Copyright © 2000-2023, Neevia Technology.
Page 2 of 148
isConverterActive .................................................................................................................................. 29
GUID....................................................................................................................................................... 29
Conversion parameters - GENERAL ........................................................................................................... 30
DocumentOutputFormat ....................................................................................................................... 30
DocumentOutputFolder ........................................................................................................................ 30
DocumentErrorFolder ............................................................................................................................ 30
DocumentOriginalFolder ....................................................................................................................... 30
DocumentPassword ............................................................................................................................... 30
ZIPpassword........................................................................................................................................... 31
Conversion parameters - EMAILING.......................................................................................................... 32
RecipientAddress ................................................................................................................................... 32
SMTPServerAddress............................................................................................................................... 32
SMTPUser .............................................................................................................................................. 32
SMTPPassword ...................................................................................................................................... 32
SMTPPort ............................................................................................................................................... 32
SMTPEncryption .................................................................................................................................... 33
SMTPFromName .................................................................................................................................... 33
SMTPFromAddress ................................................................................................................................ 33
SMTPSuccessSubject.............................................................................................................................. 33
SMTPSuccessBody ................................................................................................................................. 33
SMTPErrorSubject .................................................................................................................................. 34
SMTPErrorBody...................................................................................................................................... 34
Conversion parameters - SCRIPTING ......................................................................................................... 35
ScriptSrc ................................................................................................................................................. 35
ScriptLang .............................................................................................................................................. 35
ScriptTimeout ........................................................................................................................................ 35
ScriptAllowUI ......................................................................................................................................... 35
Conversion parameters - PRINTER related................................................................................................ 36
UsePrinter .............................................................................................................................................. 36
MultiThreadedPrinting .......................................................................................................................... 36
PrintEngine ............................................................................................................................................ 36
PrintColors ............................................................................................................................................. 36
ShrinkToFit ............................................................................................................................................. 36
Conversion parameters - PostScript/EPS related ...................................................................................... 37
LanguageLevel ....................................................................................................................................... 37
Conversion parameters - Image related.................................................................................................... 38
TIFFType ................................................................................................................................................. 38
MultiPageTIFF ........................................................................................................................................ 38
FillOrder ................................................................................................................................................. 38
JPGType.................................................................................................................................................. 39
JPGQuality .............................................................................................................................................. 39
BMPType ................................................................................................................................................ 39
PSDType ................................................................................................................................................. 39
PCXType ................................................................................................................................................. 40
PNGType ................................................................................................................................................ 40
PXLType.................................................................................................................................................. 40
ScalePage ............................................................................................................................................... 41
ConstrainProportions............................................................................................................................. 41
ScaleIfLarger .......................................................................................................................................... 41
NEEVIA TECHNOLOGY
This is an End User License Agreement. This is a contract. If you install this software, you must abide by the
terms of this agreement. This license is applicable to all software products sold by Neevia Technology
(Neevia). The term software includes upgrades, modified versions or updates. This software is licensed and
not sold. Only a personal, non-transferable and nonexclusive right to use the Neevia products is granted to
the end user.
a. SERVER
This is a single computer owned, rented or leased by a single individual or entity on which one or
more applications load and execute software in the memory space of that computer. Software is
installed on a server for one or more users. All servers must be licensed to utilize Neevia software.
b. VIRTUAL SERVER
This is a single computer that is owned, rented or leased by an individual or entity who turns around
and rents or leases access to others. The virtual server may have one or more applications on it for
the end users to use. The purpose of the virtual server is to give multiple users access to many
software programs.
c. DEVELOPMENT
This means that you are programming a specific application or tool that will interact with the
software that you are licensing from Neevia Technology.
THIS IS A CONTRACT BETWEEN YOU AND NEEVIA TECHNOLOGY. YOU SHOULD CAREFULLY READ THIS
LICENSING AGREEMENT AND MUST ACCEPT ALL THE TERMS AND CONDITIONS BEFORE INSTALLING THIS
NEEVIA SOFTWARE. BY INSTALLING THE SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE TERMS AND
CONDITIONS OF THIS LICENSE. IF YOU DO NOT AGREE TO THE TERMS OF THIS LICENSE, DO NOT INSTALL
THE SOFTWARE, AND DO NOT USE THE SOFTWARE. IF YOU VIOLATE THIS AGREEMENT, YOU WILL BE
SUBJECT TO LEGAL ACTION BY NEEVIA TECHNOLOGY.
Subject to the payment of applicable license fees, Neevia Technology grants you a nonexclusive right to use
its accompanying Neevia software product and related documents (the Software) in the terms and
conditions provided as follow:
(d) Archiving:
You may make one copy of the Software solely for archival purposes. If the Software is an upgrade, you
may use the Software only in conjunction with upgraded product. If you receive your first copy of the
Software electronically, and a second copy on media afterward, the second copy can be used for
archival purposes only.
You agree to surrender your license(s) if you violate this agreement. If you violate this agreement, you will
not receive a refund upon termination of this license. You agree not to utilize our software to violate the
copyright of any third parties. If you do violate the copyright of a third party utilizing our software, you
agree to hold Neevia Technology harmless and will indemnify Neevia Technology for any such activity even
if the violation is unintentional.
You may not rent, lease, sub-license, transfer, or sell the Software. You may not modify, translate, reverse
engineer, decompile, disassemble, or create derivative works based on the Software, except to the extent
applicable law expressly prohibits such foregoing restriction. You may use the trademarks to identify the
Software owner's name, or to identify printed output produced by the Software. Such use of any trademark
does not give you any rights of ownership in that trademark.
GENERAL
This Agreement shall be construed, interpreted, and governed by the laws of the State of Florida, excluding
the application of its conflicts of law rules. The United Nations Convention on Contracts of the International
Sale of Goods, will not govern this Agreement. If any part of this Agreement is found void and
unenforceable, it will not affect the validity of the rest of the Agreement, which shall remain valid and
enforceable according to its terms.
If you need to redistribute this product with your own software products, you need to contact Neevia and
negotiate a separate licensing and royalty agreement.
You may not ship, transfer, or export the Software into any country or used in any manner prohibited by
any export laws, restrictions or regulations.
GOVERNEMENT USERS
For United States government users, the Software and associated Documentation are deemed to be
“commercial computer software” and “commercial computer documentation”, respectively pursuant to
DFAR 227.7202 and FAR 12.212(b) as applicable.
ENTIRE AGREEMENT
You acknowledge that you have read this Agreement, understand it and agree to be bounded by its terms
and conditions. It is the complete and exclusive statement of the Agreement between us, which supersedes
any proposal or prior agreement, oral or written, and other communication between us relating to the
subject matter of this Agreement.
Neevia Document Converter Pro supports conversion through a COM object / .NET assembly.
Before calling any methods from the Neevia Document Converter COM object / .NET assembly, you must
make sure that Neevia Document Converter (dconverter.exe) is running.
Example:
VBScript: Set NVDC = CreateObject("Neevia.docConverter")
NOTE: By default, the .NET assembly can be found under Program Files (x86)\neevia.com\docConverterPro\.NET;
doSleep
Suspends execution of the current thread for a specified interval.
Syntax
NVDC.doSleep( sleepTime )
Parameters
sleepTime - specifies the amount of time, in milliseconds, for which to suspend execution.
submitFile
Submits a document for conversion.
Syntax
Res = NVDC.submitFile( fileToSubmit, inputFolder )
Parameters
fileToSubmit - full path to the file to convert;
inputFolder - input folder where the submitted document will go; This folder must be defined in
Neevia Document Converter configuration.
If inputFolder is empty ("") then Document Converter will use as input folder DefaultInputFolder (C:\ Program
Files (x86)\Neevia.Com\docConverterPro\DEF_FOLDERS\IN\)
Ex: Res = NVDC.submitFile("c:\test.doc","") will submit the C:\test.doc file into
C:\Program Files (x86)\Neevia.Com\docConverterPro\DEF_FOLDERS\IN.
submitURL
Submits an URL for conversion.
Note: When using this method from ASP make sure that the IUSR_ and IWAM_ users have write access to the
system temporary folder, input folder and Document Converter program folder.
Syntax
Res = NVDC.submitURL(URL, urlFileName, inputFolder)
Parameters
URL - web site url, ex. "http://neevia.com".
urlFileName - The name of the temporary .url file used for conversion. Example: if you specify
"http://neevia.com" as siteURL and "test.url" as urlFileName , then document converter will
create a temporary url file called test.url that contains a link to the http://neevia.com site
and will submit the test.url file for conversion into the inputFolder.
inputFolder - The input folder where the submitted document will go; This folder must be defined in
Neevia Document Converter configuration.
If inFolder is empty ("") then Document Converter will use as input folder DefaultInputFolder (C:\program files
(x86)\neevia.com\docConverterPro\Def_Folders\IN)
Ex: RetVal = NVDC.SubmitURL("http://neevia.com","neevia.url","") will submit the neevia.url file into the
C:\Program files (x86)\neevia.com\docConverterPro\DEF_FOLDERS\IN\ folder.
Possible return values:
-9 - invalid URL
convertFile
Converts a file using the Default Input folder.
Note: a subfolder with a unique name will be created in the Default Input folder for each submitted file.
Syntax
Res = NVDC.convertFile(fileToConvert, outputFile, timeOut)
Parameters
fileToConvert - full path to the file that is being converted;
outputFile - full path to the destination file;
timeOut - conversion timeout;
checkStatusEx
Checks the status of the current conversion.
Note: Use it only with the submitFileEx method.
Syntax
Res = NVDC.checkStatusEx( fileName, outFolder, errorFolder )
Parameters
fileName - full path to the file that has been submitted for conversion;
outFolder - the folder where the converted document is located (without file name);
errorFolder - the folder where the error document is located (without file name);
Possible Return values:
0 - Converted successfully;
1 - Error converting;
2 - Still converting;
3 - Unable to determine the conversion status.
getOutputFolder
Returns the output folder associated with a specified input folder in Document Converter.
Syntax
Res = NVDC.getOutputFolder( inputFolder )
Parameters
inputFolder - input folder;
Example
Dim NVDC : Set NVDC = CreateObject("Neevia.docConverter")
inputFolder = NVDC.getDefaultInputFolder
MsgBox "OutputFolder="& NVDC.getOutputFolder(inputFolder)
getErrorFolder
Returns the error folder associated with a specified input folder in Document Converter.
Syntax
Res = NVDC.getErrorFolder(inputFolder)
Parameters
inputFolder - input folder;
getOrigFolder
Returns the folder for original documents associated with a specified input folder in Document Converter.
Syntax
Res = NVDC.getOrigFolder(inputFolder)
Parameters
inputFolder - input folder;
setParameter
Sets a conversion parameter. (see Conversion parameters for a full list)
Syntax
NVDC.setParameter(paramName, paramValue)
Parameters
paramName - parameter name;
paramValue - parameter value (string);
Example
NVDC.setParameter("DocumentOutputFormat", "PDF")
setParserParameter
Sets a parser-specific parameter. (see Parser-specific parameters for a full list)
Syntax
NVDC.setParserParameter(parserID, paramName, paramValue)
Parameters
parserID - parser ID (name);
paramName - parameter name;
paramValue - parameter value;
Example
NVDC.setParserParameter( "WORD", "Orientation", "2" )
getParserParameter
Returns the value of a parser-specific parameter previously set by the setParserParameter method.
Syntax
Res = NVDC.getParserParameter(parserID, paramName)
Parameters
parserID - parser ID (name);
paramName - parameter name;
setAddinParameter
Sets an add-in specific parameter. (see Addin-specific parameters for a full list)
Syntax
NVDC.setAddinParameter(addinID, paramName, paramValue)
Parameters
addinID - addin ID (name) ;
paramName - parameter name;
paramValue - parameter value;
getAddinParameter
Returns the value of an addin-specific parameter previously set by the setAddinParameter method.
Syntax
Res = NVDC.getAddinParameter(addin, paramName)
Parameters
addin - installed add-in(s) name;
paramName - parameter name;
deletePDFpages
Deletes pages from a specified PDF document.
Syntax
Res = NVDC.deletePDFpages(inFile, outFile, fromPage, toPage)
Parameters
inFile - full path to PDF file to delete pages from;
outFile - full path to destination file;
fromPage - page number to start with;
toPage - page number to end with;
Remarks
Res<>0 on error.
rotatePDFpages
Rotates page(s) in a specified PDF document.
Syntax
Res = NVDC.rotatePDFpages(inFile, outFile, fromPage, toPage, rotate)
Parameters
inFile - full path to PDF file to rotate pages in;
outFile - full path to the destination file;
fromPage - page number to start with;
toPage - page number to end with;
rotate - rotate by (-270, -90, 0, 90, 180, 270) degrees;
Remarks
Res<>0 on error.
isPDFencrypted
Checks if a PDF file is encrypted.
Syntax
Res = NVDC.isPDFencrypted(filename)
Parameters
filename - path to file;
decryptPDF
Decrypts an existing PDF file.
Syntax
Res = NVDC.decryptPDF(srcFile, destFile, userPwd)
Parameters
srcFile - full path to the file that needs to be decrypted;
destFile - full path to the decrypted file;
userPwd - user password to be used in the decoding process;
Remarks
Res<>0 on error.
mergePDF
Merges two PDF files.
Syntax
Res = NVDC.mergePDF(firstFile, secondFile, outFile)
Parameters
firstFile - full path to first PDF file;
secondFile - full path to second PDF file;
outFile - full path to resulting file;
Remarks
Res<>0 on error.
mergeMultiplePDF
Merges multiple PDF files.
Syntax
Res = NVDC.mergeMultiplePDF(filesToMerge, destFile)
Parameters
filesToMerge - PDF files to merge, file names must be separated by +
destFile - output PDF file name;
Example
Res = NVDC.mergeMultiplePDF("c:\t1.pdf+c:\t2.pdf+c:\t3.pdf", "c:\out.pdf")
extractPDFpages
Extracts pages from an existing PDF file.
Syntax
NVDC.extractPDFpages(fileIN, fileOUT, extractFROM, extractTO)
Parameters
fileIN - input PDF file name;
fileOUT - output file name;
extractFROM - extract from this page;
extractTO - extract to this page;
Example
Res = NVDC.extractPDFpages("c:\in.pdf", "c:\out.pdf", 1, 4)
(this will extract pages 1,2,3 and 4 from c:\in.pdf into c:\out.pdf)
Remarks
Res<>0 on error.
mergeTIFF
Merges two TIFF files.
Syntax
Res = NVDC.mergeTIFF(firstFile, secondFile, outFile)
Parameters
firstFile - full path to first TIFF file;
secondFile - full path to second TIFF file;
outFile - full path to resulting file;
Remarks
Res<>0 on error.
splitTIFF
Splits an existing TIFF file.
Syntax
Res = NVDC.splitTIFF(fileToSplit, destFolder)
Parameters
fileToSplit - path to input TIFF file;
destFolder - path to destination folder;
Example
Res = NVDC.splitTIFF("c:\t1.tif", "c:\")
Remarks
Res<>0 on error.
extractTIFFpages
Extracts pages from an existing TIFF file.
Syntax
NVDC.extractTIFFpages(fileIN, fileOUT, extractFROM, extractTO)
Parameters
fileIN - input TIFF file name;
fileOUT - output TIFF file name;
extractFROM - extract from this page;
extractTO - extract to this page;
Example
Res = NVDC.extractTIFFpages("c:\in.tif", "c:\out.tif", 1, 4)
(this will extract pages 1,2,3 and 4 from c:\in.tif into c:\out.tif)
Remarks
Res<>0 on error.
getNumPages
Returns the number of pages in the specified PDF/TIFF document.
Syntax
Res = NVDC.getNumPages(fileName)
Parameters
filename - path to file;
getBaseName
Returns the file name (less any file extension) from a path.
Syntax
Res = NVDC.getBaseName(path)
Parameters
path - file path;
getExtensionName
Returns the file extension from file name.
Syntax
Res = NVDC.getExtensionName( filename )
fileExists
Checks if a specified file exists.
Syntax
Res = NVDC.fileExists(fileToCheck)
Parameters
fileToCheck - path to the file to check;
fileCopy
Copies a file from source to destination.
Syntax
Res = NVDC.fileCopy(srcFile, destFile)
Parameters
srcFile - path to source file;
destFile - path to destination file;
fileDelete
Deletes a specified file.
Syntax
Res = NVDC.fileDelete(filename)
Parameters
filename - path to the file to delete;
createFolder
Creates a folder.
Syntax
Res = NVDC.createFolder(fldrName)
Parameters
fldrName - folder name;
copyFolder
Copies a folder from source to destination.
Syntax
Res = NVDC.copyFolder(srcFolder, destFolder)
Parameters
srcFolder - source path;
destFolder - destination path;
converterPath
Returns the path to the Document Converter.
Syntax
Res = NVDC.converterPath
Data Type: String
isConverterActive
Checks if Document Converter is in the memory.
Syntax
Res = NVDC.isConverterActive
Data Type: Boolean
GUID
Returns an unique identifier.
Syntax
Res = NVDC.GUID
Data Type: String
DocumentOutputFolder
Specifies the folder where the converted document will go.
Syntax
NVDC.setParameter("DocumentOutputFolder", value)
Data type: String
Note: Can only be set before calling the submitFile method.
DocumentErrorFolder
Specifies the folder where the document will go if it cannot be converted.
Syntax
NVDC.setParameter("DocumentErrorFolder", value)
Data type: String
Note: Can only be set before calling the submitFile method.
DocumentOriginalFolder
Specifies the folder where the original document will go.
Syntax
NVDC.setParameter("DocumentOriginalFolder", value)
Data type: String
Note: Can only be set before calling the submitFile method.
DocumentPassword
Specifies the password to use with PDF/Word/Excel/OpenOffice documents that require password.
Syntax
NVDC.setParameter("DocumentPassword", value)
Data type: String
Note: Can only be set before calling the submitFile method.
RecipientAddress
Email address to send the converted document to.
Syntax
NVDC.setParameter("RecipientAddress", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPServerAddress
Specifies the SMTP server address.
Syntax
NVDC.setParameter("SMTPServerAddress", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPUser
Specifies the SMTP user name.
Syntax
NVDC.setParameter("SMTPUser", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPPassword
Specifies the SMTP account password.
Syntax
NVDC.setParameter("SMTPPassword", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPPort
Specifies the SMTP port to use.
Syntax
NVDC.setParameter("SMTPPort", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPFromName
Specifies the email sender’s name.
Syntax
NVDC.setParameter("SMTPFromName", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPFromAddress
Specifies the email sender’s address.
Syntax
NVDC.setParameter("SMTPFromAddress", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPSuccessSubject
Specifies the email subject to send on successful conversion.
Syntax
NVDC.setParameter("SMTPSuccessSubject", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPSuccessBody
Specifies the email body to send on successful conversion.
Syntax
NVDC.setParameter("SMTPSuccessBody", value)
Data type: String
Note: Can only be set before calling the submitFile method.
SMTPErrorBody
Specifies the email body to send on conversion error.
Syntax
NVDC.setParameter("SMTPErrorBody", value)
Data type: String
Note: Can only be set before calling the submitFile method.
ScriptSrc
Specifies the script to execute before/after conversion. (see SCRIPTING section in the user manual)
Syntax
NVDC.setParameter("ScriptSrc", value)
Data type: String
Note: Can only be set before calling the submitFile method.
ScriptLang
Specifies the scripting language to use.
Possible values: "VBScript", "JavaScript"
Syntax
NVDC.setParameter("ScriptLang", value)
Data type: String
Note: Can only be set before calling the submitFile method.
ScriptTimeout
Specifies the timeout (in milliseconds) for the script execution.
Syntax
NVDC.setParameter("ScriptTimeout", value)
Data type: String
Note: Can only be set before calling the submitFile method.
ScriptAllowUI
Specifies whether to allow the script to display visual elements like InputBox and MsgBox.
Possible values: "true", "false"
Syntax
NVDC.setParameter("ScripAllowUI", value)
Data type: String
Note: Can only be set before calling the submitFile method.
MultiThreadedPrinting
Specifies whether Document Converter should use multiple threads when printing.
Possible values: "true", "false".
Syntax
NVDC.setParameter("MultiThreadedPrinting", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PRINTER".
PrintEngine
Specifies the print engine Document Converter should use.
Possible values: "0" (Native application, if possible), "1" (Neevia bitmap engine).
Syntax
NVDC.setParameter("PrintEngine", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PRINTER".
PrintColors
Specifies how Document Converter should print the document.
Possible values: "0" (black and white), "1" (grayscale), "2" (full color).
Syntax
NVDC.setParameter("PrintColors", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PRINTER" and "PrintEngine" is "1".
ShrinkToFit
Specifies whether Document Converter should scale the input document to match printable area.
Possible values: "true", "false".
Syntax
NVDC.setParameter("ShrinkToFit", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PRINTER" and "PrintEngine" is "1".
LanguageLevel
Specifies what PostScript language level Document Converter should use when generating the output file.
Possible values: "1" (PostScript language level 1)
"1.5" (PostScript language level 1.5)
"2" (PostScript language level 2)
"3" (PostScript language level 3)
Syntax
NVDC.setParameter("LanguageLevel", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PS" or "EPS".
TIFFType
Sets image type when output format is "TIFF".
Possible values:
"tiff24nc", (Color - 24bits RGB output, uncompressed)
"tiff32nc", (Color - 32bits CMYK output, uncompressed)
"tiff24lzw", (Color - 24bits RGB, LZW-compatible compression)
"tiff32lzw", (Color - 32bits CMYK, LZW-compatible compression)
"tiff24zip", (Color - 24bits RGB, ZIP (Deflate) compression)
"tiff32zip", (Color - 32bits CMYK, ZIP (Deflate) compression)
"tiffgray", (Grayscale - 8bits output, uncompressed)
"tiffgraylzw", (Grayscale - 8bits output, LZW-compatible compression)
"tiffgrayzip", (Grayscale - 8bits output, ZIP (Deflate) compression)
"tiffg3", (B&W - G3 fax encoding with EOLs)
"tiffg32d", (B&W - 2-D G3 fax encoding)
"tiffg4", (B&W - G4 fax encoding)
"tifflzw", (B&W - LZW-compatible compression)
"tiffpack", (B&W - PackBits compression)
Syntax
NVDC.setParameter("TiffType", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"TIFF".
MultiPageTIFF
Specifies whether Document Converter should create multipage tiff files.
Possible values:
"true" (creates a multipage tiff file)
"false" (creates a tiff file for the each page in the input document)
Syntax
NVDC.setParameter("MultiPageTIFF", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"TIFF".
FillOrder
Sets fill order for the TIFF output format.
Possible values: "0" msb-to-lsb, "1" lsb-to-msb.
Syntax
NVDC.setParameter("FillOrder", value)
Data type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"TIFF".
JPGQuality
Sets image quality when output format is "JPG".
Possible values: "1"..."100".
Syntax
NVDC.setParameter("JPGQuality", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"JPG".
BMPType
Sets image type when output format is "BMP".
Possible values:
"bmp16m", (Color - 16m colors RGB output)
"bmp16", (Color - 16 colors RGB output)
"bmp256", (Color - 256 colors RGB output)
"bmpgray", (Grayscale output)
"bmpmono", (Monochrome output)
Syntax
NVDC.setParameter("BMPType", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"BMP".
PSDType
Sets image type when output format is "PSD".
Possible values:
"psdrgb", (Color - 24bits RGB output)
"psdcmyk". (Color - 32bits CMYK output)
Syntax
NVDC.setParameter("PSDType", value)
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PSD".
PNGType
Sets image type when output format is "PNG".
Possible values:
"png16m", (Color - 16m colors output)
"png16", (Color - 16 colors output)
"png256", (Color - 256 colors output)
"pnggray", (Grayscale output)
"pngmono", (Monochrome output)
Syntax
NVDC.setParameter("PNGType", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PNG".
PXLType
Sets image type when output format is "PXL".
Possible values:
"pxlcolor", (Color - 24bits RGB output)
"pxlmono", (Monochrome output)
Syntax
NVDC.setParameter("PXLType", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PXL".
ConstrainProportions
Specifies whether Document Converter should constrain proportions when scaling the output document.
Possible values: "true", "false"
Syntax
NVDC.setParameter("ConstrainProportions", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX" and ScalePage is "true".
ScaleIfLarger
Instructs Document Converter to perform scaling only if the input document is larger than the output.
Possible values: "true", "false"
Syntax
NVDC.setParameter("ScaleIfLarger", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX" and ScalePage is "true".
PlaceContentIn
Specifies where Document Converter should place the original page content on the scaled page.
Possible values: "0" (left-bottom corner), "1" (right-bottom corner), "2" (center), "3" (center-top),
"4" (center-bottom), "5" (left-center), "6" (right-center), "7" (left-top corner),
"8" (right-top corner)
Syntax
NVDC.setParameter("PlaceContentIn", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX" and ScalePage is "true".
ImgWidth
Specifies the output document width (in pixels).
Syntax
NVDC.setParameter("ImgWidth", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX".
ImgResH
Specifies the output document horizontal resolution (in dpi).
Syntax
NVDC.setParameter("ImgResH", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX".
ImgResV
Specifies the output document vertical resolution (in dpi).
Syntax
NVDC.setParameter("ImgResV", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX".
TextAlphaBits
Controls the use of subsample antialiasing for text content. The subsampling box size should be 4 bits for
optimum output, but smaller values can be used for faster rendering.
Possible Values: "0", "1", "2", "4"
Syntax
NVDC.setParameter("TextAlphaBits", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX".
GraphicsAlphaBits
Controls the use of subsample antialiasing for graphics content. The subsampling box size should be 4 bits
for optimum output, but smaller values can be used for faster rendering.
Possible Values: "0", "1", "2", "4"
Syntax
NVDC.setParameter("GraphicsAlphaBits", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"TIFF", "JPG", "BMP", "PNG" or "PCX".
Because of the way antialiasing blends the edges of shapes into the background when they are drawn, some files
that rely on joining separate filled polygons together to cover an area may not render as expected with Graphics
antialiasing at 2 or 4 bits. If you encounter strange lines within solid areas, try rendering that file again with
Graphic antialiasing at 1 bit.
Interpolate
Specifies whether the image parser should use image interpolation. Enabling image interpolation will result
in higher quality for scaled images at the expense of speed.
Possible Values: "true", "false"
Syntax
NVDC.setParameter("Interpolate", value)
Data Type: String
UseCIEColor
Specifies whether the image parser should remap the device-dependent color values through a CIE color
space. This can improve the conversion of CMYK documents to RGB.
Possible Values: "true", "false"
Syntax
NVDC.setParameter("UseCIEColor", value)
Data Type: String
DitheringMethod
Specifies the dithering algorithm Document Converter should use when producing B&W FAX TIFF files.
Possible Values: "0" (sierra), "1" (burkes), "2" (stucki), "3" (floyd), "4" (jarvis), "5" (cluster 6x6), "6" (cluster 8x8),
"7" (cluster 16x16), "8" (bayer 4x4), "9" (bayer 8x8),
Syntax
NVDC.setParameter("DitheringMethod", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"FAX" or "SEND VIA FAX".
FaxServer
Specifies the Fax Server address.
Syntax
NVDC.setParameter("FaxServer", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
FaxNumber
Specifies the destination fax number.
Syntax
NVDC.setParameter("FaxNumber", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
RecipientName
Specifies the recipient name.
Syntax
NVDC.setParameter("RecipientName", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
TSID
Specifies the transmitting station identifier (TSID).
Syntax
NVDC.setParameter("TSID", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverPageSubject
Specifies the text to use for cover page Subject field.
Syntax
NVDC.setParameter("CoverPageSubject", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverPageNotes
Specifies the text to use for cover page Notes field.
Syntax
NVDC.setParameter("CoverPageNotes", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverFullName
Specifies the text to use for cover page "Sender’s Name" field.
Syntax
NVDC.setParameter("CoverFullName", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverFaxNumber
Specifies the text to use for cover page "Sender’s Fax" field.
Syntax
NVDC.setParameter("CoverFaxNumber", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverTitle
Specifies the text to use for cover page "Sender’s Title" field.
Syntax
NVDC.setParameter("CoverTitle", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverCompany
Specifies the text to use for cover page "Sender’s Company" field.
Syntax
NVDC.setParameter("CoverCompany", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverOffice
Specifies the text to use for cover page "Sender’s Office" field.
Syntax
NVDC.setParameter("CoverOffice", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverDepartment
Specifies the text to use for cover page "Sender’s Department" field.
Syntax
NVDC.setParameter("CoverDepartment", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverWorkPhone
Specifies the text to use for cover page "Sender’s Work Phone" field.
Syntax
NVDC.setParameter("CoverWorkPhone", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverAddress
Specifies the text to use for cover page "Sender’s Address" field.
Syntax
NVDC.setParameter("CoverAddress", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
CoverBillingCode
Specifies the billing code that applies to the fax transmission.
Syntax
NVDC.setParameter("CoverBillingCode", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"SEND VIA FAX".
OutputIntent
Specifies the PDF/A Output Intent.
Possible values: "srgb", "jc200103", "fogra27", "swop", "gray".
Syntax
NVDC.setParameter("OutputIntent", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDFA".
PDFAver
Specifies the PDF/A version.
Possible values: "1", "2", "3" where 1=PDF/A-1b, 2=PDF/A-2b and 3=PDF/A-3b
Syntax
NVDC.setParameter("PDFAver", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDFA".
LinearizePDF
Specifies whether the output PDF document should be linearized (optimized for fast web view).
Possible values: "true", "false".
Syntax
NVDC.setParameter("LinearizePDF", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
AttachOriginalFile
Specifies whether original file should be included as attachment in the converted PDF.
Possible values: "true", "false"
Syntax
NVDC.setParameter("AttachOriginalFile", value)
Data Type: String
DocumentPaperSize
Sets the output document paper size. Use x to separate width and height. For example 10inx20in will
specify an output paper size with 10 inches in width and 20 inches in height.
Syntax
NVDC.setParameter("DocumentPaperSize", value)
Example - set the output document paper size to 8x11 inches
NVDC.setParameter("DocumentPaperSize", "8inx11in")
Example - set the output document paper size to 100x200 millimeters
NVDC.setParameter("DocumentPaperSize", "100mmx200mm")
Example - set the output document paper size to 3x5 centimeters
NVDC.setParameter("DocumentPaperSize", "3cmx5cm")
Data Type: String
Note: Can only be set before calling the submitFile method.
ScalePage
Specifies whether Document Converter should scale the output document. If ScalePage is "false" output
document will be stripped to DocumentPaperSize, if ScalePage is "true" output document will be scaled to
DocumentPaperSize.
Syntax
NVDC.setParameter("ScalePage", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"PDF".
ConstrainProportions
Specifies whether Document Converter should constrain proportions when scaling the output document.
Possible values: "true", "false"
Syntax
NVDC.setParameter("ConstrainProportions", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
"PDF" and ScalePage is "true".
DocumentTitle
Sets the title field in the output PDF document.
Syntax
NVDC.setParameter("DocumentTitle", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
DocumentSubject
Sets the subject field in the output PDF document.
Syntax
NVDC.setParameter("DocumentSubject", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
DocumentAuthor
Sets the author field in the output PDF document.
Syntax
NVDC.setParameter("DocumentAuthor", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFAutoRotatePage
Specifies whether Document Converter should automatically rotate pages based on the orientation of the
text.
Possible values: "None" (will disable the Auto-Rotate Pages option)
"PageByPage" (will rotate each page based on the direction of the text on that page)
"All" (will rotate all pages in the document based on the orientation of the majority of text)
Syntax
NVDC.setParameter("PDFAutoRotatePage", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFCompressPages
Specifies whether text and line art in the output PDF document should be compressed.
Possible values: "true", "false"
Syntax
NVDC.setParameter("PDFCompressPages", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFEmbedAllFonts
Specifies whether fonts in the output PDF document should be embedded.
Possible values: "true", "false"
Syntax
NVDC.setParameter("PDFEmbedAllFonts", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFFontsMaxSubset
Sets the Subset Fonts threshold. If the percentage of used characters (compared with total characters of
the particular font) exceeds this threshold, the entire font is embedded.
Possible values: "0"..."100".
Syntax
NVDC.setParameter("PDFFontsMaxSubset", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFProcessColorModel
Sets the color model for the output PDF document.
Possible values: "DeviceRGB", "DeviceCMYK", "DeviceGRAY", "LeaveUnchanged"
Syntax
NVDC.setParameter("PDFProcessColorModel", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
CompressColorImages
Specifies whether the color images in the output PDF document should be compressed.
Possible values: "true", "false"
Syntax
NVDC.setParameter("CompressColorImages", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
CompressGrayImages
Specifies whether gray images in the output PDF document should be compressed.
Possible values: "true", "false"
Syntax
NVDC.setParameter("CompressGrayImages", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
GrayCompressMethod
Sets the compression method for gray images in the output PDF document.
Possible values: "Automatic", "JPEG-maximum", "JPEG-high", "JPEG-medium", "JPEG-low",
"JPEG-minimum", "ZIP".
Syntax
NVDC.setParameter("GrayCompressMethod", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
CompressMonoImages
Specifies whether monochrome images in the output PDF document should be compressed.
Possible values: "true", "false"
Syntax
NVDC.setParameter("CompressMonoImages", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
ColorImageResolution
Sets the resolution level for color images in the output PDF document.
Possible values: "10"..."2400".
Syntax
NVDC.setParameter("ColorImageResolution", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
GrayImageResolution
Sets the resolution level for gray images in the output PDF document.
Possible values: "10"..."2400".
Syntax
NVDC.setParameter("GrayImageResolution", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
MonoImageResolution
Sets the resolution level for mono images in the output PDF document.
Possible values: "10"..."2400".
Syntax
NVDC.setParameter("MonoImageResolution", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
ColorImageDownsampleType
Possible values: "Bicubic", "Average", "Subsample".
Syntax
NVDC.setParameter("ColorImageDownsampleType", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
DownsampleGrayImages
Specifies whether gray images in the output PDF document should be downsampled.
Possible values: "true", "false"
Syntax
NVDC.setParameter("DownsampleGrayImages", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
GrayImageDownsampleType
Possible values: "Bicubic", "Average", "Subsample".
Syntax
NVDC.setParameter("GrayImageDownsampleType", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
DownsampleMonoImages
Specifies whether monochrome images in the output PDF document should be downsampled.
Possible values: "true", "false"
Syntax
NVDC.setParameter("DownsampleMonoImages", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
MaxInlineImageSize
Sets the maximum size of an inline image in bytes.
Default value: "4000"
Syntax
NVDC.setParameter("MaxInlineImageSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if DocumentOutputFormat is
“PDF”. For images larger than this size, Document Converter Pro will create a XObject instead of embedding the
image into the context stream. Note that redundant inline images must be embedded each time they occur in
the document, while multiple references can be made to a single XObject image. Therefore it may be
advantageous to set a small or zero value if the source document is expected to contain multiple identical images,
reducing the size of the generated PDF.
ParseDSCComments
Intructs the conversion engine whether to parse PS/EPS DSC comments.
Possible values: "true", "false"
Syntax
NVDC.setParameter("ParseDSCComments", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DefaultRenderingIntent
Sets the default rendering intent.
Possible values: "0" (Default)
"1" (Perceptual)
"2" (Saturation)
"3" (RelativeColorimetric)
"4" (AbsoluteColorimetric)
Syntax
NVDC.setParameter("DefaultRenderingIntent", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UCRandBGInfo
Specifies whether under color removal and black generation settings should be preserved.
Possible values: "true", "false"
Syntax
NVDC.setParameter("UCRandBGInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
TransferFunctionInfo
Specifies whether transfer function information should be preserved.
Possible values: "true", "false"
Syntax
NVDC.setParameter("TransferFunctionInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PreserveHaltoneInfo
Specifies whether halftone information should be preserved.
Possible values: "true", "false"
Syntax
NVDC.setParameter("PreserveHalftoneInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFEncryption
Specifies whether the output PDF document should be encrypted.
Possible values: "true", "false"
Syntax
NVDC.setParameter("PDFEncryption", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
PDFEncryptionMethod
Sets the encryption method.
Possible values: "40" (low - 40 bits encryption, Acrobat 3-and-later compatible)
"rc4" (high - 128 bits encryption, Acrobat 5-and-later compatible)
"aes" (high - 128 bits encryption, Acrobat 6-and-later compatible)
"aes256" (high - 256 bits encryption, Acrobat 9-and-later compatible)
Syntax
NVDC.setParameter("PDFEncryptionMethod", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFEncryptMeta
Specifies whether metadata in the output PDF file should be encrypted.
Possible values: "true", "false"
Syntax
NVDC.setParameter("PDFEncryptMeta", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFUserPassword
Sets the user password in the output PDF document. Users will be asked to enter this password before
Acrobat Reader allows them to view the PDF document.
Syntax
NVDC.setParameter("PDFUserPassword", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
PDFPermissions
Sets PDF security permissions to use for encrypting output file.
Possible values:
"p" - document printing is denied
"c" - changing the document is denied
"s" - selection and copying of text and graphics is denied
"a" - adding or changing annotations or form fields is denie
The following flags are defined for 128 bits and higher encryption:
"i" - disables editing of form fields
"e" - disables extraction of text and graphics
"d" - disables document assembly
"q" - disables high quality printing
Syntax
NVDC.setParameter("PDFPermissions", value)
Example
NVDC.setParameter( "PDFPermissions", "p" )
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
OpenMagnification
Specify the open magnification in % for the output document.
Possible values: "0" (Default)
"1" (Actual Size)
"2" (Fit Page)
"3" (Fit Width)
"4" (Fit Height)
"5" (Fit Visible)
"6" (Zoom 25%)
"7" (Zoom 50%)
"8" (Zoom 75%)
"9" (Zoom 100%)
"10" (Zoom 125%)
"11" (Zoom 150%)
"12" (Zoom 200%)
"13" (Zoom 400%)
"14" (Zoom 800%)
"15" (Zoom 1600%)
"16" (Zoom 2400%)
"17" (Zoom 3200%)
"18" (Zoom 6400%)
Syntax
NVDC.setParameter("OpenMagnification", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
FullScreen
Specifies whether Acrobat Reader should maximize the document window and display converted PDF
documents without the menu bar, toolbar, or window controls.
Possible values: "true", "false"
Syntax
NVDC.setParameter("FullScreen", value)
Data Type: String
Note: take into account that if you hide the menu bar and toolbars users cannot apply commands and select
tools unless they know the keyboard shortcuts.
PageLayout
Specifies page layout to use when output file is opened in PDF viewer.
Possible values: "1" (Display one page at a time)
"2" (Display the pages in one column)
"3" (Display the pages in two columns, with odd numbered pages on the left)
"4" (Display the pages in two columns, with odd numbered pages on the right)
"5" (Display the pages two at a time, with odd numbered pages on the left)
"6" (Display the pages two at a time, with odd numbered pages on the right)
Syntax
NVDC.setParameter("PageLayout", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "DocumentOutputFormat" is
"PDF".
HideMenuBar
Specifies whether Acrobat Reader should hide the menu bar when displaying the output PDF document.
Possible values: "true", "false"
Syntax
NVDC.setParameter("HideMenuBar", value)
Data Type: String
HideToolbar
Specifies whether Acrobat Reader should hide the toolbar when displaying PDF documents.
Possible values: "true", "false"
Syntax
NVDC.setParameter("HideToolbar", value)
Data Type: String
FitWindow
Specifies whether Acrobat Reader should adjust the document window to fit snugly around the opening
page when displaying PDF documents.
Possible values: "true", "false"
Syntax
NVDC.setParameter("FitWindow", value)
Data Type: String
CenterWindow
Specifies whether Acrobat Reader should position the window in the center of the screen area when
displaying PDF documents.
Possible values: "true", "false"
Syntax
NVDC.setParameter("CenterWindow", value)
Data Type: String
StampText
Specifies the text to use as watermark. (See Appendix B for the list of supported variables)
Syntax
NVDC.setParameter("StampText", value)
Data Type: String
StampFile
Specifies the file to load stamp commands from. (See Appendix A for stamp file format info)
Syntax
NVDC.setParameter("StampFile", value)
Data Type: String
Example
NVDC.setParameter( "StampFile", "c:\stamp.nsp" )
Commands contained in stamp.nsp:
\stamp 0
\stampname SampleStamp
\text CONFIDENTIAL
\x center
\y center
\units 1
\fontname Arial
\fontcolor #00FF00
StampFontColor
Specifies the watermark font color.
Syntax
NVDC.setParameter("StampFontColor", value)
Example
NVDC.setParameter( "StampFontColor", "#000000" )
Data Type: String
StampFontName
Specifies the watermark font name.
Syntax
NVDC.setParameter("StampFontName", value)
Example
NVDC.setParameter( "StampFontName", "Arial" )
Data Type: String
StampFontEmbed
Specifies whether fonts should be embedded.
Possible values: "true", "false"
Syntax
NVDC.setParameter("StampFontEmbed", value)
Data Type: String
StampFontSubset
Specifies whether fonts should be subset.
Possible values: "true", "false"
Syntax
NVDC.setParameter("StampFontSubset", value)
Data Type: String
StampTextRenderingMode
Specifies the text rendering mode.
Possible values:
"0" - Fill text, no stroke (default)
"1" - Stroke text, no fill
"2" - Fill then Stroke text
"3" - Invisible
Fill text, no stroke Stroke text, no fill Fill then stroke text
Syntax
NVDC.setParameter("StampTextRenderingMode", value)
Data Type: String
StampScale
Specifies by how much (in percent) to scale the stamp. Default value: "100"
Syntax
NVDC.setParameter("StampScale", value)
Example
NVDC.setParameter( "StampScale", "200" )
Data Type: String
Note: will have effect only for Image and PDFOverlay stamps.
StampFontColor
Specifies font color in RGB colorspace.
Syntax
NVDC.setParameter("StampFontColor", value)
Example
NVDC.setParameter( "StampFontColor", "#FF0000" )
Data Type: String
StampFontColorGray
Specifies font color in Gray colorspace.
Syntax
NVDC.setParameter("StampFontColorGray", value)
Example
NVDC.setParameter( "StampFontColorGray", "#77" )
Data Type: String
StampFontColorCMYK
Specifies font color in CMYK colorspace.
Syntax
NVDC.setParameter("StampFontColorCMYK", value)
Example
NVDC.setParameter( "StampFontColorCMYK", "#000000FF" )
Data Type: String
StampStrokeColorGray
Specifies font stroke color in Gray colorspace.
Syntax
NVDC.setParameter("StampStrokeColorGray", value)
Example
NVDC.setParameter( "StampStrokeColorGray", "#77" )
Data Type: String
StampStrokeColorCMYK
Specifies font stroke color in CMYK colorspace.
Syntax
NVDC.setParameter("StampStrokeColorCMYK", value)
Example
NVDC.setParameter( "StampStrokeColorCMYK", "#000000FF" )
Data Type: String
StampStrokeWidth
Specifies the stroke width.
Syntax
NVDC.setParameter("StampStrokeWidth", value)
Data Type: String
StampRotate
Specifies the watermark rotation angle in degrees.
Syntax
NVDC.setParameter("StampRotate", value)
Data Type: String
PlaceStampOnPages
Specifies the pages to place watermark/stationery on.
Syntax
NVDC.setParameter("PlaceStampOnPages", value)
Example
NVDC.setParameter( "PlaceStampOnPages", "1,3,7" )
(will place watermark on pages 1, 3 and 7)
Data Type: String
Note: page numbers must be separated by commas. To place the watermark/stationery on all pages specify "0".
StampUnits
Specifies measurement unit to use for the StampX and StampY properties.
Possible values: "0" (points), "1" (inches), "2" (centimeters), "3" (millimeters)
Syntax
NVDC.setParameter("StampUnits", value)
Data Type: String
StampX
Specifies the watermark X coordinate.
Syntax
NVDC.setParameter("StampX", value)
Data Type: String
Note: you can use as values, instead of numbers "center", "left" and "right" - as the name suggests they will
position the watermark in the center of the page, on the left or right.
StampY
Specifies the watermark Y coordinate.
Syntax
NVDC.setParameter("StampY", value)
Data Type: String
Note: you can use as values, instead of numbers "center", "top" and "bottom" - as the name suggests they will
position the watermark in the center of the page, on top or in the bottom.
StampHeight
Specifies the stamp height.
Syntax
NVDC.setParameter("StampHeight", value)
Data Type: String
Note: will have effect only for TextBox and Image stamps.
StampTextBox
Specifies the watermark text to use inside a text box. (See Appendix B for the list of supported variables)
Syntax
NVDC.setParameter("StampTextBox", value)
Data Type: String
StampTextAlign
Specifies how the text to use inside a textbox stamp should be aligned.
Possbile values: "1" (left), "2" (right), "3" (center)
Syntax
NVDC.setParameter("StampTextAlign", value)
Data Type: String
StampWordWrap
Specifies whether to enable Word Wrap in case text does not fit in one line.
Possbile values: "true", "false"
Syntax
NVDC.setParameter("StampWordWrap", value)
Data Type: String
StampWebLink
Specifies the web address to go to when the stamp is clicked.
Syntax
NVDC.setParameter("StampWebLink", value)
Data Type: String
StampUseCropBox
Specifies whether to use the page crop box to position stamp.
Possbile values: "true", "false"
Syntax
NVDC.setParameter("StampUseCropBox", value)
Data Type: String
StampUsePageRotation
Specifies whether to use the page rotation parameter when placing stamp.
Possbile values: "true", "false"
Syntax
NVDC.setParameter("StampUsePageRotation", value)
Data Type: String
StampPlaceAs
Specifies how to place stamp on page.
Possible values: "0" as stamp: over page content (Default),
"1" as watermark: under page content
Syntax
NVDC.setParameter("StampPlaceAs", value)
Data Type: String
StampImage
Specifies the image file to use as stamp. Supported formats: GIF, PNG, JPEG, TIFF and BMP.
Syntax
NVDC.setParameter("StampImage", value)
Example
NVDC.setParameter( "StampImage", "c:\image.gif" )
Data Type: String
StampPDFOverlayPage
Specifies the page to use as overlay from the PDFOverlay file. Default value: "1"
Syntax
NVDC.setParameter("StampPDFOverlayPage", value)
Data Type: String
CreatePageBookmarks
Specifies whether bookmarks should be created during merging.
Possible values: "true", "false"
Syntax
NVDC.setParameter("CreatePageBookmarks", value)
Data Type: String
Note: Will have effect only when used in conjunction with the mergePDF method.
CreateNewBookmarks
Specifies whether new bookmarks should be created during merging.
Possible values: "true", "false"
Syntax
NVDC.setParameter("CreateNewBookmarks", value)
Data Type: String
Note: Will have effect only when used in conjunction with mergePDF method.
BookmarksFile
Specifies path to the file that contains the new bookmarks to add while merging files.
Syntax
NVDC.setParameter("BookmarksFile", value)
Data Type: String
Note: Will have effect only when used in conjunction with mergePDF method.
SplitByBookmarks
Specifies whether PDF files should be split by bookmarks.
Possible values: "true", "false"
Syntax
NVDC.setParameter("SplitByBookmarks", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF method.
BkLevel
Specifies the lowest bookmark level to split by.
Default value: "1"
Syntax
NVDC.setParameter("BkLevel", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF method and SplitByBookmarks = true.
NameByBk
Specifies whether to name output PDF file(s) according to bookmark titles.
Possible values: "true", "false"
Syntax
NVDC.setParameter("nameByBk", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF method and SplitByBookmarks = true.
RemoveAnnotations
Specifies whether to remove text annotations from the output PDF file(s).
Possible values: "true", "false"
Syntax
NVDC.setParameter("RemoveAnnotations", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF or mergePDF methods.
RemoveAcroForms
Specifies whether to remove PDF forms from the output PDF file(s).
Possible values: "true", "false"
Syntax
NVDC.setParameter("RemoveAcroForms", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF or mergePDF methods.
RemovePageLabels
Specifies whether to remove page labels from the output PDF file(s).
Possible values: "true", "false"
Syntax
NVDC.setParameter("RemovePageLabels", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF or mergePDF methods.
RemoveLayers
Specifies whether to remove layers from the output PDF file(s).
Possible values: "true", "false"
Syntax
NVDC.setParameter("RemoveLayers", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF or mergePDF methods.
RemoveArticleThreads
Specifies whether to remove article threads from the output PDF file(s).
Possible values: "true", "false"
Syntax
NVDC.setParameter("RemoveArticleThreads", value)
Data Type: String
Note: Will have effect only when used in conjunction with splitPDF or mergePDF methods.
ParserTimeout
Sets timeout (in seconds) for the PSPDF parser.
Syntax
NVDC.setParserParameter("PSPDF", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RenderingThreads
Sets the maximum number of simultaneous rendering threads.
Note: The number of threads should generally be set to the number of available processor cores for best
throughput.
Syntax
NVDC.setParserParameter("PSPDF", "RenderingThreads", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
VirtualMemory
Specifies the virtual memory available to the PostScript interpreter (in Megabytes).
Syntax
NVDC.setParserParameter("PSPDF", "VirtualMemory", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
PDFtoPDF
Specifies whether Document Converter should reparse PDF files when converting them to PDF format.
Possible Values: "true", "false"
Syntax
NVDC.setParserParameter("PSPDF", "PDFtoPDF", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseCropBox
Specifies whether Document Converter should use CropBox for paper size rather than MediaBox when
converting PDF files.
Possible Values: "true", "false"
Syntax
NVDC.setParserParameter("PSPDF", "UseCropBox", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
CropEPS
Specifies whether Document Converter should crop the EPS/PostSCript files to the bounding box.
Possible Values: "true", "false"
Syntax
NVDC.setParserParameter("PSPDF", "CropEPS", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseDistiller
Specifies whether Document Converter should use Adobe Distiller as PostScript to PDF conversion engine.
Possible Values: "true", "false"
Syntax
NVDC.setParserParameter("PSPDF", "UseDistiller", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
OpenPassword
Specifies the open password to use when converting encrypted PDF files.
Syntax
NVDC.setParserParameter("PSPDF", "OpenPassword", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the IMAGE/OCR parser.
Syntax
NVDC.setParserParameter("IMAGE/OCR", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Rotate
Specifies how Document Converter should handle image rotation/orientation.
Possible Values: "0" preserve original, "1" rotate landscape images 90 degrees, "2" rotate landscape
images -90 degrees, "3" rotate portrait images 90 degrees, "4" rotate portrait images -90 degrees
Syntax
NVDC.setParserParameter("IMAGE/OCR", "Rotate", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
OCR
Specifies whether Document Converter should perform OCR (Optical Character Recognition) when
converting images to PDF.
Possible Values: "true", "false"
Syntax
NVDC.setParserParameter("IMAGE/OCR", "OCR", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
OCRlang
Sets the OCR language.
Possible Values: "0" English, "1" Czech, "2" Danish, "3" Dutch, "4" Finnish, "5" French, "6" German,
"7" Greek, "8" Hungarian, "9" Italian, "10" Japanese, "11" Korean, "12" Norwegian,
"13" Polish, "14" Portuguese, "15" Russian, "16" Spanish, "17" Swedish, "18" Turkish,
"19" Chinese Traditional, "20" Chinese Simplified
Syntax
NVDC.setParserParameter("IMAGE/OCR", "OCRlang", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "OCR" is "true".
AutoStraighten
Specifies whether the OCR engine should attempt to "de-skew" the page to correct for small angles of
misalignment from the vertical. Possible Values: "true", "false"
Syntax
NVDC.setParserParameter("IMAGE/OCR", "AutoStraighten", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "OCR" is "true".
ParserTimeout
Sets timeout (in seconds) for the WORD parser.
Syntax
NVDC.setParserParameter("WORD", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether WORD parser should use the same static printer or create a new printer for each
conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFExport
Instructs the WORD parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "UseNativePDFExport", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid for Word 2007 and higher.
ConvertDocInfo
Specifies whether metadata (title, author, subject) in the original document should be converted to PDF
metadata. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertDocInfo", value)
ConvertHeadings
Specifies whether Word Headings should be converted into PDF bookmarks.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertHeadings", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
CreateLinksFromTOC
Specifies whether table of contents links should be preserved when converting Word documents to PDF
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "CreateLinksFromTOC", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertCrossReferenceLinks
Specifies whether cross reference links should be preserved when converting Word documents to PDF
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertCrossReferenceLinks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertCrossDocLinks
Specifies whether cross document links should be preserved when converting Word documents to PDF
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertCrossDocLinks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertCommentsToPDFNotes
Specifies whether comments in the original document should be converted to PDF notes.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertCommentsToPDFNotes", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertFootnoteLinks
Specifies whether footnote links should be preserved when converting Word documents to PDF
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertFootnoteLinks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertPageLabels
Specifies whether page labels should be preserved when converting Word documents to PDF
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertPageLables", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertBookmarksToNamedDest
Specifies whether bookmarks in the original document should be converted into PDF named destinations.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "ConvertBookmarksToNamedDest", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
BookmarkOpenDepth
Sets bookmark open level when converting Word bookmarks to PDF bookmarks.
Syntax
NVDC.setParserParameter("WORD", "BookmarkOpenDepth", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkType
Specifies the type of rectangle PDF links should be placed into.
Possible values: "0" (Invisible), "1" (Thin), "2" (Thick)
Syntax
NVDC.setParserParameter("WORD", "LinkType", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkStyle
Specifies the border style PDF links will use.
Possible values: "0" (solid), "1" (dashed)
Syntax
NVDC.setParserParameter("WORD", "LinkStyle", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkColor
Specifies the border color of the PDF link rectangle.
Possible values: "0" black, "1" red, "2" green, "3" yellow, "4" blue, "5" magenta, "6" cyan, "7" white.
Syntax
NVDC.setParserParameter("WORD", "LinkColor", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkHighlight
Specifies the type of highlight for the PDF link rectangle.
Possible values: "0" none, "1" invert, "2" outline, "3" inset.
Syntax
NVDC.setParserParameter("WORD", "LinkHighLight", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
AutoRenameFormFields
Specifies whether auto rename form fields in the original document should be preserved when
converting to PDF. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "AutoRenameFormFields", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
HideCheckBox
Specifies whether the checkbox border in the original document should be hidden when converting to
PDF. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "HideCheckBox", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
HideTextInput
Specifies whether the textbox input border in the original document should be hidden when converting
to PDF. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "HideTextInput", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
HideDropDown
Specifies whether the dropdown box border in the original document should be hidden when converting
to PDF. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "HideDropDown", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DetectPageSize
Specifies whether Document Converter should detect and convert Word custom page sizes.
Possible values: "true", "false".
Syntax
NVDC.setParserParameter("WORD", "DetectPageSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RemovePrintCodes
Specifies whether hidden print commands in the original Word document should be removed before
converting. Possible values: "true", "false".
Syntax
NVDC.setParserParameter("WORD", "RemovePrintCodes", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DisableMacros
Specifies whether MS Word macros should be disabled before converting.
Possible values:
"0" use the security settings from MS Word UI,
"1" disable "auto" macros,
"2" disable all macros in all files that are opened programmatically, without showing any security warnings,
"3" enable all macros.
Syntax
NVDC.setParserParameter("WORD", "DisableMacros", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UpdateLinksAtOpen
Specifies whether existing links in the original Word document should be updated before converting.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORD", "UpdateLinksAtOpen", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
PaperSize
Sets paper size for the converting Word document. (For supported paper sizes see Appendix C)
Syntax
NVDC.setParserParameter("WORD", "PaperSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Orientation
Sets the page orientation in Word document.
Posible values: "0" default, "1" portrait, "2" landscape
Syntax
NVDC.setParserParameter("WORD", "Orientation", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LeftMargin
Sets the left margin in Word document (in inches).
Syntax
NVDC.setParserParameter("WORD", "LeftMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TopMargin
Sets the top margin in Word document (in inches).
Syntax
NVDC.setParserParameter("WORD", "TopMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
BottomMargin
Sets the bottom margin in Word document (in inches).
Syntax
NVDC.setParserParameter("WORD", "BottomMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TXTOpenFormat
Specifies what open format the Word parser should use for converting TEXT files.
Possible values: "0" auto, "1" word, "2" rich text (rtf), "3" unencoded text, "4" unicode text.
Syntax
NVDC.setParserParameter("WORD", "TXTOpenFormat", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TXTAlign
Specifies how the Word parser should align text when convering TEXT files.
Possible values: "0" left, "1" center, "2" right, "3" justify.
Syntax
NVDC.setParserParameter("WORD", "TXTAlign", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Possible values:
"708" Arabic ASMO.
"51256" Web browser auto-detects type of Arabic encoding to use.
"720" Transparent Arabic.
"50001" Web browser auto-detects type of encoding to use.
"1257" Baltic.
"1250" Central European.
"1251" Cyrillic.
"51251" Web browser auto-detects type of Cyrillic encoding to use.
"20420" Extended Binary Coded Decimal Interchange Code (EBCDIC) Arabic.
"20277" EBCDIC as used in Denmark and Norway.
"20278" EBCDIC as used in Finland and Sweden.
"20297" EBCDIC as used in France.
"20273" EBCDIC as used in Germany.
"20423" EBCDIC as used in the Greek language.
"875" EBCDIC as used in the Modern Greek language.
"20424" EBCDIC as used in the Hebrew language.
"20871" EBCDIC as used in Iceland.
"500" International EBCDIC.
"20280" EBCDIC as used in Italy.
"20290" EBCDIC as used with Japanese Katakana (extended).
"50930" EBCDIC as used with Japanese Katakana (extended) and Japanese.
"50939" EBCDIC as used with Japanese Latin (extended) and Japanese.
"20833" EBCDIC as used with Korean (extended).
"50933" EBCDIC as used with Korean (extended) and Korean.
"20284" EBCDIC as used in Latin America and Spain.
"870" EBCDIC Multilingual ROECE (Latin 2).
"20880" EBCDIC as used with Russian.
"21025" EBCDIC as used with Serbian and Bulgarian.
ParserTimeout
Sets timeout (in seconds) for the EXCEL parser.
Syntax
NVDC.setParserParameter("EXCEL", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether EXCEL parser should use the same static printer or create a new printer for each
conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFExport
Instructs the EXCEL parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "UseNativePDFExport", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid for Excel 2007 and higher.
ConvertHyperlinks
Specifies whether Internet links should be preserved when converting Excel documents to PDF
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "ConvertHyperlinks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertDocInfo
Specifies whether original document info (metadata) should be preserved when converting Excel
documents to PDF.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "ConvertDocInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Syntax
NVDC.setParserParameter("EXCEL", "ConvertWhat", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertWorksheetIndex
Specifies which worksheet (by number) in the original Excel document will be converted. Output file will
contain as many pages as the original worksheet.
Syntax
NVDC.setParserParameter("EXCEL", "ConvertWorksheetIndex", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertWorksheet
Specifies which worksheet (by name) in the original Excel document will be converted. Output file will
contain as many pages as the original worksheet.
Syntax
NVDC.setParserParameter("EXCEL", "ConvertWorksheet", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkType
Specifies the type of rectangle PDF links should be placed into.
Possible values: "0" (Invisible), "1" (Thin), "2" (Thick)
Syntax
NVDC.setParserParameter("EXCEL", "LinkType", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkStyle
Specifies the border style PDF links will use.
Possible values: "0" (solid), "1" (dashed)
Syntax
NVDC.setParserParameter("EXCEL", "LinkStyle", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkHighlight
Specifies the type of highlight for the PDF link rectangle.
Possible values: "0" none, "1" invert, "2" outline, "3" inset.
Syntax
NVDC.setParserParameter("EXCEL", "LinkHighLight", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertSheetNamesToBookmarks
Specifies whether sheet names should be converted to PDF bookmarks.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "ConvertSheetNamesToBookmarks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertSheetNamesToNamedDest
Specifies whether sheet names should be converted to PDF named destinations. A PDF named
destination is a location in your PDF document that a destination link points to.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "ConvertDocInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DetectPageSize
Specifies whether Document Converter should detect and convert Excel custom page sizes.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "DetectPageSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ClearPrintArea
Specifies whether Excel should clear the print area in the converting document.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "ClearPrintArea", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
EnableAddins
Specifies whether Excel add-ins should be enabled before converting.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EXCEL", "EnableAddins", value)
Data Type: Boolean
Note: Can only be set before calling the submitFile method.
DisableMacros
Specifies whether Excel macros should be disabled before converting.
Possible values:
"0" use the security settings from MS Excel UI,
"1" disable all macros in all files that are opened programmatically, without showing any security warnings,
"2" enable all macros.
Syntax
NVDC.setParserParameter("EXCEL", "DisableMacros", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
PaperSize
Sets paper size for the converting Excel document. (For supported paper sizes see Appendix C)
Syntax
NVDC.setParserParameter("EXCEL", "PaperSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LeftMargin
Sets the left margin in Excel document (in inches).
Syntax
NVDC.setParserParameter("EXCEL", "LeftMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TopMargin
Sets the top margin in Excel document (in inches).
Syntax
NVDC.setParserParameter("EXCEL", "TopMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RightMargin
Sets the right margin in Excel document (in inches).
Syntax
NVDC.setParserParameter("EXCEL", "RightMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
BottomMargin
Sets the bottom margin in Excel document (in inches).
Syntax
NVDC.setParserParameter("EXCEL", "BottomMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Scaling
Sets the content scaling value for the converting Excel document.
Syntax
NVDC.setParserParameter("EXCEL", "Scaling", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the POWERPOINT parser.
Syntax
NVDC.setParserParameter("POWERPOINT", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether POWERPOINT parser should use the same static printer or create a new printer for
each conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("POWERPOINT", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFExport
Instructs the POWERPOINT parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("POWERPOINT", "UseNativePDFExport", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid for PowerPoint 2007 and higher.
ConvertHyperlinks
Specifies whether Internet links should be preserved when converting Powerpoint documents to PDF.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("POWERPOINT", "ConvertHyperlinks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertTransitions
Specifies whether transitions should be preserved when converting Powerpoint documents to PDF.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("POWERPOINT", "ConvertTransitions", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertHidenSlides
Specifies whether slides that are hidden should be preserved when converting Powerpoint documents to
PDF. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("POWERPOINT", "ConvertHidenSlides", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertView
Specifies how slides in the original document will be displayed when the resulting PDF is viewed.
Possible values: "0" default, "1" slides, "2" two slide handouts, "3" three slide handouts, "4" six slide handouts,
"5" notes pages, "6" outline, "7" build slides, "8" four slide handouts, "9" nine slide handouts,
"10" one slide handouts
Syntax
NVDC.setParserParameter("POWERPOINT", "ConvertView", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DetectPageSize
Specifies whether Document Converter should detect and convert PowerPoint custom page sizes.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("POWERPOINT", "DetectPageSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkType
Specifies the type of rectangle PDF links should be placed into.
Possible values: "0" (Invisible), "1" (Thin), "2" (Thick)
Syntax
NVDC.setParserParameter("POWERPOINT", "LinkType", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkColor
Specifies the border color of the PDF link rectangle.
Possible values: "0" black, "1" red, "2" green, "3" yellow, "4" blue, "5" magenta, "6" cyan, "7" white.
Syntax
NVDC.setParserParameter("POWERPOINT", "LinkColor", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkHighlight
Specifies the type of highlight for the PDF link rectangle.
Possible values: "0" none, "1" invert, "2" outline, "3" inset.
Syntax
NVDC.setParserParameter("POWERPOINT", "LinkHighLight", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the PUBLISHER parser.
Syntax
NVDC.setParserParameter("PUBLISHER", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether PUBLISHER parser should use the same static printer or create a new printer for each
conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("PUBLISHER", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFExport
Instructs the PUBLISHER parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("PUBLISHER", "UseNativePDFExport", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid for Publisher 2007 and higher.
ConvertHyperlinks
Specifies whether Internet links should be preserved when converting Publisher documents to PDF
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("PUBLISHER", "ConvertHyperlinks", value)
Data Type: Boolean
Note: Can only be set before calling the submitFile method.
ConvertDocInfo
Specifies whether original document info (metadata) should be preserved when converting Publisher
documents to PDF. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("PUBLISHER", "ConvertDocInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "UseNativePDFExport" is
"true".
DetectPageSize
Specifies whether Document Converter should detect and convert Publisher custom page sizes.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("PUBLISHER", "DetectPageSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkType
Specifies the type of rectangle PDF links should be placed into.
Possible values: "0" (Invisible), "1" (Thin), "2" (Thick)
Syntax
NVDC.setParserParameter("PUBLISHER", "LinkType", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkStyle
Specifies the border style PDF links will use.
Possible values: "0" (solid), "1" (dashed)
Syntax
NVDC.setParserParameter("PUBLISHER", "LinkStyle", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LinkColor
Specifies the border color of the PDF link rectangle.
Possible values: "0" black, "1" red, "2" green, "3" yellow, "4" blue, "5" magenta, "6" cyan, "7" white.
Syntax
NVDC.setParserParameter("PUBLISHER", "LinkColor", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the VISIO parser.
Syntax
NVDC.setParserParameter("VISIO", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether VISIO parser should use the same static printer or create a new printer for each
conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("VISIO", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFExport
Instructs the VISIO parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("VISIO", "UseNativePDFExport", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DetectPageSize
Specifies whether Document Converter should detect and convert Visio custom page sizes.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("VISIO", "DetectPageSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ColorAsBlack
Specifies whether the Visio parser should render all colors in the converting document as black.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("VISIO", "ColorAsBlack", value)
Data Type: String
Note: Can only be set before calling the submitFile method
IncludeDocInfo
Specifies whether the Visio parser should preserve document info during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("VISIO", "IncludeDocInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method
UseStaticPrinterPool
Specifies whether HTML parser should use the same static printer or create a new printer for each
conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("HTML", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
WorkOffline
Instructs the HTML parser not to check for an active Internet connection while converting the file.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("HTML", "WorkOffline", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertBackground
Specifies whether page background should be preserved.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("HTML", "ConvertBackground", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DisableScripts
Specifies whether scripts in the converting html document should be disabled.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("HTML", "DisableScripts", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Footer
Overrides the Footer property for the HTML parser.
Certain variables are permitted, including:
&w Window title
&u Page address (URL)
&d Date in short format (as specified by Regional Settings in Control Panel)
&D Date in long format (as specified by Regional Settings in Control Panel)
&t Time in the format specified by Regional Settings in Control Panel
&T Time in 24-hour format
&p Current page number
&P Total number of pages
&b Right-aligned text (following &b)
&b&b Centered text (between &b&b).
&& A single ampersand (&)
Syntax
NVDC.setParserParameter("HTML", "Footer", value)
Example
NVDC.setParserParameter( "HTML", "Footer", "Page &p of &P" )
Note: Can only be set before calling the submitFile method.
HTMLFooter
Overrides the HTMLFooter property for the HTML parser.
Syntax
NVDC.setParserParameter("HTML", "HTMLFooter", value)
Example
NVDC.setParserParameter( "HTML", "HTMLFooter", "<LI>Test footer</LI>" )
Data Type: String
Note: Can only be set before calling the submitFile method.
PaperSize
Sets paper size. (For supported paper sizes see Appendix C)
Syntax
NVDC.setParserParameter("HTML", "PaperSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Orientation
Sets the page orientation.
Posible values: "0" default, "1" portrait, "2" landscape
Syntax
NVDC.setParserParameter("HTML", "Orientation", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LeftMargin
Sets the left margin (in inches).
Syntax
NVDC.setParserParameter("HTML", "LeftMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RightMargin
Sets the right margin (in inches).
Syntax
NVDC.setParserParameter("HTML", "RightMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
BottomMargin
Sets the bottom margin (in inches).
Syntax
NVDC.setParserParameter("HTML", "BottomMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertMessageHeaders
Specifies whether headers in the email document should be converted.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EMAIL", "ConvertMessageHeaders", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertAttachments
Specifies whether attachments in the email document should be converted.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EMAIL", "ConvertAttachments", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
MergeBodyAndAttachments
Specifies whether email body should be merged with attachments during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EMAIL", "ConvertMessageHeaders", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertIntoASeparateFolder
Specifies whether converted email should be placed into a separate folder.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("EMAIL", "ConvertIntoASeparateFolder", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Possible values: "DEFAULT", "CP65001", "UTF8", "CP1200", "UTF16LE", "UCS-2LE", "CP1201", "UTF16BE",
"UCS-2BE", "unicodeFFFE", "CP12000", "UTF32LE", "CP12001", "UTF32BE", "UTF16", "UTF32",
"ANSI_X3.4-1968", "ANSI_X3.4-1986", "ASCII", "CP367", "IBM367", "ISO-IR-6", "ISO646-US",
"ISO_646.IRV:1991", "US", "US-ASCII", "CSASCII", "CP819", "IBM819", "ISO-8859-1", "ISO-IR-100",
"ISO8859-1", "ISO_8859-1", "ISO_8859-1:1987", "L1", "LATIN1", "CSISOLATIN1", "CP1250", "MS-EE",
"WINDOWS-1250", "CP1251", "MS-CYRL", "WINDOWS-1251", "CP1252", "MS-ANSI", "WINDOWS-1252",
"CP1253", "MS-GREEK", "WINDOWS-1253", "CP1254", "MS-TURK", "WINDOWS-1254", "CP1255", "MS-
HEBR", "WINDOWS-1255", "CP1256", "MS-ARAB", "WINDOWS-1256", "CP1257", "WINBALTRIM",
"WINDOWS-1257", "CP1258", "WINDOWS-1258", "850", "CP850", "IBM850", "CSPC850MULTILINGUAL",
"862", "CP862", "IBM862", "CSPC862LATINHEBREW", "866", "CP866", "IBM866", "CSIBM866", "CP154",
"CYRILLIC-ASIAN", "PT154", "PTCP154", "CSPTCP154", "CP1133", "IBM-CP1133", "CP874", "WINDOWS-
874", "CP51932", "MS51932", "WINDOWS-51932", "EUC-JP", "CP932", "MS932", "SHIFFT_JIS",
"SHIFFT_JIS-MS", "SJIS", "SJIS-MS", "SJIS-OPEN", "SJIS-WIN", "WINDOWS-31J", "WINDOWS-932",
"CSWINDOWS31J", "CP50221", "ISO-2022-JP", "ISO-2022-JP-MS", "ISO2022-JP", "ISO2022-JP-MS",
"MS50221", "WINDOWS-50221", "CP936", "GBK", "MS936", "WINDOWS-936", "CP950", "BIG5", "CP949",
"UHC", "EUC-KR", "CP1361", "JOHAB", "437", "CP437", "IBM437", "CSPC8CODEPAGE437", "CP737",
"CP775", "IBM775", "CSPC775BALTIC", "852", "CP852", "IBM852", "CSPCP852", "CP853", "855", "CP855",
"IBM855", "CSIBM855", "857", "CP857", "IBM857", "CSIBM857", "CP858", "860", "CP860", "IBM860",
"CSIBM860", "861", "CP-IS", "CP861", "IBM861", "CSIBM861", "863", "CP863", "IBM863", "CSIBM863",
"CP864", "IBM864", "CSIBM864", "865", "CP865", "IBM865", "CSIBM865", "869", "CP-GR", "CP869",
"IBM869", "CSIBM869", "CP1125", "IBM037", "IBM437", "IBM500", "ASMO-708", "DOS-720", "ibm737",
"ibm775", "ibm850", "ibm852", "IBM855", "ibm857", "IBM00858", "IBM860", "ibm861", "DOS-862",
"IBM863", "IBM864", "IBM865", "cp866", "ibm869", "IBM870", "windows-874", "cp875", "shift_jis",
"shift-jis", "gb2312", "ks_c_5601-1987", "big5", "IBM1026", "IBM01047", "IBM01140", "IBM01141",
"IBM01142", "IBM01143", "IBM01144", "IBM01145", "IBM01146", "IBM01147", "IBM01148",
"IBM01149", "windows-1250", "windows-1251", "windows-1252", "windows-1253", "windows-1254",
"windows-1255", "windows-1256", "windows-1257", "windows-1258", "Johab", "macintosh", "x-mac-
japanese", "x-mac-chinesetrad", "x-mac-korean", "x-mac-arabic", "x-mac-hebrew", "x-mac-greek",
"x-mac-cyrillic", "x-mac-chinesesimp", "x-mac-romanian", "x-mac-ukrainian", "x-mac-thai", "x-mac-ce",
"x-mac-icelandic", "x-mac-turkish", "x-mac-croatian", "x-Chinese_CNS", "x-cp20001", "x_Chinese-Eten",
"x-cp20003", "x-cp20004", "x-cp20005", "x-IA5", "x-IA5-German", "x-IA5-Swedish", "x-IA5-Norwegian",
"us-ascii", "x-cp20261", "x-cp20269", "IBM273", "IBM277", "IBM278", "IBM280", "IBM284", "IBM285",
"IBM290", "IBM297", "IBM420", "IBM423", "IBM424", "x-EBCDIC-KoreanExtended", "IBM-Thai", "koi8-r",
"IBM871", "IBM880", "IBM905", "IBM00924", "EUC-JP", "x-cp20936", "x-cp20949", "cp1025", "koi8-u",
"iso-8859-1", "iso8859-1", "iso-8859-2", "iso8859-2", "iso-8859-3", "iso8859-3", "iso-8859-4", "iso8859-
4", "iso-8859-5", "iso8859-5", "iso-8859-6", "iso8859-6", "iso-8859-7", "iso8859-7", "iso-8859-8",
"iso8859-8",
"iso-8859-9", "iso8859-9", "iso-8859-13", "iso8859-13", "iso-8859-15", "iso8859-15", "x-Europa", "iso-
8859-8-I", "iso8859-8-I", "iso-2022-jp", "csISO2022JP", "iso-2022-jp", "iso-2022-kr", "iso2022-kr", "x-
cp50227", "euc-jp", "EUC-CN", "euc-kr", "hz-gb-2312", "GB18030", "x-iscii-de", "x-iscii-be", "x-iscii-ta", "x-
iscii-te", "x-iscii-as", "x-iscii-or","x-iscii-ka", "x-iscii-ma", "x-iscii-gu", "x-iscii-pa"
FontName
Sets font name for documents processed by the RTFTXT parser.
Syntax
NVDC.setParserParameter("RTFTXT", "FontName", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
FontSize
Sets font size for documents processed by the RTFTXT parser.
Syntax
NVDC.setParserParameter("RTFTXT", "FontSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
FontColor
Sets font color for documents processed by the RTFTXT parser.
Syntax
NVDC.setParserParameter("RTFTXT", "FontColor", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
FontStyle
Sets font style for documents processed by the RTFTXT parser.
Possible values: "1" bold, "2" italic, "4" underline, "8" strikeout
Syntax
NVDC.setParserParameter("RTFTXT", "FontStyle", value)
PaperSize
Sets paper size. (For supported paper sizes see Appendix C)
Syntax
NVDC.setParserParameter("RTFTXT", "PaperSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Orientation
Sets the page orientation.
Posible values: "0" default, "1" portrait, "2" landscape
Syntax
NVDC.setParserParameter("RTFTXT", "Orientation", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
LeftMargin
Sets the left margin (in inches).
Syntax
NVDC.setParserParameter("RTFTXT", "LeftMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TopMargin
Sets the top margin (in inches).
Syntax
NVDC.setParserParameter("RTFTXT", "TopMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
BottomMargin
Sets the bottom margin (in inches).
Syntax
NVDC.setParserParameter("RTFTXT", "BottomMargin", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TxtEncoding
Specifies what text encoding the RTFTXT parser should use.
Syntax
NVDC.setParserParameter("RTFTXT", "TxtEncoding", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Possible values: "DEFAULT", "CP65001", "UTF8", "CP1200", "UTF16LE", "UCS-2LE", "CP1201", "UTF16BE",
"UCS-2BE", "unicodeFFFE", "CP12000", "UTF32LE", "CP12001", "UTF32BE", "UTF16", "UTF32",
"ANSI_X3.4-1968", "ANSI_X3.4-1986", "ASCII", "CP367", "IBM367", "ISO-IR-6", "ISO646-US",
"ISO_646.IRV:1991", "US", "US-ASCII", "CSASCII", "CP819", "IBM819", "ISO-8859-1", "ISO-IR-100",
"ISO8859-1", "ISO_8859-1", "ISO_8859-1:1987", "L1", "LATIN1", "CSISOLATIN1", "CP1250", "MS-EE",
"WINDOWS-1250", "CP1251", "MS-CYRL", "WINDOWS-1251", "CP1252", "MS-ANSI", "WINDOWS-1252",
"CP1253", "MS-GREEK", "WINDOWS-1253", "CP1254", "MS-TURK", "WINDOWS-1254", "CP1255", "MS-
HEBR", "WINDOWS-1255", "CP1256", "MS-ARAB", "WINDOWS-1256", "CP1257", "WINBALTRIM",
"WINDOWS-1257", "CP1258", "WINDOWS-1258", "850", "CP850", "IBM850", "CSPC850MULTILINGUAL",
"862", "CP862", "IBM862", "CSPC862LATINHEBREW", "866", "CP866", "IBM866", "CSIBM866", "CP154",
"CYRILLIC-ASIAN", "PT154", "PTCP154", "CSPTCP154", "CP1133", "IBM-CP1133", "CP874", "WINDOWS-
874", "CP51932", "MS51932", "WINDOWS-51932", "EUC-JP", "CP932", "MS932", "SHIFFT_JIS",
"SHIFFT_JIS-MS", "SJIS", "SJIS-MS", "SJIS-OPEN", "SJIS-WIN", "WINDOWS-31J", "WINDOWS-932",
"CSWINDOWS31J", "CP50221", "ISO-2022-JP", "ISO-2022-JP-MS", "ISO2022-JP", "ISO2022-JP-MS",
"MS50221", "WINDOWS-50221", "CP936", "GBK", "MS936", "WINDOWS-936", "CP950", "BIG5", "CP949",
"UHC", "EUC-KR", "CP1361", "JOHAB", "437", "CP437", "IBM437", "CSPC8CODEPAGE437", "CP737",
"CP775", "IBM775", "CSPC775BALTIC", "852", "CP852", "IBM852", "CSPCP852", "CP853", "855", "CP855",
"IBM855", "CSIBM855", "857", "CP857", "IBM857", "CSIBM857", "CP858", "860", "CP860", "IBM860",
"CSIBM860", "861", "CP-IS", "CP861", "IBM861", "CSIBM861", "863", "CP863", "IBM863", "CSIBM863",
"CP864", "IBM864", "CSIBM864", "865", "CP865", "IBM865", "CSIBM865", "869", "CP-GR", "CP869",
"IBM869", "CSIBM869", "CP1125", "IBM037", "IBM437", "IBM500", "ASMO-708", "DOS-720", "ibm737",
"ibm775", "ibm850", "ibm852", "IBM855", "ibm857", "IBM00858", "IBM860", "ibm861", "DOS-862",
"IBM863", "IBM864", "IBM865", "cp866", "ibm869", "IBM870", "windows-874", "cp875", "shift_jis",
"shift-jis", "gb2312", "ks_c_5601-1987", "big5", "IBM1026", "IBM01047", "IBM01140", "IBM01141",
"IBM01142", "IBM01143", "IBM01144", "IBM01145", "IBM01146", "IBM01147", "IBM01148",
ParserTimeout
Sets timeout (in seconds) for the OPENOFFICE parser.
Syntax
NVDC.setParserParameter("OPENOFFICE", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether OPENOFFICE parser should use the same static printer or create a new printer for each
conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("OPENOFFICE", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFexport
Instructs the OPENOFFICE parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("OPENOFFICE", "UseNativePDFexport", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ExportBookmarks
Specifies whether bookmarks should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("OPENOFFICE", "ExportBookmarks", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when OpenOffice native PDF export
engine is used.
VisibleBkmsLevels
Sets visibility level for bookmarks.
Syntax
NVDC.setParserParameter("OPENOFFICE", "VisibleBkmsLevels", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when OpenOffice native PDF export
engine is used.
ExportNotes
Specifies whether document notes should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("OPENOFFICE", "ExportNotes", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when OpenOffice native PDF export
engine is used.
ExportNotesPages
Specifies whether notes pages should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("OPENOFFICE", "ExportNotesPages", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when OpenOffice native PDF export
engine is used. Notes pages are similar to speaker notes in Powerpoint.
ExportDocRefToPDF
Specifies whether document references (links to places in the same document) should be preserved
during the PDF conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("OPENOFFICE", "ExportDocRefToPDF", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when OpenOffice native PDF export
engine is used.
ExportFormFields
Specifies whether form fields should be preserved during the PDF conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("OPENOFFICE", "ExportFormFields", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when OpenOffice native PDF export
engine is used.
FormsType
Specifies which format should be used when form fields are exported to PDF.
Possible values: "0" FDF, "1" PDF, "2" HTML, "3" XML
Syntax
NVDC.setParserParameter("OPENOFFICE", "FormType", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when OpenOffice native PDF export
engine is used.
ParserTimeout
Sets timeout (in seconds) for the WORDPERFECT parser.
Syntax
NVDC.setParserParameter("WORDPERFECT", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether WORDPERFECT parser should use the same static printer or create a new printer for
each conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORDPERFECT", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFExport
Instructs the WORDPERFECT parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORDPERFECT", "UseNativePDFExport", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
DisableMacros
Specifies whether macros should be disabled during the PDF conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("WORDPERFECT", "DisableMacros", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Valid only when WordPerfect native PDF export
engine is used.
ParserTimeout
Sets timeout (in seconds) for the SNAPSHOT parser.
Syntax
NVDC.setParserParameter("SNAPSHOT", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether SNAPSHOT parser should use the same static printer or create a new printer for each
conversion. Possible values: "true", "false"
Syntax
NVDC.setParserParameter("SNAPSHOT", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseParser
Specifies which parser should be used to convert documents.
Possible values: "0" Shapshot, "1" Neevia built-in parser.
Syntax
NVDC.setParserParameter("SNAPSHOT", "UseParser", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
PaperSize
Sets paper size. (For supported paper sizes see Appendix C)
Syntax
NVDC.setParserParameter("SNAPSHOT", "PaperSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Orientation
Sets the page orientation.
Posible values: "0" default, "1" portrait, "2" landscape
Syntax
NVDC.setParserParameter("SNAPSHOT", "Orientation", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the DESIGNREVIEW parser.
Syntax
NVDC.setParserParameter("DESIGNREVIEW", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseStaticPrinterPool
Specifies whether DESIGNREVIEW parser should use the same static printer or create a new printer for
each conversion.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("DESIGNREVIEW", "UseStaticPrinterPool", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
SpaceToConvert
Instructs the parser which space type to use during the conversion process.
Possible values: "default" Default View, "all" All layouts, "model" Model Space
Note: To convert a specific layout specify the layout index or name, for example to convert "test layout" which is the
second layout in dwf file you can specify either "test layout" or "2" as "SpaceToConvert".
Syntax
NVDC.setParserParameter("DESIGNREVIEW", "SpaceToConvert", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
PaperSize
Sets paper size. (For supported paper sizes see Appendix C)
Syntax
NVDC.setParserParameter("DESIGNREVIEW", "PaperSize", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the AUTOCAD parser.
Syntax
NVDC.setParserParameter("AUTOCAD", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
UseNativePDFExport
Instructs the AUTOCAD parser to use its native PDF export engine.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("AUTOCAD", "UseNativePDFExport", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertView
Specifies the layout to convert.
Possible values: "0" Default View, "1" Model+All Layouts, "2" Model, "3" All Layouts, "4" Specific Layout
Syntax
NVDC.setParserParameter("AUTOCAD", "ConvertView", value)
Data Type: String
Note: Can only be set before calling the submitFile method
LayoutName
Specifies the layout name to convert.
Syntax
NVDC.setParserParameter("AUTOCAD", "LayoutName", value)
Data Type: String
Note: Can only be set before calling the submitFile method and when "ConvertView" is "4".
ParserTimeout
Sets timeout (in seconds) for the ILLUSTRATOR parser.
Syntax
NVDC.setParserParameter("ILLUSTRATOR", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
reuseApp
Specifies whether Illustrator should be kept in the memory at all times.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("ILLUSTRATOR", "reuseApp", value)
Data Type: String
Note: Can only be set before calling the submitFile method. By using the same Illustrator instance the
conversion process will take less time.
PDFpreset
Specifies the PDF preset settings to use.
Possible values: "[Smallest File Size]", "[Press Quality]", "[High Quality Print]", "[Illustrator Default]"
Syntax
NVDC.setParserParameter("ILLUSTRATOR", "PDFpreset", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ConvertLayers
Specifies whether layers should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("ILLUSTRATOR", "ConvertLayers", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
IncludeTrimMarks
Specifies whether trim marks should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("ILLUSTRATOR", "IncludeTrimMarks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
IncludeFileInfo
Specifies whether document info should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("ILLUSTRATOR", "IncludeFileInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
IncludeColorBars
Specifies whether Illustrator color bars should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("ILLUSTRATOR", "IncludeColorBars", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the INDESIGN parser.
Syntax
NVDC.setParserParameter("INDESIGN", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
reuseApp
Specifies whether inDesign should be kept in the memory at all times.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("INDESIGN", "reuseApp", value)
Data Type: String
Note: Can only be set before calling the submitFile method. By using the same InDesign instance the conversion
process will take less time.
PDFpreset
Specifies the PDF preset settings to use.
Possible values: "[Smallest File Size]", "[Press Quality]", "[High Quality Print]"
Syntax
NVDC.setParserParameter("INDESIGN", "PDFpreset", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ParserTimeout
Sets timeout (in seconds) for the CORELDRAW parser.
Syntax
NVDC.setParserParameter("CORELDRAW", "ParserTimeout", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
reuseApp
Specifies whether CorelDraw should be kept in the memory at all times.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("CORELDRAW", "reuseApp", value)
Data Type: String
Note: Can only be set before calling the submitFile method. By using the same CorelDraw instance the
conversion process will take less time.
PDFpreset
Specifies the PDF preset settings to use.
Possible values: "0" Web, "1" Prepress, "2" Editing, "3" Document Distribution, "4" Archiving (CMYK),
"5" Archiving (RGB)
Syntax
NVDC.setParserParameter("CORELDRAW", "PDFpreset", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TrueTypeToType1
Specifies whether true type fonts should be converted into type 1.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("CORELDRAW", "TrueTypeToType1", value)
Data Type: Boolean
Note: Can only be set before calling the submitFile method.
IncludeHyperlinks
Specifies whether Internet links should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("CORELDRAW", "IncludeHyperlinks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
IncludeBookmarks
Specifies whether bookmarks should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("CORELDRAW", "IncludeBookmarks", value)
Data Type: String
Note: Can only be set before calling the submitFile method
IncludeCropMarks
Specifies whether crop marks should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("CORELDRAW", "IncludeCropMarks", value)
Data Type: String
Note: Can only be set before calling the submitFile method
IncludeRegistrationMarks
Specifies whether registration marks should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("CORELDRAW", "IncludeRegistrationMarks", value)
Data Type: String
Note: Can only be set before calling the submitFile method
IncludeFileInfo
Specifies whether document info should be preserved during the conversion process.
Possible values: "true", "false"
Syntax
NVDC.setParserParameter("CORELDRAW", "IncludeFileInfo", value)
Data Type: String
Note: Can only be set before calling the submitFile method
COS
Specifies whether PDFcompress addin should create object streams when compressing the PDF.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "COS", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
An object stream represents a stream that contains a sequence of PDF objects. This allows a greater number of
PDF objects to be compressed.
CI
Specifies the color images compression algorithm.
Possible values:
"jpx" JPEG2000 compression
"jpg" JPEG compression
"zip" Deflate (ZIP) compression
"none" Images will be left uncompressed
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "CI", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
CQ
Specifies the color images compression quality. Possible values: "0" .. "100"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "CQ", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Will work only for jpx and jpg compressions.
GI
Specifies the grayscale images compression algorithm.
Possible values:
"jpx" JPEG2000 compression
"jpg" JPEG compression
"zip" Deflate (ZIP) compression
"none" Images will be left uncompressed
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "GI", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
MI
Specifies the monochrome images compression algorithm.
Possible values:
"jbig2" JBIG2 lossy compression (default)
"jbig2l" JBIG2 lossless compression
"fax" Group 4 CCITT facsimile (fax) compression
"zip" Deflate (ZIP) compression
"none" Images will be left uncompressed
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "MI", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
MQ
Specifies the monochrome images compression quality.
Possible values: "0" .. "10"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "CQ", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Will work only for jbig2 and jbig2l compressions.
RemoveBookmarks
Specifies whether to remove bookmarks (outlines) from the compressed PDF file.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "RemoveBookmarks", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RemoveAcroForms
Specifies whether to remove PDF forms from the compressed PDF file.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "RemoveAcroForms", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RemovePageLabels
Specifies whether to remove page labels from the compressed PDF file.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "RemovePageLabels", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RemoveLayers
Specifies whether to remove layers from the compressed PDF file.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "RemoveLayers", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
RemoveArticleThreads
Specifies whether to remove article threads from the compressed PDF file.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFCOMPRESS", "RemoveArticleThreads", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
CertificateSubject
Load certificate by subject.
Syntax
NVDC.setAddinParameter("PDFSIGN", "CertificateSubject", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
CertificateFile
Specifies the file to load the certificate from.
Syntax
NVDC.setAddinParameter("PDFSIGN", "CertificateFile", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
CertificatePassword
Specifies the master password to the certificate.
Syntax
NVDC.setAddinParameter("PDFSIGN", "CertificatePassword", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Location
Specifies your location info (ex: city name).
Syntax
NVDC.setAddinParameter("PDFSIGN", "Location", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Reason
Specifies the reason for signing output document.
Syntax
NVDC.setAddinParameter("PDFSIGN", "Reason", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
SignatureAppearance
Specifies the predefined signature appearance settings to load.
Possible values: "invisible", "standard appearance"
Syntax
NVDC.setAddinParameter("PDFSIGN", "SignatureAppearance", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
PlaceOnPage
Specifies the page to place signature on (use "0" to place signature on last page).
Syntax
NVDC.setAddinParameter("PDFSIGN", "PlaceOnPage", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
X
X-coordinate of signature.
Syntax
NVDC.setAddinParameter("PDFSIGN", "X", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Y
Y-coordinate of signature.
Syntax
NVDC.setAddinParameter("PDFSIGN", "Y", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Height
Height of the rectangle containing signature.
Syntax
NVDC.setAddinParameter("PDFSIGN", "Height", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
Units
Measurement units to use for X, Y, Width and Height parameters.
Possible values: "1" inches, "2" centimeters, "3" millimeters, "4" points (default)
Syntax
NVDC.setAddinParameter("PDFSIGN", "Units", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ViewType
Specifies what to display in the signature’s graphic box.
Possible values: "0" no graphic, "1" show signer’s name, "2" show image from file
Syntax
NVDC.setAddinParameter("PDFSIGN", "ViewType", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ShowSignerName
Specifies whether to show signer name in signature field.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "ShowSignerName", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "ViewType" is "1".
Picture
Specifies the image file to associate with signature (when "ViewType" is "2").
Syntax
NVDC.setAddinParameter("PDFSIGN", "Picture", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "ViewType" is "2".
PictureAlign
Specifies how to align the picture in the signature box.
Possible values: "0" left, "1" right
Syntax
NVDC.setAddinParameter("PDFSIGN", "PictureAlign", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "ViewType" is "2".
PictureScaleKeepRatio
Specifies whether PDFsign should keep the aspect ratio when scaling picture to fit signature box.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "PictureScaleKeepRatio", value)
Data Type: String
Note: Can only be set before calling the submitFile method. Will have effect only if "ViewType" is "2".
CertifySignature
Specifies whether to certify the output PDF file.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "CertifySignature", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TimeStampSignature
Specifies whether to time-stamp the signature.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "TimeStampSignature", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TimeStampServerURL
Specifies the time server url (time server has to be RFC 3161 compatible).
Syntax
NVDC.setAddinParameter("PDFSIGN", "TimeStampServerURL", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TimeStampServerUser
Time server user name (if time server requires authentication)
Syntax
NVDC.setAddinParameter("PDFSIGN", "TimeStampServerUser", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TimeStampServerPassword
Time server password (if time server requires authentication).
Syntax
NVDC.setAddinParameter("PDFSIGN", "TimeStampServerPassword", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
TextAlign
Specifies how to align the text box in signature field.
Possible values: "0" left side, "1" right side
Syntax
NVDC.setAddinParameter("PDFSIGN", "TextAlign", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
CustomText
Specifies the custom text to be added to the signature field.
Syntax
NVDC.setAddinParameter("PDFSIGN", "CustomText", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ShowName
Specifies whether to show certificate name in signature field.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "ShowName", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ShowLocation
Specifies whether to show location info in signature field.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "ShowLocation", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ShowDate
Specifies whether to show signing date in signature field.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "ShowDate", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ShowPicture
Specifies whether to show the picture in signature field.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "ShowPicture", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ShowDistinguishedName
Specifies whether to show distinguished name in signature field.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "ShowDistinguishedName", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
ShowLabels
Specifies whether to show text labels in signature field.
Possible values: "true", "false"
Syntax
NVDC.setAddinParameter("PDFSIGN", "ShowLabels", value)
Data Type: String
Note: Can only be set before calling the submitFile method.
\stamp <value> - starts a stamp. <value> specifies the pages to stamp (leave blank if you want to stamp
all the pages.
\starttextbox <value> - Starts a Text Box (<value> is the text alignment: 1 - left, 2 - right, 3 - center)
.. text box text to stamp …
\endtextbox
\scale <value> - specifies scaling factor for image and PDF overlay stamps
Example: Stamp "WATERMARK" on first page at (1in, 1.5in), Arial font, green color
\stamp 1
\stampname Sample Stamp
\text WATERMARK
\x 1
\y 1.5
\units 1
\font Arial
\textrgbcolor #00FF00
Below is the list of variables supported by both Text and TextBox stamps:
%PAGE% - current page number
%PAGES% - total number of pages
%FILENAME% - name of the file
%WEEKDAY% - full weekday name
%WEEKDAY_SHORT% - abbreviated weekday name
%MONTH% - month number (1-12)
%MONTHNAME% - full month name
%MONTHNAME_SHORT% - abbreviated month name
%YEAR% - year with century (YYYY)
%YEAR_SHORT% - year without century (YY)
%DAY% - day of month
%DAY_YEAR% - day of the year (1 -366)
%HOUR% - hour (01- 12)
%HOURS% - hour (00-23)
%MINUTES% - minutes (00-59)
%SECONDS% - seconds (00-59)
%AMPM% - AM, PM
%DATE% - local date representation. Ex: 11/01/07
%TIME% - local time representation. Ex: 1:17:10 PM
%DATETIME% - local date and time
%AUTHOR% - document Author
%TITLE% - document Title
%SUBJECT% - document Subject
%KEYWORDS% - document Keywords
%N% - new line. This is valid for TextBox stamp only.
This list contains the currently supported file types; additional file types are constantly added. If the file
type you are looking for is not listed here please e-mail us at: [email protected].
Generic Formats
Adobe PDF
Adobe PostScript
Encapsulated PostScript (EPS)
ZIP archive
Graphic Formats
AVS - AVS X image file
BMP - MS Windows Bitmap image file
BMP - OS/2 Bitmap
DCX - ZSoft IBM PC multi-page Paintbrush file
DIB - MS Windows Device Independent Bitmap
DPX - Digital Moving Picture Exchange
FAX – Group 3 FAX encoding
FITS - Flexible Image Transport System
FPX - FlashPix Format
GIF - CompuServe graphics interchange format
GIF87 - CompuServe graphics interchange format ver 87
ICO - MS Windows Icons
ICO - OS/2 Icons
IPTC - Newswire profile
JBIG - Joint Bi-level Image experts Group file interchange format
Vector Graphic Formats I (requires Adobe Illustrator v10+ to be installed / used as a parser)
AI – Adobe Illustrator
CDR - CorelDRAW graphics
CGM - Computer Graphics Metafile
DWG - AutoCAD Drawing
DXF - AutoCAD Interchange
EMF – Enhanced Metafile
FLM – Filmstrip file format
FH4 - FreeHand 4
FH5 - FreeHand 5
FH7 - FreeHand 7
FH8 - FreeHand 8
PDD – Adobe Photoshop
PXR - Pixar file format
CAD Formats (requires Autodesk Design Review or AutoCAD to be installed / used as parser).
DWF - Drawing Web Format
DWG - AutoCAD Drawing
DXF - AutoCAD DXF
RML - RedlineXML
IPT - Inventor Part Document
IAM - Inventor Assembly Document
IDW - Inventor Drawing Document