LEADTOOLS OCR Module - OmniPage Engine Settings

The Leadtools.Ocr.IOcrSettingManager.GetSettingNames method returns the names of the values as described in this table and in the same order.

The table below describes the settings supported by the LEADTOOLS OCR Module - OmniPage Engine.
Name Type Range and values Description
Recognition BeginCategory N/A Beginning of the General Recognition Settings category.
Recognition.SpaceIsValidCharacter Boolean N/A

true to treat a whitespace as a valid character in recognition; otherwise, false (ignore all whitespaces). The default value is false.

For more information, refer to IOcrPage.GetRecognizedCharacters.

Recognition.DefaultCharacterFilter Enum (Flags)

Specifies which character set (Global filter) to apply globally at the page level. The default value is Digit | Uppercase | Lowercase | Punctuation | Miscellaneous (0x01 | 0x02 | 0x04 | 0x08 | 0x10 = 0x1F).

Values can be OR'ed together. Possible values are:

Value Description
(0) None

None

(0x01) Digit

Recognize only numerals. E.g.: "3" (Digit Three)

(0x02) Uppercase

Recognize only uppercase letters, including accented ones. E.g.: "A" (Capital A)

(0x04) Lowercase

Recognize only lowercase letters, including accented ones. E.g.: "a" (Lowercase a)

(0x08) Punctuation

Recognize only punctuation signs. E.g.: "!" (Exclamation Point)

(0x10) Miscellaneous

Recognize only other miscellaneous characters. E.g.: "+" (Plus sign)

(0x20) Plus

Use the characters specified by the "Language.FilterPlusCharacters" setting. The Plus characters are added after any kind of filtering

Recognition.ForceSingleColumn Boolean N/A

true to force single column mode for the page-layout; otherwise, false. The default value is false.

This setting prevents the engine's decolumnization process from detecting columns and placing their contents one below the other. It is useful for conserving the columnar structure in tables.

Recognition.DetectNonGriddedTable Boolean N/A

true to detect non-gridded tables; otherwise, false. The default value is true.

Recognition.EnableMorFaxMode Boolean N/A

true to switch the Fax image mode on for the multi-lingual omnifont recognition module; otherwise, false. The default value is false.

Turn this setting on if the image file to be loaded is a fax message transmitted in "Draft" mode at 200 x 100 resolution. Do not use this switch to read fax card image files transmitted in "Fine" mode (200 x 200 dpi resolution).

Recognition.RecognitionModuleTradeoff Enum

Specifies which recognition algorithm trade-off setting to use during recognition. The default value is Accurate.

This specifies how to trade off accuracy for speed of recognition when performing recognition at the page level. The precise influence depends on which recognition module is used. This setting can also influence which auto-zoning and preprocessing algorithms are applied.

Possible values are:

Value Description
(0) Accurate

Most accurate recognition.

(1) Balanced

Mid-level accuracy/speed recognition.

(2) Fast

Fast recognition.

Recognition.IcrNumeral BeginCategory N/A Beginning of the ICR (hand-printed) Recognition Settings category.
Recognition.IcrNumeral.Style Enum

The writing style setting for hand-printed numeral recognition module. The default value is Euro.

As an example, the European style expects sevens (7) to be crossed, whereas they are not crossed in the North American style.

Possible values are:

Value Description
(0) Euro

Writing is in the European style. This is the default value.

(1) US

Writing is in the North American style.

Recognition.IcrNumeral.CharacterBoxData.Height Integer 0 to Int32.MaxValue

Character height, in 1/1200 inches. The default value is 0.

A value of zero (0) forces the automatic calculation of this setting.

Recognition.IcrNumeral.CharacterBoxData.Width Integer 0 to Int32.MaxValue

Character width in 1/1200 inches. The default value is 0.

A value of zero (0) forces the automatic calculation of this setting.

Recognition.IcrNumeral.CharacterBoxData.LeadingSpaces Integer 0 to Int32.MaxValue

Leading spaces in 1/1200 inches. The default value is 0.

A value of zero (0) forces the automatic calculation of this setting.

Recognition.IcrNumeral.EnableSpaceInclusion Boolean N/A true if the hand-printed numeral recognition module should export spaces detected between characters; otherwise, false. The default value is true.
End:Recognition.IcrNumeral EndCategory N/A End of the ICR (Handprint) Recognition Settings category.
Recognition.Zoning BeginCategory N/A Beginning of the Zoning Settings category.
Recognition.Zoning.DisableMultiThreading Boolean N/A

true to disable multi-threading when performing auto-zoning; otherwise, multi-threading is enabled. The default value is false.

Multi-threading enhances auto-zoning performance. However, it can be undesirable if the OCR engine is hosted on a server.

End:Recognition.Zoning EndCategory N/A End of the Zoning Settings category.
Recognition.PreProcessing BeginCategory N/A Beginning of the Pre-Processing Settings category.
Recognition.PreProcessing.BinarizationMode Enum

This setting influences how a non-black and white image, stored in the Engine, is converted to a black and white one. The default value is Auto.

Possible values are:

Value Description
(0) Auto

Use an automatic adaptive thresholding algorithm. Affects grayscale or 24-bit color images. A black and white image will be created in the Engine's memory. Use the Recognition.PreProcessing.Brightness setting to tune the threshold value.

(1) Set

Use Recognition.PreProcessing.Threshold to set the value. Affects grayscale or 24-bit color images. A black and white image will be created in the Engine's memory, with thresholding performed with the user-defined threshold value.

(2) No

Perform no conversion while loading the image. The image will be loaded into the Engine's memory without any conversion (i.e., a color image will retain its color attributes).

(3) Global

Use the automatic thresholding algorithm with a page-level, global threshold value. Affects grayscale or 24-bit color images. A black and white image will be created in the Engine's memory. An automatic thresholding algorithm with a page-level global threshold value is used to convert the image to black and white.

(4) Gray

If the image is a color image, create a grayscale image in the Engine's memory. If the image is black and white or grayscale, do not perform conversion while loading the image.

Recognition.PreProcessing.InvertMode Enum

This setting will specify which image inversion mode (white-on-black to black-on-white) will be used during subsequent image processing processes. The image inversion mode can be either automatic, switched on or switched off. The default value is Auto.

Possible values are:

Value Description
(0) No

Do not perform inversion.

(1) Yes

Perform image inversion.

(2) Auto

Automatically invert the image, if necessary. Determines whether to invert the image during preprocessing.

Recognition.PreProcessing.RotationMode Enum

This setting will specify which Image rotation mode will be used during subsequent image processing. Image rotation mode can be automatic, switched off or rotated by specified amounts. The default value is Auto.

Possible values are:

Value Description
(0) Auto

Perform automatic image rotation.

(1) No

Do not transform the image.

(2) Right

Rotate the image to the right (clockwise).

(3) Down

Rotate the image down (rotate twice).

(4) Left

Rotate the image to the left (anti-clockwise).

Recognition.PreProcessing.EnableDespeckleMode Boolean N/A

true to enable image despeckling mode; otherwise, false. The default value is true.

Image despeckling is an adaptive noise removal algorithm used on black and white images having a resolution of 280 DPI or higher. This setting can influence the recognition accuracy.

Recognition.PreProcessing.Brightness Integer 0 to 100

Brightness value. The default value is 50.

