Title

 

NEEVIA

Document Converter

Professional Edition

 

 

 

API Reference

version 6.8

 

 

 


Table of Contents

 

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. 28

getExtensionName. 28

fileExists. 28

isFileInUse. 28

fileCopy. 28

fileDelete. 28

createFolder. 29

copyFolder. 29

deleteFolder. 29

converterPath. 30

isConverterActive. 30

GUID.. 30

Conversion parameters - GENERAL. 31

DocumentOutputFormat. 31

DocumentOutputFolder. 31

DocumentErrorFolder. 31

DocumentOriginalFolder. 31

DocumentPassword. 31

ZIPpassword. 32

Conversion parameters - EMAILING.. 33

RecipientAddress. 33

SMTPServerAddress. 33

SMTPUser. 33

SMTPPassword. 33

SMTPPort. 33

SMTPEncryption. 34

SMTPFromName. 34

SMTPFromAddress. 34

SMTPSuccessSubject. 34

SMTPSuccessBody. 34

SMTPErrorSubject. 35

SMTPErrorBody. 35

Conversion parameters - SCRIPTING.. 36

ScriptSrc. 36

ScriptLang. 36

ScriptTimeout. 36

ScriptAllowUI 36

Conversion parameters - PRINTER related. 37

UsePrinter. 37

MultiThreadedPrinting. 37

PrintEngine. 37

PrintColors. 37

ShrinkToFit. 37

Conversion parameters - PostScript/EPS related. 38

LanguageLevel 38

Conversion parameters - Image related. 39

TIFFType. 39

MultiPageTIFF. 39

FillOrder. 39

JPGType. 40

JPGQuality. 40

BMPType. 40

PSDType. 40

PCXType. 41

PNGType. 41

PXLType. 41

ScalePage. 42

ConstrainProportions. 42

ScaleIfLarger. 42

PlaceContentIn. 42

ImgHeight. 43

ImgWidth. 43

ImgResH.. 43

ImgResV.. 43

FileNameSuffix. 44

TextAlphaBits. 44

GraphicsAlphaBits. 44

Interpolate. 44

UseWTS. 45

UseCIEColor. 45

DitheringMethod. 45

Conversion parameters - FAXING (SEND VIA FAX) related. 46

FaxServer. 46

FaxNumber. 46

RecipientName. 46

TSID.. 46

CoverPage. 47

CoverPageSubject. 47

CoverPageNotes. 47

CoverFullName. 47

CoverFaxNumber. 47

CoverEmail 48

CoverTitle. 48

CoverCompany. 48

CoverOffice. 48

CoverDepartment. 48

CoverHomePhone. 49

CoverWorkPhone. 49

CoverAddress. 49

CoverBillingCode. 49

Conversion parameters - PDF/A related. 50

OutputIntent. 50

Conversion parameters - PDF related. 51

OptimizePDFfor. 51

LinearizePDF. 51

AttachOriginalFile. 51

DocumentResolution. 52

DocumentPaperSize. 52

ScalePage. 52

ConstrainProportions. 52

PlaceContentIn. 53

PDFVersion. 54

DocumentTitle. 54

DocumentSubject. 54

DocumentAuthor. 54

DocumentKeywords. 55

PDFAutoRotatePage. 55

PDFCompressPages. 55

PDFEmbedAllFonts. 55

PDFSubsetFonts. 56

PDFFontsMaxSubset. 56

PDFProcessColorModel 56

CompressColorImages. 56

ColorCompressMethod. 57

CompressGrayImages. 57

GrayCompressMethod. 57

CompressMonoImages. 57

MonoCompressMethod. 58

ColorImageResolution. 58

GrayImageResolution. 58

MonoImageResolution. 58

DownsampleColorImages. 59

ColorImageDownsampleType. 59

DownsampleGrayImages. 59

GrayImageDownsampleType. 59

DownsampleMonoImages. 59

MonoImageDownsampleType. 60

MaxInlineImageSize. 60

ParseDSCComments. 60

DefaultRenderingIntent. 60

PreserveOverprintSettings. 61

UCRandBGInfo. 61

TransferFunctionInfo. 61

PreserveHaltoneInfo. 61

Conversion parameters - PDF Encryption. 62

PDFEncryption. 62

PDFEncryptionMethod. 62

PDFEncryptMeta. 62

PDFUserPassword. 62

PDFOwnerPassword. 63

PDFPermissions. 63

Conversion parameters - PDF viewer options. 64

OpenAtPage. 64

OpenMagnification. 64

FullScreen. 64

PageMode. 65

PageLayout. 65

HideMenuBar. 65

HideToolbar. 65

HideWindowUI 66

FitWindow.. 66

CenterWindow.. 66

Conversion parameters - Watermark/Stationery. 67

StampText. 67

StampFile. 67

StampFontColor. 67

StampFontName. 67

StampFontSize. 68

StampFontEmbed. 68

StampFontSubset. 68

StampTextRenderingMode. 68

StampFontEncoding. 69

StampScale. 69

StampFontColor. 69

StampFontColorGray. 69

StampFontColorCMYK. 69

StampStrokeColor. 70

StampStrokeColorGray. 70

StampStrokeColorCMYK. 70

StampStrokeWidth. 70

StampRotate. 70

StampOpacity. 71

PlaceStampOnPages. 71

StampUnits. 71

StampX. 71

StampY. 71

StampWidth. 72

StampHeight. 72

StampTextBox. 72

StampTextAlign. 72

StampWordWrap. 72

StampWebLink. 72

StampGoToPage. 73

StampUseCropBox. 73

StampUsePageRotation. 73

StampPlaceAs. 73

StampImage. 73

StampPDFOverlay. 74

StampPDFOverlayPage. 74

Conversion parameters - mergePDF / mergeMultiplePDF related. 75

CreatePageBookmarks. 75

CreateNewBookmarks. 75

BookmarksFile. 75

Conversion parameters - splitPDF related. 76

SplitByBookmarks. 76

BkLevel 76

NameByBk. 76

Conversion parameters - mergePDF, mergeMultiplePDF, splitPDF related. 77

RemoveAnnotations. 77

RemoveAcroForms. 77

RemovePageLabels. 77

RemoveLayers. 77

RemoveArticleThreads. 77

Parser-specific parameters - PSPDF. 78

ParserTimeout. 78

RenderingThreads. 78

VirtualMemory. 78