This setting fine-tunes the threshold calculation in the automatic adaptive image conversion mode used when the Recognition.PreProcessing.BinarizationMode setting is set to Auto. This will influence the brightness/darkness of the resulting black and white image during subsequent image processing.

Recognition.PreProcessing.Threshold Integer 0 to 255

Black and white image conversion threshold. The default value is 128.

This setting specifies the threshold parameter of an image conversion to a black and white image. This parameter has an effect only when the Recognition.PreProcessing.BinarizationMode setting is set to Set. This setting is used during subsequent image processing.

End:Recognition.PreProcessing EndCategory N/A End of the Pre-Processing Settings category.
End:Recognition EndCategory N/A End of the Recognition Settings category.
Language BeginCategory N/A Beginning of the Language Settings category.
Language.LanguagesPlusCharacters String Maximum of 1024 characters. Can be a null value. Extra characters added to the set of characters determined by the language selection. The default value is a string containing the following 4 unicode characters: U+2446 U+2447 U+2448 U+2449.
Language.FilterPlusCharacters String Maximum of 1024 characters. Can be a null value.

FilterPlus characters can broaden the filtered set of characters globally or on a per-zone basis. The default value is an empty string.

To allow the use of these FilterPlus characters, the zone's CharacterFilters property must include OcrZoneCharacterFilters.Plus.

End:Language EndCategory N/A End of the Language Settings category.
SaveDocument BeginCategory N/A Beginning of the Save Document Settings category.
SaveDocument.FormatLevel Enum

Levels of format retention for the final output. The default value is Auto.

For a list of supported output formats for each format level see the table at the bottom of the page.

The following values are possible:

Value Description
(0) Auto

Automatic

(1) NoFormat

Ignore all formatting information and replace it by default values.

(2) RetainFontAndParagraph

Retain formatting information about fonts and paragraphs, but ignore layout-related information.

(3) TruePage

Keep the look of the original layout of the pages. This is done by absolute positioning of the text, pictures, and tables on the page with boxes, frames, or other target application-specific methods.

(4) FlowingPage

Preserve the original layout of the pages. Retain columns. Boxes and frames are only used when necessary.

(5) SpreadSheet

Export the results in tabular form, (suitable for use in spreadsheet applications). Each page is placed in a separate worksheet

SaveDocument.DocumentFormat BeginCategory N/A Beginning of the Document Format Save Options category.
SaveDocument.DocumentFormat.Excel2000 BeginCategory N/A Beginning of the Excel 2000 Output Format Options category.
SaveDocument.DocumentFormat.Excel2000.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.Excel2000.DocAuthor String Maximum of 1024 characters. Can be a null value. String containing the name of the author of the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.DocCategory String Maximum of 1024 characters and can be a null value. String containing the category of the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.DocComments String Maximum of 1024 characters and can be a null value. String containing the comments for the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.DocCompany String Maximum of 1024 characters and can be a null value String containing the company name of the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.DocKeywords String Maximum of 1024 characters and can be a null value. String containing the keywords for the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.DocManager String Maximum of 1024 characters and can be a null value. String containing the name of the manager of the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.DocSubject String Maximum of 1024 characters and can be a null value String containing the subject of the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.DocTitle String Maximum of 1024 characters and can be a null value. String containing the title of the document. The default value is null.
SaveDocument.DocumentFormat.Excel2000.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.Excel2000.OverviewSheetName String Maximum of 1024 characters and can be a null value String containing the name of the last sheet. The default value is "Overview".
SaveDocument.DocumentFormat.Excel2000.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Excel2000.PageColor Boolean N/A

true to retain the page background color; otherwise, false to use the default color. The default value is false.

SaveDocument.DocumentFormat.Excel2000.SheetNamePrefix String Maximum of 1024 characters and can be a null value. String containing the generated sheet names. The default value is "Sheet".
End:SaveDocument.DocumentFormat.Excel2000 EndCategory N/A End of the Excel 2000 Output Format Options category.
SaveDocument.DocumentFormat.Excel97 BeginCategory N/A Beginning of the Excel 97 Output Format Options category.
SaveDocument.DocumentFormat.Excel97.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.Excel97.DocAuthor String Maximum of 1024 characters and can be a null value String containing the name of the author of the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.DocCategory String Maximum of 1024 characters and can be a null value. String containing the category of the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.DocComments String Maximum of 1024 characters and can be a null value. String containing the comments for the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.DocCompany String Maximum of 1024 characters and can be a null value. String containing the company name of the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.DocKeywords String Maximum of 1024 characters and can be a null value. String containing the keywords for the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.DocManager String Maximum of 1024 characters and can be a null value. String containing the name of the manager of the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.DocSubject String Maximum of 1024 characters and can be a null value. String containing the subject of the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.DocTitle String Maximum of 1024 characters and can be a null value. String containing the title of the document. The default value is null.
SaveDocument.DocumentFormat.Excel97.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.Excel97.OverviewSheetName String Maximum of 1024 characters and can be a null value. String containing the name of the last sheet. The default value is "Overview".
SaveDocument.DocumentFormat.Excel97.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Excel97.PageColor Boolean N/A

true to retain the page background color; otherwise, false to use the default color. The default value is false.

SaveDocument.DocumentFormat.Excel97.SheetNamePrefix String Maximum of 1024 characters and can be a null value. String containing the generated sheet names. The default value is "Sheet".
End:SaveDocument.DocumentFormat.Excel97 EndCategory N/A End of the Excel 97 Output Format Options category.
SaveDocument.DocumentFormat32 BeginCategory N/A Beginning of the HTML 3.2 Output Format Options category.
SaveDocument.DocumentFormat32.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is false.
SaveDocument.DocumentFormat32.Crossrefs Boolean N/A true to keep cross-references; otherwise, false. The default value is true.
SaveDocument.DocumentFormat32.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat32.HRBetweenSections Boolean N/A

true to allow horizontal rules lines to be placed between sections; otherwise, false. The default value is true.

SaveDocument.DocumentFormat32.IndexPage Enum

Specifies the page index. The default value is Simple.

Possible values are:

Value Description
(0) No No index
(1) Simple Simple HTML
(2) Frame In a frame
SaveDocument.DocumentFormat32.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat32.NavNextText String Maximum of 1024 characters. Can be a null value. String containing the text for the Next navigation text. The default value is "Next".
SaveDocument.DocumentFormat32.NavPrevText String Maximum of 1024 characters. Can be null value String containing the text for the Previous navigation text. The default value is "Previous".
SaveDocument.DocumentFormat32.NavTOCText String Maximum of 1024 characters. Can be a null value. String containing the text for the Index navigation text. The default value is "Index".
SaveDocument.DocumentFormat32.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat32.PutItSubdirectory Boolean N/A

true to put every file into a subdirectory; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat32 EndCategory N/A End of the HTML 3.2 Output Format Options category.
SaveDocument.DocumentFormat40 BeginCategory N/A Beginning of the HTML 4.0 Output Format Options category.
SaveDocument.DocumentFormat40.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat40.CharColors Boolean N/A

true to keep the font colors of the characters; otherwise, false. The default value is true.

SaveDocument.DocumentFormat40.CharSpacing Boolean N/A

true to keep character spacing; otherwise, false. The default value is true.

SaveDocument.DocumentFormat40.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

SaveDocument.DocumentFormat40.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat40.HRBetweenSections Boolean N/A

true to allow horizontal rules lines to be placed between sections; otherwise, false. The default value is true.

SaveDocument.DocumentFormat40.IndexPage Enum

Specifies the page index. The default value is Simple.

Possible values are:

Value Description
(0) No No index
(1) Simple Simple HTML
(2) Frame In a frame
SaveDocument.DocumentFormat40.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat40.NavNextText String Maximum of 1024 characters. Can be a null value. String containing the text for the Next navigation text. The default value is "Next".
SaveDocument.DocumentFormat40.NavPrevText String Maximum of 1024 characters. Can be null value String containing the text for the Previous navigation text. The default value is "Previous".
SaveDocument.DocumentFormat40.NavTOCText String Maximum of 1024 characters. Can be a null value. String containing the text for the Index navigation text. The default value is "Index".
SaveDocument.DocumentFormat40.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat40.PutItSubdirectory Boolean N/A

true to put every file into a subdirectory; otherwise, false. The default value is true.

SaveDocument.DocumentFormat40.Styles Boolean N/A

true to retain styles; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat40 EndCategory N/A End of the HTML 4.0 Output Format Options category.
SaveDocument.DocumentFormat.InfoPath BeginCategory N/A Beginning of the InfoPath Output Format Options category.
SaveDocument.DocumentFormat.InfoPath.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.InfoPath.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.InfoPath.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.InfoPath.Pictures Enum

Specifies the pictures DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.InfoPath.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat.InfoPath EndCategory N/A End of the InfoPath Output Format Options category.
SaveDocument.DocumentFormat.PDF BeginCategory N/A Beginning of the PDF Image On Text Output Format Options category category.
SaveDocument.DocumentFormat.PDF.AdditionalFonts Boolean N/A

true to enable the use of additional fonts; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.AppendFrom String Maximum of 1024 characters. Can be a null value. String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PDF.AppendFromPassword String Maximum of 1024 characters. Can be null value String containing the password to enable the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PDF.ColorQuality Enum

Specifies the color quality for the output PDF file. The default value is Minimum.

Possible values are:

Value Description
(0) Minimum Minimum size (highest compression)
(1) Good Good quality
(2) Lossless Lossless compression
SaveDocument.DocumentFormat.PDF.Compatibility Enum

Specifies which version of PDF to use for compatibility. The default value is PDF1.6.

Possible values are:

Value Description
(0) ForceSize Automatically use PDF mode that has the smallest output size
(1) ForceQuality Automatically use PDF mode that has the highest quality
(2) PDF 1.5 PDF 1.5
(3) PDF1.4 PDF 1.4
(4) PDF1.3 PDF 1.3
(5) PDF1.2 PDF 1.2
(6) PDF1.1 PDF 1.1
(7) PDF1.0 PDF 1.0
(8) PDF-A PDF/A
(9) PDF1.6 PDF 1.6
SaveDocument.DocumentFormat.PDF.CompForContents Boolean N/A

true to enable compression of text and line art; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.CompForTTF Boolean N/A

true to enable embedded files to be compressed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.UseFlate Boolean N/A

true to enable Flate compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.UseJBIG2 Boolean N/A

true to enable JBIG2 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.UseJPEG2000 Boolean N/A

true to enable JPEG2000 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.UseLZWInsteadOfFlate Boolean N/A

true to enable the use of LZW instead of Flate compression; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.Outline Boolean N/A

true to use bookmarks for the pages; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.OutlineNumbering Boolean N/A

true to add page numbers to the page name; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.OutlinePageName String Maximum of 1024 characters and can be a null value String containing the page name of the bookmark. The default value is "Page".
SaveDocument.DocumentFormat.PDF.PDFFormVisuality Boolean N/A

true to display the visual components of the form; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.EnableAdd Boolean N/A

true if comments and form fields can be changed or edited; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.EnableAssemble Boolean N/A

true if documents can be assembled; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.EnableCopy Boolean N/A

true if material can be copied or extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.EnableExtract Boolean N/A

true if material can be extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.EnableForms Boolean N/A

true if forms can be filled out; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.EnableModify Boolean N/A

true if documents can be modified; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.EnablePrint Boolean N/A

true if output PDF files can be printed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.EnablePrintQ Boolean N/A

true if high quality printing can be performed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.OwnerPassword String Maximum of 1024 characters. Can be null value String containing the owner password. The default value is null.
SaveDocument.DocumentFormat.PDF.PDFSecurity Enum

Specifies the PDF security type. The default value is None.

Possible values are:

Value Description
(0) None No security
(1) 40Bits Use 40-bit compression
(2) 128Bits Use 128-bit compression
SaveDocument.DocumentFormat.PDF.UserPassword String Maximum of 1024 characters and can be a null value String containing the user password. The default value is null.
SaveDocument.DocumentFormat.PDF.PictureColor Enum

The PDF color depth. The default value is Original.

Possible values are:

Value Description
(0) Original Original image bit depth
(1) BlackAndWhite Black and white
(2) Grayscale Grayscale
(3) 24BPP Colored 24 Bits/pixel
SaveDocument.DocumentFormat.PDF.CertificateDescription String Maximum of 1024 characters and can be a null value String containing the certificate description. The default value is null.
SaveDocument.DocumentFormat.PDF.CertificateSHA1 String Maximum of 1024 characters and can be a null value String containing the certificate SHA1 thumbprint. The default value is null.
SaveDocument.DocumentFormat.PDF.SignatureType Enum

The PDF signature type. The default value is None.

Possible values are:

Value Description
(0) None Not signed
(1) Pklite PKlite Signature
(2) Verisign Verisign Signature
SaveDocument.DocumentFormat.PDF.URLBackgorund Integer 0 to Int32.MaxValue The color for the URL background in BBGGRR format. The default value is 0xFFFFFF (white).
SaveDocument.DocumentFormat.PDF.URLForeground Integer 0 to Int32.MaxValue The color for the URL foreground in BBGGRR format. The default value is FF0000 (blue).
SaveDocument.DocumentFormat.PDF.URLForegroundDef Boolean N/A

true to use the default foreground color for the URL; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.URLUnderline Boolean N/A

true to underline URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.UseMRC Enum

The PDF MRC (Mixed Raster Content) compression type for the output PDF file. The default value is No.

Possible values are:

The PDF MRC type for the output PDF file
Value Description
(0) No Do not use MRC
(1) Minimum Minimum output PDF size (highest compression)
(2) Good Good quality output PDF size (moderate compression)
(3) Lossless Lossless compression (highest quality)
SaveDocument.DocumentFormat.PDF.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.PDF.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is None.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.PDF.NeedTaggedInfo Boolean N/A

true to create a tagged PDF file; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.PDFThumbnail Boolean N/A

true to create thumbnails; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.Pictures Enum

Specifies the pictures DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.PDF.PDFForms Boolean N/A

true to display the form layer; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.ShowBackgroundImage Boolean N/A

true to display the background image layer; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.ShowText Boolean N/A

true to display the text; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PDF.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.URLBackgroundDef Boolean N/A

true to display the default background color for any URLs; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.URLHighlight Boolean N/A

true to highlight URLs; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PDF.Linearized Boolean N/A

true to create a linearized (optimized for the web) PDF output; otherwise, false. The default value is false.

End:SaveDocument.DocumentFormat.PDF EndCategory N/A End of the PDF Image On Text Output Format Options category category
SaveDocument.DocumentFormat.PdfText BeginCategory N/A Beginning of the PDF Text Output Format Options category
SaveDocument.DocumentFormat.PdfText.AdditionalFonts Boolean N/A