PDFtoPDF. 78

UseCropBox. 78

ReparseBadPDF. 79

CropEPS. 79

UseDistiller. 79

OpenPassword. 79

Parser-specific parameters - IMAGE/OCR. 80

ParserTimeout. 80

Rotate. 80

OCR. 80

OCRlang. 80

AutoRotate. 81

AutoStraighten. 81

Parser-specific parameters - WORD.. 82

ParserTimeout. 82

UseStaticPrinterPool 82

UseNativePDFExport. 82

ConvertDocInfo. 82

ConvertHeadings. 82

ConvertInternetLinks. 83

CreateLinksFromTOC. 83

ConvertCrossReferenceLinks. 83

ConvertCrossDocLinks. 83

ConvertCommentsToPDFNotes. 83

ConvertTextBoxesToArticleThreads. 84

ConvertFootnoteLinks. 84

ConvertPageLabels. 84

ConvertBookmarksToNamedDest. 84

BookmarkOpenDepth. 84

BookmarkMagnification. 85

LinkType. 85

LinkStyle. 85

LinkColor. 85

LinkHighlight. 85

ConvertFormFields. 86

AutoRenameFormFields. 86

HideCheckBox. 86

HideTextInput. 86

HideDropDown. 86

HideDocumentRevisions. 87

DetectPageSize. 87

RemovePrintCodes. 87

DisableMacros. 87

UpdateLinksAtOpen. 87

RepaginateBeforeConverting. 88

PaperSize. 88

Orientation. 88

LeftMargin. 88

TopMargin. 88

RightMargin. 89

BottomMargin. 89

TXTOpenFormat. 89

TXTAlign. 89

TXTEncoding. 90

Parser-specific parameters - EXCEL. 95

ParserTimeout. 95

UseStaticPrinterPool 95

UseNativePDFExport. 95

ConvertHyperlinks. 95

ConvertDocInfo. 95

ConvertWhat. 96

ConvertWorksheetIndex. 96

ConvertWorksheet. 96

LinkType. 96

LinkStyle. 96

LinkColor. 97

LinkHighlight. 97

ConvertSheetNamesToBookmarks. 97

ConvertSheetNamesToNamedDest. 97

DetectPageSize. 97

AutoFit. 98

ClearPrintArea. 98

EnableAddins. 98

DisableMacros. 98

PaperSize. 98

Orientation. 99

LeftMargin. 99

TopMargin. 99

RightMargin. 99

BottomMargin. 99

Scaling. 100

Parser-specific parameters - POWERPOINT. 101

ParserTimeout. 101

UseStaticPrinterPool 101

UseNativePDFExport. 101

ConvertHyperlinks. 101

ConvertTransitions. 101

ConvertSpeakerNotes. 102

ConvertHidenSlides. 102

ConvertView.. 102

DetectPageSize. 102

LinkType. 102

LinkStyle. 103

LinkColor. 103

LinkHighlight. 103

Parser-specific parameters - PUBLISHER. 104

ParserTimeout. 104

UseStaticPrinterPool 104

UseNativePDFExport. 104

ConvertHyperlinks. 104

ConvertDocInfo. 104

ConversionView.. 105

DetectPageSize. 105

LinkType. 105

LinkStyle. 105

LinkColor. 105

LinkHighlight. 106

Parser-specific parameters - VISIO.. 107

ParserTimeout. 107

UseStaticPrinterPool 107

UseNativePDFExport. 107

DetectPageSize. 107

ColorAsBlack. 107

IncludeBackground. 108

IncludeDocInfo. 108

Parser-specific parameters - HTML. 109

ParserTimeout. 109

UseStaticPrinterPool 109

WorkOffline. 109

ConvertBackground. 109

DisableScripts. 109

Header. 110

Footer. 110

HTMLHeader. 111

HTMLFooter. 111

PaperSize. 111

Orientation. 111

LeftMargin. 111

TopMargin. 112

RightMargin. 112

BottomMargin. 112

Parser-specific parameters - EMAIL. 113

ParserTimeout. 113

ConvertMessageHeaders. 113

ConvertAttachments. 113

MergeBodyAndAttachments. 113

ConvertIntoASeparateFolder. 113

BodyEncoding. 114

Parser-specific parameters - RTFTXT. 115

ParserTimeout. 115

FontName. 115

FontSize. 115

FontColor. 115

FontStyle. 115

FontCharSet. 116

PaperSize. 116

Orientation. 116

LeftMargin. 116

TopMargin. 116

RightMargin. 117

BottomMargin. 117

TxtEncoding. 117

Parser-specific parameters - OPENOFFICE. 119

ParserTimeout. 119

UseStaticPrinterPool 119

UseNativePDFexport. 119

ExportBookmarks. 119

VisibleBkmsLevels. 119

ExportBookmarksAsNamedDest. 120

ExportNotes. 120

ExportNotesPages. 120

ExportDocRefToPDF. 120

ExportRelativeURLs. 121

ExportFormFields. 121

FormsType. 121

Parser-specific parameters - WORDPERFECT. 122

ParserTimeout. 122

UseStaticPrinterPool 122

UseNativePDFExport. 122

DisableMacros. 122

Parser-specific parameters - SNAPSHOT. 123

ParserTimeout. 123

UseStaticPrinterPool 123

UseParser. 123

PaperSize. 123

Orientation. 123

Parser-specific parameters - DESIGNREVIEW... 124

ParserTimeout. 124

UseStaticPrinterPool 124

SpaceToConvert. 124

PaperSize. 124

Parser-specific parameters - AUTOCAD.. 125

ParserTimeout. 125

UseNativePDFExport. 125

ConvertView.. 125

LayoutName. 125

Parser-specific parameters - ILLUSTRATOR. 126

ParserTimeout. 126

reuseApp. 126

PDFpreset. 126

ConvertLayers. 126

IncludeTrimMarks. 126

IncludeRegistrationMarks. 127

IncludeFileInfo. 127

IncludeColorBars. 127

Parser-specific parameters - INDESIGN.. 128

ParserTimeout. 128

reuseApp. 128

PDFpreset. 128

Parser-specific parameters - CORELDRAW... 129

ParserTimeout. 129

reuseApp. 129

PDFpreset. 129

TrueTypeToType1. 129

useSeparationProfile. 130

IncludeHyperlinks. 130

IncludeBookmarks. 130

IncludeCropMarks. 130