true to enable the use of additional fonts; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.AppendFrom String Maximum of 1024 characters. Can be null value String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PdfText.AppendFromPassword String Maximum of 1024 characters. Can be null value String containing the password to enable the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PdfText.ColorQuality Enum Minimum, Good, Lossless

Specifies the color quality for the output PDF file. The default value is Minimum.

Possible values are:

Value Description
(0) Minimum Minimum size (highest compression)
(1) Good Good quality
(2) Lossless Lossless compression
SaveDocument.DocumentFormat.PdfText.Compatibility Enum

Specifies which version of PDF to use for compatibility. The default value is PDF1.6.

Possible values are:

Value Description
(0) ForceSize Automatically use PDF mode that has the smallest output size
(1) ForceQuality Automatically use PDF mode that has the highest quality
(2) PDF 1.5 PDF 1.5
(3) PDF1.4 PDF 1.4
(4) PDF1.3 PDF 1.3
(5) PDF1.2 PDF 1.2
(6) PDF1.1 PDF 1.1
(7) PDF1.0 PDF 1.0
(8) PDF-A PDF/A
(9) PDF1.6 PDF 1.6
SaveDocument.DocumentFormat.PdfText.CompForContents Boolean N/A

true to enable compression of text and line art; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.CompForTTF Boolean N/A

true to enable embedded files to be compressed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.UseFlate Boolean N/A

true to enable Flate compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.UseJBIG2 Boolean N/A

true to enable JBIG2 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.UseJPEG2000 Boolean N/A

true to enable JPEG2000 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.UseLZWInsteadOfFlate Boolean N/A

true to enable the use of LZW instead of Flate compression; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfText.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.Outline Boolean N/A

true to use bookmarks for the pages; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.OutlineNumbering Boolean N/A

true to add page numbers to the page name; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.OutlinePageName String Maximum of 1024 characters. Can be null value String containing the page name of the bookmark. The default value is "Page".
SaveDocument.DocumentFormat.PdfText.PDFFormVisuality Boolean N/A

true to display the visual components of the form; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.EnableAdd Boolean N/A

true if comments and form fields can be changed or edited; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.EnableAssemble Boolean N/A

true if documents can be assembled; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.EnableCopy Boolean N/A

true if material can be copied or extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.EnableExtract Boolean N/A

true if material can be extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.EnableForms Boolean N/A

true if forms can be filled out; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.EnableModify Boolean N/A

true if documents can be modified; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.EnablePrint Boolean N/A

true if output PDF files can be printed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText PDF.EnablePrintQ Boolean N/A

true if high quality printing can be performed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.OwnerPassword String Maximum of 1024 characters and can be a null value String containing the owner password. The default value is null.
SaveDocument.DocumentFormat.PdfText.PDFSecurity Enum

Specifies the PDF security type. The default value is None.

Possible values are:

Value Description
(0) None No security
(1) 40Bits Use 40-bit compression
(2) 128Bits Use 128-bit compression
SaveDocument.DocumentFormat.PdfText PDF.UserPassword String Maximum of 1024 characters. Can be null value String containing the user password. The default value is null.
SaveDocument.DocumentFormat.PDF.PictureColor Enum

The PDF color depth. The default value is Original.

Possible values are:

Value Description
(0) Original Original image bit depth
(1) BlackAndWhite Black and white
(2) Grayscale Grayscale
(3) 24BPP Colored 24 Bits/pixel
SaveDocument.DocumentFormat.PdfText.CertificateDescription String Maximum of 1024 characters. Can be null value String containing the certificate description. The default value is null.
SaveDocument.DocumentFormat.PdfText.CertificateSHA1 String Maximum of 1024 characters. Can be null value String containing the certificate SHA1 thumbprint. The default value is null.
SaveDocument.DocumentFormat.PdfText.SignatureType Enum

The PDF signature type. The default value is None.

Possible values are:

Value Description
(0) None Not signed
(1) Pklite PKlite Signature
(2) Verisign Verisign Signature
SaveDocument.DocumentFormat.PdfText.URLBackground Integer 0 to Int32.MaxValue The color for the URL background in BBGGRR format. The default value is 0xFFFFFF (white).
SaveDocument.DocumentFormat.PdfText.URLForeground Integer 0 to Int32.MaxValue The color for the URL foreground in BBGGRR format. The default value is FF0000 (blue).
SaveDocument.DocumentFormat.PdfText.URLForegroundDef Boolean N/A

true to use the default foreground color for the URL; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfText.URLUnderline Boolean N/A

true to underline URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.UseMRC Enum

The PDF MRC (Mixed Raster Content) compression type for the output PDF file. The default value is No.

Possible values are:

The PDF MRC type for the output PDF file
Value Description
(0) No Do not use MRC
(1) Minimum Minimum output PDF size (highest compression)
(2) Good Good quality output PDF size (moderate compression)
(3) Lossless Lossless compression (highest quality)
SaveDocument.DocumentFormat.PdfText.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Auto.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.PdfText.NeedTaggedInfo Boolean N/A

true to create a tagged PDF file; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.PDFThumbnail Boolean N/A

true to create thumbnails; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfText.Pictures Enum

Specifies the pictures DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.PdfText.PDFForms Boolean N/A

true to display the form layer; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.ShowBackgroundImage Boolean N/A

true to display the background image layer; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfText.ShowText Boolean N/A

true to display the text; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.ShowSubstitutes Boolean N/A

true to cover suspect words with small images; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfText.URLBackgroundDef Boolean N/A

true to display the default background color for any URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.URLHighlight Boolean N/A

true to highlight URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfText.Linearized Boolean N/A

true to create a linearized (optimized for the web) PDF output; otherwise, false. The default value is false.

End:SaveDocument.DocumentFormat.PdfText EndCategory N/A Beginning of the PDF Text Output Format Options category
SaveDocument.DocumentFormat.PdfEdited BeginCategory N/A Beginning of the PDF Edited Output Format Options category
SaveDocument.DocumentFormat.PdfEdited.AdditionalFonts Boolean N/A

true to enable the use of additional fonts; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.AppendFrom String Maximum of 1024 characters. Can be null value String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PdfEdited.AppendFromPassword String Maximum of 1024 characters. Can be null value String containing the password to enable the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PdfEdited.ColorQuality Enum

Specifies the color quality for the output PDF file. The default value is Minimum.

Possible values are:

Value Description
(0) Minimum Minimum size (highest compression)
(1) Good Good quality
(2) Lossless Lossless compression
SaveDocument.DocumentFormat.PdfEdited.Compatibility Enum

Specifies which version of PDF to use for compatibility. The default value is PDF1.6.

Possible values are:

Value Description
(0) ForceSize Automatically use PDF mode that has the smallest output size
(1) ForceQuality Automatically use PDF mode that has the highest quality
(2) PDF 1.5 PDF 1.5
(3) PDF1.4 PDF 1.4
(4) PDF1.3 PDF 1.3
(5) PDF1.2 PDF 1.2
(6) PDF1.1 PDF 1.1
(7) PDF1.0 PDF 1.0
(8) PDF-A PDF/A
(9) PDF1.6 PDF 1.6
SaveDocument.DocumentFormat.PdfEdited.CompForContents Boolean N/A

Enables or disables compression of Text and Line Art.

true to enable compression of text and line art; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.CompForTTF Boolean N/A

true to enable embedded files to be compressed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.UseFlate Boolean N/A

true to enable Flate compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.UseJBIG2 Boolean N/A

true to enable JBIG2 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.UseJPEG2000 Boolean N/A

true to enable JPEG2000 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.UseLZWInsteadOfFlate Boolean N/A

true to enable the use of LZW instead of Flate compression; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfEdited.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.Outline Boolean N/A

true to use bookmarks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.OutlineNumbering Boolean N/A

true to add page numbers; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.OutlinePageName String Maximum of 1024 characters. Can be null value String containing the page name of the bookmark. The default value is "Page".
SaveDocument.DocumentFormat.PdfEdited.PDFFormVisuality Boolean N/A

true to display the visual components; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.EnableAdd Boolean N/A

true if comments and form fields can be changed or edited; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.EnableAssemble Boolean N/A

true if documents can be assembled; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.EnableCopy Boolean N/A

true if material can be copied or extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.EnableExtract Boolean N/A

true if material can be extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.EnableForms Boolean N/A

true if forms can be filled out; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.EnableModify Boolean N/A

true if documents can be modified; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.EnablePrint Boolean N/A

true if output PDF files can be printed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited PDF.EnablePrintQ Boolean N/A

true if high quality printing can be performed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.OwnerPassword String Maximum of 1024 characters. Can be null value String containing the owner password. The default value is null.
SaveDocument.DocumentFormat.PdfEdited.PDFSecurity Enum

Specifies the PDF security type. The default value is None.

Possible values are:

Value Description
(0) None No security
(1) 40Bits Use 40-bit compression
(2) 128Bits Use 128-bit compression
SaveDocument.DocumentFormat.PdfEdited PDF.UserPassword String Maximum of 1024 characters. Can be null value String containing the user password. The default value is null.
SaveDocument.DocumentFormat.PDF.PictureColor Enum

The PDF color depth. The default value is Original.

Possible values are:

Value Description
(0) Original Original image bit depth
(1) BlackAndWhite Black and white
(2) Grayscale Grayscale
(3) 24BPP Colored 24 Bits/pixel
SaveDocument.DocumentFormat.PdfEdited.CertificateDescription String Maximum of 1024 characters. Can be null value String containing the certificate description. The default value is null.
SaveDocument.DocumentFormat.PdfEdited.CertificateSHA1 String Maximum of 1024 characters. Can be null value String containing the certificate SHA1 thumbprint. The default value is null.
SaveDocument.DocumentFormat.PdfEdited.SignatureType Enum

The PDF signature type. The default value is None.

Possible values are:

Value Description
(0) None Not signed
(1) Pklite PKlite Signature
(2) Verisign Verisign Signature
SaveDocument.DocumentFormat.PdfEdited.URLForeground Integer 0 to Int32.MaxValue The color for the URL foreground in BBGGRR format. The default value is FF0000 (blue).
SaveDocument.DocumentFormat.PdfEdited.URLBackground Integer 0 to Int32.MaxValue The color for the URL background in BBGGRR format. The default value is 0xFFFFFF (white).
SaveDocument.DocumentFormat.PdfEdited.URLForegroundDef Boolean N/A

true to use the default foreground color for the URL; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfEdited.URLUnderline Boolean N/A

true to underline URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.UseMRC Enum

The PDF MRC (Mixed Raster Content) compression type for the output PDF file. The default value is No.

Possible values are:

The PDF MRC type for the output PDF file
Value Description
(0) No Do not use MRC
(1) Minimum Minimum output PDF size (highest compression)
(2) Good Good quality output PDF size (moderate compression)
(3) Lossless Lossless compression (highest quality)
SaveDocument.DocumentFormat.PdfEdited.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.PdfEdited.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.FieldCodes Boolean N/A

true to retain field codes; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Auto.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.PdfEdited.NeedTaggedInfo Boolean N/A

true to create a tagged PDF file; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.PDFForms Boolean N/A

true to display the form layer; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.Pictures Enum

Specifies the pictures DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.PdfEdited.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.URLBackgroundDef Boolean N/A

true to display the default background color for any URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEdited.URLHighlight Boolean N/A

true to highlight URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfEditeds.Linearized Boolean N/A

true to create a linearized (optimized for the web) PDF output; otherwise, false. The default value is false.

End:SaveDocument.DocumentFormat.PdfEdited EndCategory N/A End of the PDF Edited Output Format Options category
SaveDocument.DocumentFormat.PdfWithImageSubstitutes BeginCategory N/A Beginning of the PDF With Image Substitutes Output Format Options category
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.AdditionalFonts Boolean N/A

true to enable the use of additional fonts; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.AppendFrom String Maximum of 1024 characters. Can be a null value. String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.AppendFromPassword String Maximum of 1024 characters. Can be null value String containing the password to enable the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.ColorQuality Enum

Specifies the color quality for the output PDF file. The default value is Minimum.

Possible values are:

Value Description
(0) Minimum Minimum size (highest compression)
(1) Good Good quality
(2) Lossless Lossless compression
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.Compatibility Enum

Specifies which version of PDF to use for compatibility. The default value is PDF1.6.

Possible values are:

Value Description
(0) ForceSize Automatically use PDF mode that has the smallest output size
(1) ForceQuality Automatically use PDF mode that has the highest quality
(2) PDF 1.5 PDF 1.5
(3) PDF1.4 PDF 1.4
(4) PDF1.3 PDF 1.3
(5) PDF1.2 PDF 1.2
(6) PDF1.1 PDF 1.1
(7) PDF1.0 PDF 1.0
(8) PDF-A PDF/A
(9) PDF1.6 PDF 1.6
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.CompForContents Boolean N/A

true to enable compression of text and line art; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.CompForTTF Boolean N/A

true to enable embedded files to be compressed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.UseFlate Boolean N/A

true to enable Flate compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.UseJBIG2 Boolean N/A

true to enable JBIG2 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.UseJPEG2000 Boolean N/A

true to enable JPEG2000 compression; otherwise, false. The default value is true.

SaveDocument.DocumentFormat..PdfWithImageSubstitutes.UseLZWInsteadOfFlate Boolean N/A

true to enable the use of LZW instead of Flate compression; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.Outline Boolean N/A

true to use bookmarks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.OutlineNumbering Boolean N/A

true to add page numbers; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.OutlinePageName String Maximum of 1024 characters. Can be null value String containing the page name of the bookmark. The default value is "Page".
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.PDFFormVisuality Boolean N/A

true to display the visual components; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.EnableAdd Boolean N/A

true if comments and form fields can be changed or edited; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.EnableAssemble Boolean N/A

true if documents can be assembled; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.EnableCopy Boolean N/A

true if material can be copied or extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.EnableExtract Boolean N/A

true if material can be extracted; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.EnableForms Boolean N/A

true if forms can be filled out; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.EnableModify Boolean N/A

true if documents can be modified; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.EnablePrint Boolean N/A

true if output PDF files can be printed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes PDF.EnablePrintQ Boolean N/A

true if high quality printing can be performed; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.OwnerPassword String Maximum of 1024 characters. Can be null value String containing the owner password. The default value is null.
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.PDFSecurity Enum

Specifies the PDF security type. The default value is None.

Possible values are:

Value Description
(0) None No security
(1) 40Bits Use 40-bit compression
(2) 128Bits Use 128-bit compression
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.UserPassword String Maximum of 1024 characters. Can be null value String containing the user password. The default value is null.
SaveDocument.DocumentFormat.PDF.PictureColor Enum