IncludeRegistrationMarks. 130

IncludeDensitometerScales. 131

IncludeFileInfo. 131

Addin-specific parameters - PDFCOMPRESS. 132

COS. 132

CI 132

CQ.. 132

GI 132

GQ.. 133

MI 133

MQ.. 133

RemoveBookmarks. 133

RemoveAnnotations. 134

RemoveAcroForms. 134

RemovePageLabels. 134

RemoveLayers. 134

RemoveArticleThreads. 134

Addin-specific parameters - PDFSIGN.. 135

CertificateSubject. 135

CertificateFile. 135

CertificatePassword. 135

Location. 135

Reason. 135

ContactInfo. 136

SignatureAppearance. 136

PlaceOnPage. 136

X. 136

Y. 136

Width. 137

Height. 137

Units. 137

ViewType. 137

ShowSignerName. 137

SignerNameAlign. 138

Picture. 138

PictureAlign. 138

PictureScaleKeepRatio. 138

CertifySignature. 138

CertifyPermissions. 139

TimeStampSignature. 139

TimeStampServerURL. 139

TimeStampServerUser. 139

TimeStampServerPassword. 139

TextColor. 140

TextAlign. 140

CustomText. 140

ShowName. 140

ShowLocation. 140

ShowReason. 141

ShowDate. 141

ShowPicture. 141

ShowDistinguishedName. 141

ShowLabels. 141

Appendix A: Stamp File Format. 142

Appendix B: Variables supported by Text / TextBox stamps. 144

Appendix C: Paper sizes supported by PaperSize property. 145

Examples. 146

Supported File Formats. 147

 

 

 


License

 

NEEVIA TECHNOLOGY

 

ELECTRONIC END USER LICENSE AGREEMENT

 

For One (1) Computer/Server/Virtual Server

 

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.

 

The following are definitions that should be noted by the 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. This is very common in ISP or ASP environments.

      

 

 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:

 


LICENSE

 

Until such time as Neevia Technology has issued a valid serial number to you, you may only use this software for a 30-day trial period. You agree to remove any copies of the software after the expiration of the trial period. No license is issued to you until you are issued a valid serial number.

 

(a) Home Use:

The primary user of each computer on which the Software is installed or used may also install the Software on one home or portable computer.  However another person may not use the Software on a secondary computer at the same time the Software on the primary computer is being used.

 

 

(b)   Server or Network Use:

You may store or install one (1) copy of the SOFTWARE on a storage device, such as a network server, for backup and archival purposes only. A license for the SOFTWARE may not be shared or used concurrently on different computers.

 

 

(c) Operating system or Language versions:

If you receive two or more copies of the Software with different operating systems or language versions, the total aggregate number of computers on which all versions of the Software are used may not exceed the Permitted Number of Computers. You may not rent, lease, sublicense, lend or transfer versions or copies of the Software you do not use, or Software contained on any unused media.

 

 