The PDF color depth. The default value is Original.

Possible values are:

Value Description
(0) Original Original image bit depth
(1) BlackAndWhite Black and white
(2) Grayscale Grayscale
(3) 24BPP Colored 24 Bits/pixel
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.CertificateDescription String Maximum of 1024 characters. Can be null value String containing the certificate description. The default value is null.
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.CertificateSHA1 String Maximum of 1024 characters. Can be null value String containing the certificate SHA1 thumbprint. The default value is null.
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.SignatureType Enum

The PDF signature type. The default value is None.

Possible values are:

Value Description
(0) None Not signed
(1) Pklite PKlite Signature
(2) Verisign Verisign Signature
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.URLForeground Integer 0 to Int32.MaxValue The color for the URL foreground in BBGGRR format. The default value is FF0000 (blue).
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.URLBackground Integer 0 to Int32.MaxValue The color for the URL background in BBGGRR format. The default value is 0xFFFFFF (white).
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.URLForegroundDef Boolean N/A

true to use the default foreground color for the URL; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.URLUnderline Boolean N/A

true to underline URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.UseMRC Enum

The PDF MRC (Mixed Raster Content) compression type for the output PDF file. The default value is No.

Possible values are:

The PDF MRC type for the output PDF file
Value Description
(0) No Do not use MRC
(1) Minimum Minimum output PDF size (highest compression)
(2) Good Good quality output PDF size (moderate compression)
(3) Lossless Lossless compression (highest quality)
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Auto.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.NeedTaggedInfo Boolean N/A

true to create a tagged PDF file; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.PDFThumbnail Boolean N/A

true to create thumbnails; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.Pictures Enum

Specifies the DPI setting used for pictures. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.PdfWithImageSubstitutes.PDFForms Boolean N/A

true to display the form layer; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.ShowBackgroundImage Boolean N/A

true to display the background image layer; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.ShowText Boolean N/A

true to display the text; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.URLBackgroundDef Boolean N/A

true to display the default background color for any URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.URLHighlight Boolean N/A

true to highlight URLs; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.PdfWithImageSubstitutes.Linearized Boolean N/A

true to create a linearized (optimized for the web) PDF output; otherwise, false. The default value is false.

End:SaveDocument.DocumentFormat.PdfWithImageSubstitutes EndCategory N/A End of the PDF With Image Substitutes Output Format Options category category
SaveDocument.DocumentFormat.Rtf BeginCategory N/A Beginning of the RTF Output Format Options category
SaveDocument.DocumentFormat.Rtf.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.Rtf.CharColors Boolean N/A

true to keep the font colors of characters; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.CharScaling Boolean N/A

true to keep character scaling; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.CharSpacing Boolean N/A

true to keep character spacing; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.ColumnBreaks Boolean N/A

true to keep column breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Rtf.ConsolidatePages Boolean N/A

true to consolidate pages; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.DocAuthor String Maximum of 1024 characters. Can be null value String containing the author of the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DocCategory String Maximum of 1024 characters. Can be null value String containing the category of the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DocComments String Maximum of 1024 characters. Can be null value String containing the comments for the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DocCompany String Maximum of 1024 characters. Can be null value String containing the company name of the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DocKeywords String Maximum of 1024 characters. Can be null value String containing the keywords for the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DocManager String Maximum of 1024 characters. Can be null value String containing the name of the manager of the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DocSubject String Maximum of 1024 characters. Can be null value String containing the subject of the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DocTitle String Maximum of 1024 characters. Can be null value String containing the title of the document. The default value is null.
SaveDocument.DocumentFormat.Rtf.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.FieldCodes Boolean N/A

true to retain field codes; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Auto.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.Rtf.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Rtf.OutputMode Enum

Specifies the levels of the format retention for the final output document. The default value is FlowingPage.

Possible values are:

Value Description
(0) Auto Automatic format level
(1) NoFormat All formatting information is ignored and replaced by default values.
(2) RetainFontAndParagraph Formatting information about fonts and paragraphs is retained, but layout-related information is ignored.
(3) TruePage Keeps the look of the original layout of the pages. This is done by absolute positioning of the texts, pictures and tables on the page with boxes, frames or other target application-specific methods.
(4) FlowingPage Preserves the original layout of the pages, including retaining columns. Boxes and frames are only used when necessary.
(5) SpreadSheet Exports the results in tabular form, suitable for use in spreadsheet applications. Each page is placed in a separate worksheet.
SaveDocument.DocumentFormat.Rtf.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.PageColor Boolean N/A

true to retain the page background color; otherwise, false to use the default color. The default value is true.

SaveDocument.DocumentFormat.Rtf.Pictures Enum

Specifies the pictures' DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.Rtf.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.Styles Boolean N/A

true to retain styles; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Rtf.Tables Enum

Specifies the table settings. The default value is Retain.

Possible values are:

Value Description
(0) None Do not use tables.
(1) Retain Retain original document settings.
(2) Tabbed Insert tabs in the pages.
(3) Spaces Use space characters.
SaveDocument.DocumentFormat.Rtf.Tabs Boolean N/A

true to retain the original tab positions; otherwise, false to use the defaults. The default value is true.

SaveDocument.DocumentFormat.Rtf.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat.Rtf EndCategory N/A End of the RTF Output Format Options category
SaveDocument.DocumentFormat.Word2000 BeginCategory N/A Beginning of the Word 2000 Output Format Options category
SaveDocument.DocumentFormat.Word2000.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.Word2000.CharColors Boolean N/A

true to keep the font colors of characters; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.CharScaling Boolean N/A

true to keep character scaling; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.CharSpacing Boolean N/A

true to keep character spacing; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.ColumnBreaks Boolean N/A

true to keep column breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Word2000.ConsolidatePages Boolean N/A

true to consolidate pages; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.DocAuthor String Maximum of 1024 characters. Can be null value String containing the author of the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DocCategory String Maximum of 1024 characters. Can be null value String containing the category of the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DocComments String Maximum of 1024 characters. Can be null value String containing the comments for the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DocCompany String Maximum of 1024 characters. Can be null value String containing the company name of the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DocKeywords String Maximum of 1024 characters. Can be null value String containing the keywords for the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DocManager String Maximum of 1024 characters. Can be null value String containing the name of the manager of the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DocSubject String Maximum of 1024 characters. Can be null value String containing the subject of the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DocTitle String Maximum of 1024 characters. Can be null value String containing the title of the document. The default value is null.
SaveDocument.DocumentFormat.Word2000.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.FieldCodes Boolean N/A

true to retain field codes; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Auto.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.Word2000.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Word2000.OutputMode Enum

Specifies the levels of the format retention for the final output document. The default value is FlowingPage.

Possible values are:

Value Description
(0) Auto Automatic format level
(1) NoFormat All formatting information is ignored and replaced by default values.
(2) RetainFontAndParagraph Formatting information about fonts and paragraphs is retained, but the layout related information is ignored.
(3) TruePage Keeps the look of the original layout of the pages. This is done by absolute positioning of the texts, pictures and tables on the page with boxes, frames or other target application specific methods.
(4) FlowingPage Preserves the original layout of the pages, including retaining columns. Boxes and frames are only used when necessary.
(5) SpreadSheet Exports the results in tabular form, suitable for use in spreadsheet applications. Each page is placed in a separate worksheet.
SaveDocument.DocumentFormat.Word2000.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.PageColor Boolean N/A