(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.

 

 


COPYRIGHT

 

The Software is owned by Neevia Technology and/or its suppliers, and is protected by the copyright and trademark laws of the United States and related applicable laws. You may not copy the Software except as set forth in the "License" section. Any copies that you are permitted to make pursuant to this Agreement must contain the same copyright and other proprietary notices that appear on or in the Software.

 

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.

 

 

NO WARRANTY LICENSED SOFTWARE (S) - "AS IS"

 

The Software is provided AS IS. NEEVIA TECHNOLOGY AND ITS SUPPLIERS MAKE NO WARRANTIES, EXPRESS OR IMPLIED, AS TO THE MERCHANTABILITY, QUALITY, NONINFRINGEMENT OF THIRD PARTY RIGHTS, FITNESS FOR A PARTICULAR PURPOSE, AND THOSE ARISING BY STATUTE OR OTHERWISE IN LAW OR FROM A COURSE OF DEALING OR USAGE OF TRADE. THE ENTIRE RISK AS TO THE QUALITY, RESULTS BY USING THE SOFTWARE, AND PERFORMANCE OF THE SOFTWARE IS WITH THE END USER. Some states or jurisdictions do not allow the exclusion or limitation of incidental, consequential or special damages, or the exclusion of implied warranties or limitations on how long an implied warranty may last, so the above limitations may not apply to your or your company.

 

 

LIMITATION OF REMEDIES AND LIABILITY

 

NEEVIA TECHNOLOGY OR ITS SUPPLIERS OR RESELLERS SHALL NOT UNDER ANY CIRCUMSTANCE BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, INDIRECT, OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST SAVINGS, OR FOR ANY CLAIM BY A THIRD PARTY, ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE, EVEN IF NEEVIA TECHNOLOLGY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY.

 

 

 

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.

 


UPGRADES

 

You must be properly licensed to install upgrades to Neevia Software products. Neevia upgrades replace and or supplement the previous product that formed the basis for your eligibility to for the upgrade. You may use the upgrade only in accordance with the terms of this Agreement. Upgrades may not be separated and used on separate computers.

 

 

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.

 

 

         

 

 

 

 


Document Converter API Reference

 

 

Neevia Document Converter Pro supports conversion through a COM object / .NET assembly.

Before calling any methods from Neevia Document Converter COM object / .NET assembly, you must make sure that Neevia Document Converter is running.

 

 

Class ID:   Neevia.docConverter

 

 

Example:

VBScript:      Set NVDC = CreateObject("Neevia.docConverter")

 

C#:      Neevia.docConverter NVDC = new Neevia.docConverter();

 

VB.NET:      Dim NVDC as New Neevia.docConverter()

 

NOTE: By default, the .NET assembly can be found in the Program Files\neevia.com\docConverterPro\.NET folder;

 


Methods

 

 

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 the inputFolder is empty ("") then Document Converter will use as input folder the DefaultInputFolder (c:\ Program Files\Neevia.Com\docConverterPro\DEF_FOLDERS\IN\)

 

Ex: Res = NVDC.submitFile("c:\test.doc","") will submit the C:\test.doc file into                                                                c:\Program Files\Neevia.Com\docConverterPro\DEF_FOLDERS\IN.

 

Possible return values:

0  - Successfully submitted

 

 -1 - Internal error

 

 -2 - Invalid input file

Solution: Make sure that the user account you are calling the submitFile method from has full access to   the where the file is. Ex: If you are calling this method from ASP then make sure that the IUSR_ and IWAM_ user accounts have full access to the folder where your file is.

 

 -3 - Invalid input folder

Solution: Make sure that the input folder you are trying to use is defined in the Document Converter folder interface (Settings->Folders)

       

 -4 - A file with the same name already exists in the Input folder

  

 -5 - Unable to copy file to convert into the input folder

Solution: make sure that the document you are trying to submit exists and Document Converter has full access to it.

 

 -6 - Unable to copy file to convert into the output folder

Solution: make sure that the account your application runs under has full access to it the output folder.

 

 -7 - Invalid parameter - check the user manual for valid parameters.

 


submitFileEx

Submits a document for conversion.

 

Syntax

      Res = NVDC.submitFileEx(fileToSubmit, outFolder, errorFolder, origFolder)

 

Parameters

              fileToSubmit - full path to the file that is being converted;

              outFolder - the folder in which the converted document will go (without file name);

              errorFolder - the folder in which the error document will go (without file name);

              origFolder - the folder in which the original document will go (without file name);

 

Possible return values - see the submitFile method.

 

 

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 the inFolder is empty ("") then Document Converter will use as input folder DefaultInputFolder (c:\program files\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\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;

 

Possible Return values - see the submitFile method. 


checkStatus

Checks the status of the current conversion.

 

Syntax

       Res = NVDC.checkStatus(fileToCheck, inputFolder)

 

Parameters

                fileToCheck - The full path to the file submitted for conversion;

               inputFolder - The input folder where the document was submitted; This folder must be defined in the 

                                        Neevia Document Converter configuration.

 

If the inputFolder is empty ("") then Document Converter will use as input folder DefaultInputFolder (c:\Program Files\neevia.com\docConverterPro\DEF_FOLDERS\IN)

 

Possible Return values:

   0 - Converted successfully;

   1 - Error converting;

2 - File is pending conversion;

3 - Unable to determine the conversion status.

 

 

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.

 

 

 


getDefaultInputFolder

Returns the default input folder.

 

Syntax

        Res = NVDC.getDefaultInputFolder

 

 

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")

 

 

getParameter

Returns the value of a conversion parameter previously set by the setParameter method.

 

Syntax

         Res = NVDC.getParameter(paramName)

 

Parameters

                  paramName - parameter name;

 

 

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;

linearizePDF

Optimizes an existing PDF file for fast web view.

 

Syntax

       Res = NVDC.linearizePDF(inFile, outFile)

 

Parameters

                inFile - full path to PDF file to linearize;

              outFile - full path to destination file;

 

 

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;

 

 


encryptPDF

Encrypts an existing PDF file.

Note: in the trial version all files will be encrypted with "neevia" as user and "owner" as password.

 

Syntax

       Res = NVDC.encryptPDF(srcFile, destFile)

 

Parameters

               srcFile - full path to the file that needs to be decrypted;

     destFile - full path to the decrypted file;

 

Remarks

Res<>0 on error.

 

 

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")

 

splitPDF

Splits an existing PDF.

 

Syntax

     Res = NVDC.splitPDF(fileToSplit, destFolder)

 

Parameters

fileToSplit - path to input PDF file;

             destFolder - path to destination folder;

 

Example

 Res = NVDC.splitPDF("c:\t1.pdf", "c:\")

 

Remarks

     Res<>0 on error.

 

 

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.

 

 


mergeMultipleTIFF

Merges multiple TIFF files.

 

Syntax

      Res = NVDC.mergeMultipleTIFF(filesToMerge, destFile)

 

Parameters

 filesToMerge - TIFF files to merge, file names must be separated by +

              destFile - output TIFF file name;

 

Example

Res = NVDC.mergeMultipleTIFF("c:\t1.tif+c:\t2.tif+c:\t3.tif", "c:\out.tif")

 

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.


stampPDF

Stamps/watermarks an existing PDF document.

 

Syntax

      Res = NVDC.stampPDF(fileToStamp, destFile)

 

Parameters

  fileToStamp - path to input PDF file; 

               destFile - path to output PDF file;

 

Example

      Res = NVDC.stampPDF("c:\in.pdf", "c:\out.pdf")

 

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;

  

   

isFileInUse

Checks if a specified file is in use (locked).

 

Syntax

      Res = NVDC.isFileInUse(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;

 

 

deleteFolder

Deletes a specified folder and its contents.

 

Syntax

      Res = NVDC.deleteFolder(foldername)

 

Parameters

                foldername - path to the folder to delete;

 

 

 

 


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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Conversion parameters - GENERAL

 

 

DocumentOutputFormat

Sets the output format.

Possible values: "PDF", "PDFA", "PDFA2", "PS", "EPS", "PNG", "JPG", "TIFF", "FAX", "PCX", "PSD", "PRINTER", "PCL-XL", "SEND VIA FAX".

 

Syntax

       NVDC.setParameter("DocumentOutputFormat", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.

Note: “PDFA” means PDF/A-1b while “PDFA2” PDF/A-2b

 

DocumentOutputFolder

Specifies the folder where the converted document will go.

 

Syntax

NVDC.setParameter("DocumentOutputFolder", value)

 

Data type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.


ZIPpassword

Specifies the password to use with password protected ZIP/RAR files.

 

Syntax

      NVDC.setParameter("ZIPpassword", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.


Conversion parameters - EMAILING

 

 

RecipientAddress

Email address to send the converted document to.

Syntax

      NVDC.setParameter("RecipientAddress", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.

 

 

SMTPServerAddress

Specifies the SMTP server address.

Syntax

      NVDC.setParameter("SMTPServerAddress", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.

 

 

SMTPUser

Specifies the SMTP user name.

 

Syntax

      NVDC.setParameter("SMTPUser", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.

 

 

SMTPPassword

Specifies the SMTP account password.

 

Syntax

      NVDC.setParameter("SMTPPassword", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.

 

 

SMTPPort

Specifies the SMTP port to use.

Syntax

      NVDC.setParameter("SMTPPort", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.


SMTPEncryption

Specifies the SMTP encryption algorithm to use.

Possible values: "0" (no encryption),

"1" (SSL encryption),

"2" (TSL encryption)

 

Syntax

      NVDC.setParameter("SMTPEncryption", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.

 

 

SMTPFromName

Specifies the email sender’s name.

 

Syntax

      NVDC.setParameter("SMTPFromName", value)

 

Data type: String

Note: Can only be set prior to calling the submitFile method.

 

 

SMTPFromAddress

Specifies the email sender’s address.

 

Syntax

      NVDC.setParameter("SMTPFromAddress", value)

 

Data type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method.

 

 


SMTPErrorSubject

Specifies the email subject to send on conversion error.

 

Syntax

      NVDC.setParameter("SMTPErrorSubject", value)

 

Data type: String

Note: Can only be set prior to 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 prior to calling the submitFile method.


Conversion parameters - SCRIPTING

 

 

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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 

 


Conversion parameters - PRINTER related

 

 

UsePrinter

Specifies the printer Document Converter should use for conversion.

Syntax

        NVDC.setParameter("UsePrinter", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PRINTER" and "PrintEngine" is "1".


Conversion parameters - PostScript/EPS related

 

 

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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PS" or "EPS".


Conversion parameters - Image related

 

 

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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "TIFF".


JPGType

Sets image type when output format is "JPG".

Possible values:

    "jpeg", (Color - 16m colors RGB output)

    "jpegcmyk", (Color - CMYK output)

    "jpeggray". (Grayscale output)

 

Syntax

       NVDC.setParameter("JPGType", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "JPG".

 

 

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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PSD".


PCXType

Sets image type when output format is "PCX".

Possible values:

     "pcx24b", (Color - 24bits RGB output)

     "pcx16", (Color - 16 colors RGB output)

     "pcx256", (Color - 256 colors RGB output)

     "pcxcmyk", (Color - CMYK output)

     "pcxgray", (Grayscale output)

     "pcxmono". (Monochrome output)

 

Syntax

        NVDC.setParameter("PCXType", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PCX".

 

 

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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PXL".


ScalePage

Specifies whether Document Converter should scale the output document. If ScalePage is "false" output document will be stripped to ImgHeight/ImgWidth, if ScalePage is "true" output document will be scaled to ImgHeight/ImgWidth.

 

Syntax

    NVDC.setParameter("ScalePage", value)

 

Data Type:  String

Note: Can only be set prior to calling the submitFile method. Will have effect only if DocumentOutputFormat is "TIFF", "JPG", "BMP", "PNG" or "PCX".

 

 

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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if DocumentOutputFormat is "TIFF", "JPG", "BMP", "PNG" or "PCX" and ScalePage is "true".

 

 


ImgHeight

Specifies the output document height (in pixels).

 

Syntax

    NVDC.setParameter("ImgHeight", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method. Will have effect only if DocumentOutputFormat is "TIFF", "JPG", "BMP", "PNG" or "PCX".

 

 

ImgWidth

Specifies the output document width (in pixels).

 

Syntax

    NVDC.setParameter("ImgWidth", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if DocumentOutputFormat is "TIFF", "JPG", "BMP", "PNG" or "PCX".

 


FileNameSuffix

Specifies the output filename suffix.

If you use "%d" Document Converter will add the page number to the file name. You can also control the number of digits used in the file name by replacing %d with %0Nd where N is the number of digits you want to use, for example %03d will force the converter to produce files with names like this:  'filename001.jpg', ... , 'filename010.jpg', ...  %04d will produce:  'filename0001.jpg', ... , 'filename0010.jpg', ...

 

Syntax

        NVDC.setParameter("FileNameSuffix", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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

UseWTS

Specifies whether Well Tempered Screening algorithm should be used for halftoning.

Possible Values: "true", "false"

 

Syntax

        NVDC.setParameter("UseWTS", value)

 

Data Type: String

Note: the Well Tempered Screening algorithm is used for halftoning. If not enabled a rational tangent algorithm is chosen, which will typically result in significant differences between the screen angle and ruling requested, and actually rendered. Currently, the performance of WTS is reasonably good when rendering to a full page buffer, but not optimized for banded mode.

 

 

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 prior to calling the submitFile method. Will have effect only if DocumentOutputFormat is "FAX" or "SEND VIA FAX".


Conversion parameters - FAXING (SEND VIA FAX) related

 

 

FaxServer

Specifies the Fax Server address.

 

Syntax

       NVDC.setParameter("FaxServer", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "SEND VIA FAX".

 

 


CoverPage

Specifies the name of the cover page template file to associate with the fax document.

Possible Values: "none", "confdent", "fyi", "generic", "urgent"

 

Syntax

       NVDC.setParameter("CoverPage", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "SEND VIA FAX".

 

 

CoverEmail

Specifies the text to use for cover page "Sender’s Email Address" field.

 

Syntax

       NVDC.setParameter("CoverEmail", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "SEND VIA FAX".

 

 


CoverHomePhone

Specifies the text to use for cover page "Sender’s Home Phone" field.

 

Syntax

       NVDC.setParameter("CoverHomePhone", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "SEND VIA FAX".


Conversion parameters - PDF/A related

 

 

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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDFA".


Conversion parameters - PDF related

 

OptimizePDFfor

Possible values: "default", "screen", "printer", "prepress", "ebook".

For your convenience there are several sets of predefined settings for creating PDF files. These settings are designed to balance file size with quality, depending on how the PDF file is to be used:

 

• Default - is intended to be useful across a wide variety of uses, possibly at the expense of a larger output file. All color and grayscale images are downsampled at 72 dpi, monochrome images at 300 dpi; subsets of all fonts used in the file are embedded; and all information is compressed. PDF files created using the Default job option are compatible with Acrobat 4.0 (and later).

 

• Screen - intended for PDF files that will be displayed on the World Wide Web or an intranet, or that will be distributed through an e-mail system for on-screen viewing. This set of options uses compression, downsampling, and a relatively low resolution; converts all colors to RGB; maintains compatibility with Acrobat 3.0; to create a PDF file that is as small as possible. It also optimizes files for byte serving (fast web view).

 

• Printer - to be used for PDF files that are intended for desktop printers, digital copiers, publishing on a CD-ROM, or to send to a client as a publishing proof. In this set of options, file size is still important, but it is not the only objective. This set of options uses compression and downsampling to keep the file size down, but it also embeds subsets of all fonts used in the file, tags everything for color management, and prints to a medium resolution to create a reasonably accurate rendition of the original document.

 

• Prepress - intended for PDF files that will be printed as a high-quality final output to an imagesetter or, for example, a platesetter. In this case, file size is not a consideration. The objective is to maintain all the information in a PDF file that a commercial printer or service bureau will need to print the document correctly. This set of options downsamples color and grayscale images at 300 dpi, monochrome images at 1200 dpi, embeds subsets of all fonts used in the file, prints to a higher resolution, and uses other settings to preserve the maximum amount of information about the original document.

 

Syntax

       NVDC.setParameter("OptimizePDFfor", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 

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 prior to 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

DocumentResolution

Sets the output document resolution.

Possible values: "10"..."2400".

 

Syntax

        NVDC.setParameter("DocumentResolution", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method.

 

 

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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if DocumentOutputFormat is "PDF" 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 prior to calling the submitFile method. Will have effect only if DocumentOutputFormat is "PDF".

 


PDFVersion

Sets the compatibility level (a.k.a. PDF version) of the output PDF document.

Possible values:   "1.2" (Acrobat 3-and-later compatible)

"1.3" (Acrobat 4-and-later compatible)

"1.4" (Acrobat 5-and-later compatible)

"1.5" (Acrobat 6-and-later compatible)

"1.6" (Acrobat 7-and-later compatible)

"1.7" (Acrobat 8-and-later compatible)

 

Syntax

    NVDC.setParameter("PDFVersion", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 

DocumentTitle

Sets the title field in the output PDF document.

 

Syntax

  NVDC.setParameter("DocumentTitle", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 


DocumentKeywords

Sets the keywords field in the output PDF document.

 

Syntax

    NVDC.setParameter("DocumentKeywords", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 


PDFSubsetFonts

Indicates whether to include in the output PDF document only the font characters that are used in the original document.

Possible values: "true", "false"

 

Syntax

        NVDC.setParameter("PDFSubsetFonts", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 


ColorCompressMethod

Sets the compression method for color images in the output PDF document.

Possible values: "Automatic", "JPEG-maximum", "JPEG-high", "JPEG-medium", "JPEG-low",

"JPEG-minimum", "ZIP".

 

Syntax

       NVDC.setParameter("ColorCompressMethod", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 


MonoCompressMethod

Sets the compression method for monochrome images in the output PDF document.

Possible values:

           "CCITT" (compress monochrome images using the CCITT group 4-fax compression)

                 "ZIP" (compress monochrome images using ZIP-compatible compression)

 

Syntax

        NVDC.setParameter("MonoCompressMethod", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 


DownsampleColorImages

Specifies whether color images in the output PDF document should be downsampled.

Possible values: "true", "false"

 

Syntax

        NVDC.setParameter("DownsampleColorImages", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

MonoImageDownsampleType

Possible values: "Bicubic", "Average", "Subsample".

 

Syntax

       NVDC.setParameter("MonoImageDownsampleType", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 


PreserveOverprintSettings

Specifies whether overprint settings should be preserved.

Possible values: "true", "false"

 

Syntax

       NVDC.setParameter("PreserveOverprintSettings", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 

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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 


Conversion parameters - PDF Encryption

 

 

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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 

 


PDFOwnerPassword

Sets the output document owner password. This option will force the user of the PDF to enter a password before Acrobat Reader allows them to change the user password and security permissions.

 

Syntax

        NVDC.setParameter("PDFOwnerPassword", value)

 

Data Type: String

Note: Can only be set prior to 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 denied

     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 prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 

 

 

 

 


Conversion parameters - PDF viewer options

 

OpenAtPage

Specifies the page at which the output PDF document should open in PDF viewer.

 

Syntax

NVDC.setParameter("OpenAtpage", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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.


PageMode

Specifies how output file should be displayed when opened in PDF viewer.

Possible values:  "0"  Default view

"1"  Page only

"2"  Outlines (bookmarks) visible

"3"  Thumbnail images visible

"4"  Optional content group (layers) panel visible

"5"  Attachments panel visible

 

Syntax

         NVDC.setParameter("PageMode", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method. Will have effect only if "DocumentOutputFormat" is "PDF".

 

 

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 prior to 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

 

 

HideWindowUI

Specifies whether Acrobat Reader should hide the user interface when displaying PDF documents.

Possible values: "true", "false"

 

Syntax

   NVDC.setParameter("HideWindowUI", 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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Conversion parameters - Watermark/Stationery

 

 

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

 


StampFontSize

Specifies the watermark font size.

 

Syntax

     NVDC.setParameter("StampFontSize", value)

 

Example

      NVDC.setParameter( "StampFontSize", "40" )

 

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.bmp stroke.bmp fillStroke.bmp

                 Fill text, no stroke                  Stroke text, no fill                  Fill then stroke text

 

Syntax

  NVDC.setParameter("StampTextRenderingMode", value)

 

Data Type: String

 

 


StampFontEncoding

Specifies the font encoding.

 

Syntax

     NVDC.setParameter("StampFontEncoding", 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" )  (red)

 

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" )  (black)

 

Data Type: String

 

 

StampStrokeColor

Specifies font stroke color in RGB colorspace.

 

Syntax

     NVDC.setParameter("StampStrokeColor", value)

 

Example

      NVDC.setParameter( "StampStrokeColor", "#FF0000" ) (red)

 

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" )  (black)

 

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

 

 


StampOpacity

Specifies watermark opacity (transparency) level.

Possible values: "0" … "100". Default value: "100"

 

Syntax

     NVDC.setParameter("StampOpacity", value)

 

Data Type: String

 

 

PlaceStampOnPages

Specifies the pages to place watermark/stationery on.

Note: page numbers must be separated by commas. To place the watermark/stationery on all pages specify "0".

 

Syntax

     NVDC.setParameter("PlaceStampOnPages", value)

 

Example

     NVDC.setParameter( "PlaceStampOnPages", "1,3,7" )   

     (will place watermark on pages 1, 3 and 7)

 

Data Type: String

 

 

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.

 

 

StampWidth

Specifies the stamp width.

 

Syntax

     NVDC.setParameter("StampWidth", value)

 

Data Type: String

Note: will have effect only for TextBox and Image stamps.

 

 

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: "0" (left), "1" (center), "2" (right)

 

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

 

StampGoToPage

Specifies the page number to go to when the stamp is clicked.

 

Syntax

  NVDC.setParameter("StampGoToPage", 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: "stamp" as stamp: over page content (Default),

"watermark" 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

 

 


StampPDFOverlay

Specifies the PDF file to use as stationery.

 

Syntax

       NVDC.setParameter("StampPDFOverlay", value)        

 

Example

       NVDC.setParameter( "StampPDFOverlay", "c:\stationery.pdf" )

 

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

 


Conversion parameters - mergePDF / mergeMultiplePDF related

 

 

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.

 

 

 

 

 

 

 

 


Conversion parameters - splitPDF related

 

 

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.

 


Conversion parameters - mergePDF, mergeMultiplePDF, splitPDF related

 

 

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.

Parser-specific parameters - PSPDF

 

 

ParserTimeout

Sets timeout (in seconds) for the PSPDF parser.

 

Syntax

        NVDC.setParserParameter("PSPDF", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.


ReparseBadPDF

Specifies whether Document Converter should attempt to repair corrupted PDF files.

Possible Values: "true", "false"

 

Syntax

        NVDC.setParserParameter("PSPDF", "ReparseBadPDF", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.


Parser-specific parameters - IMAGE/OCR

 

 

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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method. Will have effect only if "OCR" is "true".

 

 


AutoRotate

Specifies whether the OCR engine should attempt to determine the orientation of the page.

Possible Values: "true", "false"

 

Syntax

        NVDC.setParserParameter("IMAGE/OCR", "AutoRotate", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to calling the submitFile method. Will have effect only if "OCR" is "true".


Parser-specific parameters - WORD

 

 

ParserTimeout

Sets timeout (in seconds) for the WORD parser.

 

Syntax

        NVDC.setParserParameter("WORD", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method. Valid only for Word 2007 / 2010.

 

 

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)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method.

 

 

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 prior to calling the submitFile method.

ConvertInternetLinks

Specifies whether Internet links should be preserved when converting Word documents to PDF

Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("WORD", "ConvertInternetLinks", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 

ConvertTextBoxesToArticleThreads

Specifies whether text boxes in the original Word document should be converted to PDF article threads. An article thread makes navigating easier by leading readers through the PDF content.

Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("WORD", "ConvertTextBoxesToArticleThreads", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 

BookmarkMagnification

Sets bookmark magnification level when converting Word bookmarks to PDF bookmarks.

Posible values: "0" inherit zoom, "1" fit page width to window, "2" fit page height to window,

"3" fit page to window

 

Syntax

        NVDC.setParserParameter("WORD", "BookmarkMagnification", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.


ConvertFormFields

Specifies whether form fields in the original document should be converted to PDF form fields.

Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("WORD", "ConvertFormFields", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

HideDocumentRevisions

Specifies whether document revisions in the original Word document should be preserved when converting to PDF. Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("WORD", "HideDocumentRevisions", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

RepaginateBeforeConverting

Specifies whether the original Word document should be repaginated before converting.

Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("WORD", "RepaginateBeforeConverting", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 


RightMargin

Sets the right margin in Word document (in inches).

 

Syntax

        NVDC.setParserParameter("WORD", "RightMargin", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 

 


TXTEncoding

Specifies what encoding the Word parser should use when converting TEXT files.

 

Syntax

        NVDC.setParserParameter("WORD", "TXTEncoding", value)

 

Data Type: String

Note: Can only be set prior to 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.

"50935"

EBCDIC as used with Simplified Chinese (extended) and Simplified Chinese.

"20838"

EBCDIC as used with Thai.

"20905"

EBCDIC as used with Turkish.

"1026"

EBCDIC as used with Turkish (Latin 5).

"20285"

EBCDIC as used in the United Kingdom.

"37"

EBCDIC as used in the United States and Canada.

"50931"

EBCDIC as used in the United States and Canada, and with Japanese.

"50937"

EBCDIC as used in the United States and Canada, and with Traditional Chinese.

"51936"

Extended Unix Code (EUC) as used with Chinese and Simplified Chinese.

"51932"

EUC as used with Japanese.

"51949"

EUC as used with Korean.

"51950"

EUC as used with Taiwanese and Traditional Chinese.

"29001"

Europa.

"21027"

Extended Alpha lowercase.

"1253"

Greek.

"51253"

Web browser auto-detects type of Greek encoding to use.

"1255"

Hebrew.

"52936"

Simplified Chinese (HZGB).

"20106"

German (International Alphabet No. 5, or IA5).

"20105"

IA5, International Reference Version (IRV).

"20108"

IA5 as used with Norwegian.

"20107"

IA5 as used with Swedish.

"57006"

Indian Script Code for Information Interchange (ISCII) as used with Assamese.

"57003"

ISCII as used with Bengali.

"57002"

ISCII as used with Devanagari.

"57010"

ISCII as used with Gujarati.

"57008"

ISCII as used with Kannada.

"57009"

ISCII as used with Malayalam.

"57007"

ISCII as used with Oriya.

"57011"

ISCII as used with Punjabi.

"57004"

ISCII as used with Tamil.

"57005"

ISCII as used with Telugu.

"50229"

ISO 2022-CN encoding as used with Simplified Chinese.

"50227"

ISO 2022-CN encoding as used with Traditional Chinese.

"50222"

ISO 2022-JP

"50221"

ISO 2022-JP

"50220"

ISO 2022-JP with no half-width Katakana.

"50225"

ISO 2022-KR.

"20269"

ISO 6937 Non-Spacing Accent.

"28605"

ISO 8859-15 with Latin 9.

"28591"

ISO 8859-1 Latin 1.

"28592"

ISO 8859-2 Central Europe.

"28593"

ISO 8859-3 Latin 3.

"28594"

ISO 8859-4 Baltic.

"28595"

ISO 8859-5 Cyrillic.

"28596"

ISA 8859-6 Arabic.

"28597"

ISO 8859-7 Greek.

"28598"

ISO 8859-8 Hebrew.

"38598"

ISO 8859-8 Hebrew (Logical).

"28599"

ISO 8859-9 Turkish.

"50932"

Web browser auto-detects type of Japanese encoding to use.

"932"

Japanese (Shift-JIS).

"20866"

KOI8-R.

"21866"

K0I8-U.

"949"

Korean.

"50949"

Web browser auto-detects type of Korean encoding to use.

"1361"

Korean (Johab).

"10004"

Macintosh Arabic.

"10082"

Macintosh Croatian.

"10007"

Macintosh Cyrillic.

"10006"

Macintosh Greek.

"10005"

Macintosh Hebrew.

"10079"

Macintosh Icelandic.

"10001"

Macintosh Japanese.

"10003"

Macintosh Korean.

"10029"

Macintosh Latin 2.

"10000"

Macintosh Roman.

"10010"

Macintosh Romanian.

"10008"

Macintosh Simplified Chinese (GB 2312).

"10002"

Macintosh Traditional Chinese (Big 5).

"10081"

Macintosh Turkish.

"10017"

Macintosh Ukrainian.

"864"

OEM as used with Arabic.

"775"

OEM as used with Baltic.

"863"

OEM as used with Canadian French.

"855"

OEM as used with Cyrillic.

"866"

OEM as used with Cyrillic II.

"737"

OEM as used with Greek 437G.

"862"

OEM as used with Hebrew.

"861"

OEM as used with Icelandic.

"869"

OEM as used with Modern Greek.

"850"

OEM as used with multi-lingual Latin I.

"852"

OEM as used with multi-lingual Latin II.

"865"

OEM as used with Nordic languages.

"860"

OEM as used with Portuguese.

"857"

OEM as used with Turkish.

"437"

OEM as used in the United States.

"50936"

Web browser auto-detects type of Simplified Chinese encoding to use.

"54936"

Simplified Chinese GB 18030.

"936"

Simplified Chinese GBK.

"20261"

T61.

"20000"

Taiwan CNS.

"20002"

Taiwan Eten.

"20003"

Taiwan IBM 5550.

"20001"

Taiwan TCA.

"20004"

Taiwan Teletext.

"20005"

Taiwan Wang.

"874"

Thai.

"50950"

Web browser auto-detects type of Traditional Chinese encoding to use.

"950"

Traditional Chinese Big 5.

"1254"

Turkish.

"1201"

Unicode big endian.

"1200"

Unicode little endian.

"20127"

United States ASCII.

"65000"

UTF-7 encoding.

"65001"

UTF-8 encoding.

"1258"

Vietnamese.

"1252"

Western.


Parser-specific parameters - EXCEL

 

 

ParserTimeout

Sets timeout (in seconds) for the EXCEL parser.

 

Syntax

        NVDC.setParserParameter("EXCEL", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method. Valid only for Excel 2007 / 2010.

 

 

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 prior to 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 prior to calling the submitFile method.

ConvertWhat

Specifies if Excel should convert the entire worksheet, selected sheet(s) by number or selected sheet(s) by name. Possible values: "0" entire workbook, "1" selected sheet by number, "2" selected sheet by name.

 

Syntax

        NVDC.setParserParameter("EXCEL", "ConvertWhat", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to 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("EXCEL", "LinkColor", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.


AutoFit

Specifies whether Excel should auto fit rows and columns prior to converting the file.

Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("EXCEL", "AutoFit", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

Orientation

Sets the page orientation in Excel document.

Posible values: "0" default, "1" portrait, "2" landscape

 

Syntax

        NVDC.setParserParameter("EXCEL", "Orientation", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Parser-specific parameters - POWERPOINT

 

 

ParserTimeout

Sets timeout (in seconds) for the POWERPOINT parser.

 

Syntax

        NVDC.setParserParameter("POWERPOINT", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method. Valid only for PowerPoint 2007 / 2010.

 

 

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 prior to 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 prior to calling the submitFile method.

 

ConvertSpeakerNotes

Specifies whether speaker notes should be preserved when converting Powerpoint documents to PDF.

Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("POWERPOINT", "ConvertSpeakerNotes", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

LinkStyle

Specifies the border style PDF links will use.

Possible values: "0" (solid), "1" (dashed)

 

Syntax

        NVDC.setParserParameter("POWERPOINT", "LinkStyle", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Parser-specific parameters - PUBLISHER

 

 

ParserTimeout

Sets timeout (in seconds) for the PUBLISHER parser.

 

Syntax

        NVDC.setParserParameter("PUBLISHER", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method. Valid only for Publisher 2007 / 2010.

 

 

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 prior to 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 prior to calling the submitFile method. Will have effect only if "UseNativePDFExport" is "true".

ConversionView

Specifies the document conversion style.

Possible values: "0" default style,  "1" booklet style with a side fold, "2" booklet style with a top fold, "3" envelope style, "4" half fold on the side style, "5" half fold on the top style, "6" quarter fold side style, "7" quarter fold top style, "8" Tiled style, "9" multiple copies of the publication per sheet, "10" multiple pages of the publication per sheet, "11" one page of the publication on one sheet

Syntax

        NVDC.setParserParameter("PUBLISHER", "ConversionView", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to 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("PUBLISHER", "LinkHighLight", value)

 

Data Type: String

Note: Can only be set prior to calling the submitFile method.

 

 

 

 

 

 

 

 

 

 


Parser-specific parameters - VISIO

 

 

ParserTimeout

Sets timeout (in seconds) for the VISIO parser.

 

Syntax

        NVDC.setParserParameter("VISIO", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method

 

IncludeBackground

Specifies whether the Visio parser should include background pages.

Possible values: "true", "false"

 

Syntax

        NVDC.setParserParameter("VISIO", "IncludeBackground", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to calling the submitFile method

 

 


Parser-specific parameters - HTML

 

 

ParserTimeout

Sets timeout (in seconds) for the HTML parser.

 

Syntax

        NVDC.setParserParameter("HTML", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

Header

Overrides the Header property for the HTML document 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", "Header", value)

 

Example

      NVDC.setParserParameter( "HTML", "Header", "Page &p of &P" )

 

Data Type: String

Note: Can only be set prior to 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 prior to calling the submitFile method.


HTMLHeader

Overrides the HTMLHeader property for the HTML parser.

 

Syntax

      NVDC.setParserParameter("HTML", "HTMLHeader", value)

 

Example

      NVDC.setParserParameter( "HTML", "HTMLHeader", "<LI>Test header</LI>" )

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

 

TopMargin

Sets the top margin (in inches).

 

Syntax

        NVDC.setParserParameter("HTML", "TopMargin", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to calling the submitFile method.

 

 

 

 


Parser-specific parameters - EMAIL

 

 

ParserTimeout

Sets timeout (in seconds) for the EMAIL parser.

 

Syntax

        NVDC.setParserParameter("EMAIL", "ParserTimeout", value)

 

Data Type: String

Note: Can only be set prior to 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 prior to 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 prior to 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 prior to 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 prior to calling the submitFile method.

 

BodyEncoding

Sets text encoding for the data contained in email body.

 

Syntax

        NVDC.setParserParameter("EMAIL", "BodyEncoding", value)

 

Data Type: String

Note: Can only be set prior to 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", "