true to retain the page background color; otherwise, false to use the default color. The default value is true.

SaveDocument.DocumentFormat.Word2000.Pictures Enum

Specifies the pictures' DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.Word2000.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.Styles Boolean N/A

true to retain styles; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word2000.Tables Enum

Specifies the table settings. The default value is Retain.

Possible values are:

Value Description
(0) None Do not use tables.
(1) Retain Retain original document setting.
(2) Tabbed Insert tabs in the pages.
(3) Spaces Use space characters.
SaveDocument.DocumentFormat.Word2000.Tabs Boolean N/A

true to retain the original tab positions; otherwise, false to use the defaults. The default value is true.

SaveDocument.DocumentFormat.Word2000.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat.Word2000 EndCategory N/A End of the Word 2000 Output Format Options category
SaveDocument.DocumentFormat.Word97 BeginCategory N/A Beginning of the Word 97 Output Format Options category
SaveDocument.DocumentFormat.Word97.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.Word97.CharColors Boolean N/A

true to keep the font colors of characters; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.CharScaling Boolean N/A

true to keep character scaling; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.CharSpacing Boolean N/A

true to keep character spacing; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.ColumnBreaks Boolean N/A

true to keep column breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Word97.ConsolidatePages Boolean N/A

true to consolidate pages; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.DocAuthor String Maximum of 1024 characters. Can be null value String containing the author of the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DocCategory String Maximum of 1024 characters. Can be null value String containing the category of the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DocComments String Maximum of 1024 characters. Can be null value String containing the comments for the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DocCompany String Maximum of 1024 characters. Can be null value String containing the company name of the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DocKeywords String Maximum of 1024 characters. Can be null value String containing the keywords for the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DocManager String Maximum of 1024 characters. Can be null value String containing the name of the manager of the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DocSubject String Maximum of 1024 characters. Can be null value String containing the subject of the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DocTitle String Maximum of 1024 characters. Can be null value String containing the title of the document. The default value is null.
SaveDocument.DocumentFormat.Word97.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.FieldCodes Boolean N/A

true to retain field codes; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Auto.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.Word97.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.Word97.OutputMode Enum

Specifies the levels of the format retention for the final output document. The default value is FlowingPage.

Possible values are:

Value Description
(0) Auto Automatic format level
(1) NoFormat All formatting information is ignored and replaced by default values.
(2) RetainFontAndParagraph Formatting information about fonts and paragraphs is retained, but the layout related information is ignored.
(3) TruePage Keeps the look of the original layout of the pages. This is done by absolute positioning of the texts, pictures and tables on the page with boxes, frames or other target application specific methods.
(4) FlowingPage Preserves the original layout of the pages, including retaining columns. Boxes and frames are only used when necessary.
(5) SpreadSheet Exports the results in tabular form, suitable for use in spreadsheet applications. Each page is placed in a separate worksheet.
SaveDocument.DocumentFormat.Word97.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.PageColor Boolean N/A

true to retain the page background color; otherwise, false to use the default color. The default value is true.

SaveDocument.DocumentFormat.Word97.Pictures Enum

Specifies the pictures' DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.Word97.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.Styles Boolean N/A

true to retain styles; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.Word97.Tables Enum

Specifies the table settings. The default value is Retain.

Possible values are:

Value Description
(0) None Do not use tables.
(1) Retain Retain original document setting.
(2) Tabbed Insert tabs in the pages.
(3) Spaces Use space characters.
SaveDocument.DocumentFormat.Word97.Tabs Boolean N/A

true to retain the original tab positions; otherwise, false to use the defaults. The default value is true.

SaveDocument.DocumentFormat.Word97.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat.Word97 EndCategory N/A End of the Word 97 Output Format Options category
SaveDocument.DocumentFormat.WordML BeginCategory N/A Beginning of the WordML Output Format Options category
SaveDocument.DocumentFormat.WordML.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.WordML.CharColors Boolean N/A

true to keep the font colors of characters; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.CharScaling Boolean N/A

true to keep character scaling; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.CharSpacing Boolean N/A

true to keep character spacing; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.ColumnBreaks Boolean N/A

true to keep column breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.WordML.ConsolidatePages Boolean N/A

true to consolidate pages; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.DocAuthor String Maximum of 1024 characters. Can be null value String containing the author of the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DocCategory String Maximum of 1024 characters. Can be null value String containing the category of the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DocComments String Maximum of 1024 characters. Can be null value String containing the comments for the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DocCompany String Maximum of 1024 characters. Can be null value String containing the company name of the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DocKeywords String Maximum of 1024 characters. Can be null value String containing the keywords for the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DocManager String Maximum of 1024 characters. Can be null value String containing the name of the manager of the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DocSubject String Maximum of 1024 characters. Can be null value String containing the subject of the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DocTitle String Maximum of 1024 characters. Can be null value String containing the title of the document. The default value is null.
SaveDocument.DocumentFormat.WordML.DropCaps Boolean N/A

true to retain drop caps; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.FieldCodes Boolean N/A

true to retain field codes; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Auto.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.WordML.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.WordML.OutputMode Enum

Specifies the levels of the format retention for the final output document. The default value is FlowingPage.

Possible values are:

Value Description
(0) Auto Automatic format level
(1) NoFormat All formatting information is ignored and replaced by default values.
(2) RetainFontAndParagraph Formatting information about fonts and paragraphs is retained, but the layout related information is ignored.
(3) TruePage Keeps the look of the original layout of the pages. This is done by absolute positioning of the texts, pictures and tables on the page with boxes, frames or other target application specific methods.
(4) FlowingPage Preserves the original layout of the pages, including retaining columns. Boxes and frames are only used when necessary.
(5) SpreadSheet Exports the results in tabular form, suitable for use in spreadsheet applications. Each page is placed in a separate worksheet.
SaveDocument.DocumentFormat.WordML.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.PageColor Boolean N/A

true to retain the page background color; otherwise, false to use the default color. The default value is true.

SaveDocument.DocumentFormat.WordML.Pictures Enum

Specifies the pictures' DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.WordML.RuleLines Boolean N/A

true to insert line breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.Styles Boolean N/A

true to retain styles; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.WordML.Tables Enum

Specifies the table settings. The default value is Retain.

Possible values are:

Value Description
(0) None Do not use tables.
(1) Retain Retain original document setting.
(2) Tabbed Insert tabs in the pages.
(3) Spaces Use space characters.
SaveDocument.DocumentFormat.WordML.Tabs Boolean N/A

true to retain the original tab positions; otherwise, false to use the defaults. The default value is true.

SaveDocument.DocumentFormat.WordML.Crossrefs Boolean N/A

true to keep cross-references; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat.WordML EndCategory N/A End of the WordML Output Format Options category
SaveDocument.DocumentFormat.AsciiTextFormatted BeginCategory N/A Beginning of the ASCII Text Formatted Output Format Options category
SaveDocument.DocumentFormat.AsciiTextFormatted.Append Boolean N/A

true to append text; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.AsciiTextFormatted.AppendFrom String Maximum of 1024 characters. Can be null value String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.AsciiTextFormatted.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.AsciiTextFormatted.LineBreak String Maximum of 1024 characters. Can be null value String containing the characters to use when inserting Line breaks. The default value is "\r\n".
SaveDocument.DocumentFormat.AsciiTextFormatted.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.AsciiTextFormatted.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.AsciiTextFormatted.PageMargins Boolean N/A

true to retain page margins; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat.AsciiTextFormatted EndCategory N/A End of the Ascii Text Formatted Output Format Options category
SaveDocument.DocumentFormat.UnicodeTextFormatted BeginCategory N/A Beginning of the Unicode Text Formatted Output Format Options category
SaveDocument.DocumentFormat.UnicodeTextFormatted.Append Boolean N/A

true to append text; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.UnicodeTextFormatted.AppendFrom String Maximum of 1024 characters. Can be null value String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.UnicodeTextFormatted.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.UnicodeTextFormatted.IntelUnicodeByteOrder Boolean N/A

true to enable switching between big endian and little endian byte order; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.UnicodeTextFormatted.LineBreak String Maximum of 1024 characters. Can be null value String containing the characters to use when inserting Line breaks. The default value is "\r\n".
SaveDocument.DocumentFormat.UnicodeTextFormatted.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.UnicodeTextFormatted.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.UnicodeTextFormatted.PageMargins Boolean N/A

true to retain page margins; otherwise, false. The default value is true.

End:SaveDocument.DocumentFormat.UnicodeTextFormatted EndCategory N/A End of the Unicode Text Formatted Output Format Options category category
SaveDocument.DocumentFormat.AsciiText BeginCategory N/A Beginning of the ASCII Text Output Format Options category
SaveDocument.DocumentFormat.AsciiText.Append Boolean N/A

true to append text; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.AsciiText.AppendFrom String Maximum of 1024 characters. Can be null value String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.AsciiText.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.AsciiText.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.AsciiText.ConvertTabs Boolean N/A

true to convert tabs; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.AsciiText.LineBreak String Maximum of 1024 characters. Can be null value String containing the characters to use when inserting Line breaks. The default value is null.
SaveDocument.DocumentFormat.AsciiText.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.AsciiText.PageBreak String Maximum of 1024 characters. Can be null value String containing the characters that are used for page breaks. The default value is null.
SaveDocument.DocumentFormat.AsciiText.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is false.

End:SaveDocument.DocumentFormat.AsciiText EndCategory N/A End of the ASCII Text Output Format Options category
SaveDocument.DocumentFormat.UnicodeText BeginCategory N/A Beginning of the Unicode Text Output Format Options category category
SaveDocument.DocumentFormat.UnicodeText.Append Boolean N/A

true to append text; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.UnicodeText.AppendFrom String Maximum of 1024 characters. Can be null value String containing the output to be appended to this file. The default value is null.
SaveDocument.DocumentFormat.UnicodeText.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.UnicodeText.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.UnicodeText.ConvertTabs Boolean N/A

true to convert tabs; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.UnicodeText.IntelUnicodeByteOrder Boolean N/A

true to enable switching between big endian and little endian byte order; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.UnicodeText.LineBreak String Maximum of 1024 characters. Can be null value String containing the characters to use when inserting Line breaks. The default value is "\r\n".
SaveDocument.DocumentFormat.UnicodeText.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.UnicodeText.PageBreak String Maximum of 1024 characters. Can be null value String containing the characters that are used for page breaks. The default value is "\f\r\n"
SaveDocument.DocumentFormat.UnicodeText.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is false.

End:SaveDocument.DocumentFormat.UnicodeText EndCategory N/A End of the Unicode Text Output Format Options category
SaveDocument.DocumentFormat.RtfWordPad BeginCategory N/A Beginning of the RTF Word Pad Output Format Options category
SaveDocument.DocumentFormat.RtfWordPad.Bullets Boolean N/A true to display bullets; otherwise, false. The default value is true.
SaveDocument.DocumentFormat.RtfWordPad.CharColors Boolean N/A

true to keep the font colors of characters; otherwise, false. The default value is true.

SaveDocument.DocumentFormat.RtfWordPad.HeadersFooters Enum

Specifies the header and footer settings for the document. The default value is Convert.

Possible values are:

Value Description
(0) None Ignore headers and footers
(1) Auto Auto format
(2) Boxes In boxes
(3) TabbedBox Headers and footers placed in boxes
(4) Tabbed Headers and footers in tabbed plain text
(5) Convert Convert to ordinary text
SaveDocument.DocumentFormat.RtfWordPad.LineBreaks Boolean N/A

true to insert line breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.RtfWordPad.OutputMode Enum

Specifies the levels of the format retention for the final output document. The default value is RetainFontAndParagraph.

Possible values are:

Value Description
(0) Auto Automatic format level
(1) NoFormat All formatting information is ignored and replaced by default values.
(2) RetainFontAndParagraph Formatting information about fonts and paragraphs is retained, but the layout related information is ignored.
(3) TruePage Keeps the look of the original layout of the pages. This is done by absolute positioning of the texts, pictures and tables on the page with boxes, frames or other target application specific methods.
(4) FlowingPage Preserves the original layout of the pages, including retaining columns. Boxes and frames are only used when necessary.
(5) SpreadSheet Exports the results in tabular form, suitable for use in spreadsheet applications. Each page is placed in a separate worksheet.
SaveDocument.DocumentFormat.RtfWordPad.PageBreaks Boolean N/A

true to use page breaks; otherwise, false. The default value is false.

SaveDocument.DocumentFormat.RtfWordPad.Pictures Enum

Specifies the pictures' DPI setting. The default value is Original.

Possible values are:

Value Description
(0) None None
(1) Original Use original X/Y resolution
(2) 72 Both X and Y resolution are 72 DPI
(3) 100 Both X and Y resolution are 100 DPI
(4) 150 Both X and Y resolution are 150 DPI
(5) 200 Both X and Y resolution are 200 DPI
(6) 300 Both X and Y resolution are 300 DPI
SaveDocument.DocumentFormat.RtfWordPad.Tables Enum

Specifies the table settings. The default value is Retain.

Possible values are:

Value Description
(0) None Do not use tables.
(1) Retain Retain original document setting.
(2) Tabbed Insert tabs in the pages.
(3) Spaces Use space characters.
SaveDocument.DocumentFormat.RtfWordPad.Tabs Boolean N/A

true to retain the original tab positions; otherwise, false to use the defaults. The default value is true.

End:SaveDocument.DocumentFormat.RtfWordPad EndCategory N/A End of the RTF Word Pad Output Format Options category
End:SaveDocument.DocumentFormat EndCategory N/A End of the Document Format Save Options category
End:SaveDocument EndCategory N/A End of the Save Document Settings category

The following table lists all the output formats and shows which format levels are supported by each of them (related to SaveDocument.FormatLevel engine setting):

NoFormat RetainFontAndParagraph SpreadSheet TruePage FlowingPage
HTML 3.2 YES YES YES NO NO
HTML 4.0 YES YES NO YES NO
InfoPath NO NO NO YES NO
Microsoft Excel 97, 2000, 2007 YES YES YES NO NO
Microsoft Word 97, 2000, 2007, WordML YES YES NO YES YES
RTF Word 2000 YES YES NO YES YES
RTF for WordPad YES YES NO NO NO
Text YES NO NO NO NO
Text formatted NO NO NO YES NO
Unicode Text YES NO NO NO NO
Unicode Text formatted NO NO NO YES NO
Help Version 21.0.2021.11.1
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Imaging, Medical, and Document
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.