The output converters are parts of RecAPIPlus and not supported on all platforms. See the below list about platform information. On not supported platforms or when using only the KernelAPI level, please use Direct TXT Output Converter Module instead of these converters.

The converters have many different settings. In the previous version of CSDK, you were able to use structures to set them. The current method is to modify these settings through Settings Manager Module. The name of the converter settings consists of four pieces: Converters.Text. CONVERTERNAME . SHORT_SETTINGNAME, where CONVERTERNAME is a dotless identifier, but the SHORT_SETTINGNAME can contain dots indicating additional layers of the setting tree (see Settings Manager Module).

IMPORTANT! The settings of a given converter are created when that converter is selected for the first time (RecSetOutputFormat). Thus before this these settings cannot be accessed.

In this page you can see the settings from two points of view.

First, you can see all the converters. From these links, you can navigate to detailed tables about which settings belong to the given converter. In the detailed tables you can see the full name, the type and the default value of the settings.

Preceding the detailed tables there is a summary of all the settings for every converter, in alphabetical order. The columns are: SHORT_SETTINGNAME, TYPE and DESCRIPTION. In this summary, the enum type settings are described in a distinct way: the row of each setting contains (in column order) the SHORT_SETTINGNAME, the word 'ENUM' and the name of the enum type. In addition, some rows below the setting contain all the possible values for this enum type with a brief description.

For example, let's see the 'Pictures' setting, which can be seen in the summary as follows:

Pictures	ENUM	R2_PICTURES_DPI
	R2_DPI_NONE	None
	R2_DPI_ORIGINAL	Original
	R2_DPI_72	DPI72
	R2_DPI_100	DPI100
	R2_DPI_150	DPI150
	R2_DPI_200	DPI200
	R2_DPI_300	DPI300

The name of the enum type is R2_PICTURES_DPI. You can see the possible values. You can find this setting in several converters: eBook, RTF and Doc converters, WordPad, WordPerfect converters, PDF converters, Microsoft Reader, PowerPoint97, Publisher98. Similarly to Pictures, a lot of settings can be found in more than one converter. In such a case, the same setting may have different default values in different converters, thus the same setting may appear in more that one of the detailed tables.

Settings of the converters

MP3 Audio converters supported on: Windows 32-bit
ePub converters supported on: Windows 32-bit
Kindle Document converter supported on: Windows
Excel 2000 and XLSX converters supported on: Windows, Linux, Embedded Linux, Mac OS X
HTML3.2 converter supported on: Windows, Linux, Embedded Linux, Mac OS X
HTML4.0 converter supported on: Windows, Linux, Embedded Linux, Mac OS X
PDF converters supported on: Windows
RTF and DOC converters supported on: Windows, Linux, Embedded Linux, Mac OS X
"Pages converter" supported on: Windows, Linux, Embedded Linux, Mac OS X
Text converters supported on: Windows, Linux, Embedded Linux, Mac OS X
PowerPoint converters supported on: Windows
Publisher98 converter supported on: Windows
WordPad converter supported on: Windows
WordPerfect10 converter supported on: Windows
XML converter supported on: Windows
XPS and Searchable XPS converters supported on: Windows
- XPS converter
- Searchable XPS converter

Summary of converter settings

The table below lists all the converter settings in alphabetical order of their short name.

SHORT_SETTINGNAME	TYPE	DESCRIPTION
AdditionalFonts	BOOL	Enable external fonts
Append	BOOL
AppendFrom	USTRING	Append the output to this file
AppendFromPassword	USTRING	Password for the original file
BeginCell	USTRING	String to be inserted into the output text signing the begin of a cell.
BeginParagraph	USTRING	String to be inserted into the output text signing the begin of a paragraph.
BeginTable	USTRING	String to be inserted into the output text signing the begin of a table.
BeginTableLine	USTRING	String to be inserted into the output text signing the begin of a table line.
Bullets	BOOL	Keep the bullets of the document or not.
CharColors	BOOL	Keep the colors of the characters or not.
CharScaling	BOOL	Keep character scaling or not.
CharSpacing	BOOL	Keep the character spacing or not.
CodePage	ENUM	This is not a real enum type, thus the below ID's can appear only in the setting files (see Setting Module) and in the result of kRecSettingGetSymbolic. With the function kRecSettingSetInt only the parenthesized numbers can be used.
	CP_NO (0)
	CP_UNICODE (1)	16 bit Multilingual
	CP_WORDPERFECT (2)	16 bit Multilingual
	CP_UTF8 (3)	16 bit Multilingual
	CP_437 (437)	United States IBM
	CP_708 (708)	Arabic (ASMO 708)
	CP_709 (709)	Arabic (ASMO 449+, BCON V4)
	CP_710 (710)	Arabic (transparent Arabic)
	CP_711 (711)	Arabic (Nafitha Enhanced)
	CP_720 (720)	Arabic (transparent ASMO)
	CP_819 (819)	Windows 3.1 (United States and Western Europe)
	CP_850 (850)	IBM multilingual
	CP_852 (852)	Eastern European
	CP_860 (860)	Portuguese
	CP_862 (862)	Hebrew
	CP_863 (863)	French Canadian
	CP_864 (864)	Arabic
	CP_865 (865)	Norwegian
	CP_866 (866)	Russian
	CP_932 (932)	Japanese
	CP_1250 (1250)	Windows 3.1 (Eastern European)
	CP_1251 (1251)	Windows 3.1 (Cyrillic)
	CP_1252 (1252)	Windows ANSI 1252
	CP_1253 (1253)	1253 Code Page
	CP_1254 (1254)	1254 Code Page
	CP_1257 (1257)	1257 Code Page
	CP_DEFAULT (5000)	means the code page set by kRecSetCodePage
	CP_ROMAN_8 (5001)	Roman 8, For HP printers
	CP_GREEK_ELOT (5002)	DOS Greek
	CP_GREEK_MEMOTEK (5003)	DOS Greek
	CP_MAC (5004)	MAC Western
	CP_MAC_INSO_LATIN_2 (5005)	Mac INSO Latin 2, MAC CE
	CP_MAC_CENTRAL_EU (5006)	Mac Central EU, PT 202
	CP_MAC_PRIMUS_CE (5007)	Mac Primus CEu, MAC CE
	CP_WIN_ESPERANT (5008)	Windows Esperant
	CP_HUN_CWI (5009)	CWI Magyar, DOS Hungarian
	CP_HUN_VENTURA (5010)	Magyar Ventura, DOS Hungarian
	CP_IVKAM_C_S (5011)	IVKAM C-S, Czech & Slovakian
	CP_MAZOWIA_POLISH (5012)	Mazowia Polish, DOS Polish
	CP_SLOVEN_CROAT (5013)	Sloven & Croat
	CP_TURKISH (5014)	Turkish
	CP_ICELANDIC (5015)	DOS Icelandic
	CP_MALTESE (5016)	DOS Maltese
	CP_WINDOWS_OCR_MICR (5017)	Windows OCR/MICR, Non Standard Windows 3.1
	CP_BIG5 (5018)	Traditional Chinese (supports ETen extension and HKscs non-standard mode)
	CP_EUC_CN (5019)	Simplified Chinese
	CP_EUC_JP (5020)	Japanese
	CP_TW (5021)	Traditional Chinese
	CP_GB18030 (5022)	Simplified Chinese
	CP_GBK (5023)	Simplified Chinese
	CP_HKSCS_2004 (5024)	Traditional Chinese (HKscs standard mode, supports ETen extension
	CP_SHIFT_JIS (5025)	Japanese
	CP_UHC (5026)	Korean (extended EUC-KR)
	CP_AUTO (5999)	Automatic Codepage by the LogDoc
ColorQuality	ENUM	TColorQValues
	R2ID_PDFCOLORQUALITY_MIN	min
	R2ID_PDFCOLORQUALITY_GOOD	good
	R2ID_PDFCOLORQUALITY_LOSLESS	lossless
ColumnBreaks	BOOL	Insert column breaks or not.
Compatibility	ENUM	This setting uses the value of the enum type TPDFCompatibTypeValues (the parenthesized values below), which can be used with kRecSettingSetInt. The symbolic values coming from kRecSettingGetSymbolic or residing in setting files are the strings preceding parentheses.
	Optimize for Size (`R2ID_FORCESIZE`)	Optimize for Size
	Optimize for Quality (`R2ID_FORCEQUALITY`)	Optimize for Quality
	PDF 2.0 (`R2ID_PDF20`)	PDF 2.0
	PDF 1.7 (`R2ID_PDF17`)	PDF 1.7
	PDF 1.6 (`R2ID_PDF16`)	PDF 1.6
	PDF 1.5 (`R2ID_PDF15`)	PDF 1.5
	PDF 1.4 (`R2ID_PDF14`)	PDF 1.4
	PDF 1.3 (`R2ID_PDF13`)	PDF 1.3
	PDF 1.2 (`R2ID_PDF12`)	PDF 1.2
	PDF 1.1 (`R2ID_PDF11`)	PDF 1.1
	PDF 1.0 (`R2ID_PDF10`)	PDF 1.0
	PDF-A (`R2ID_PDFA` or R2ID_PDFA1B)	PDF/A-1b compliant output (deprecated version of PDF/A-1b string-name is used because of backward compatibility!)
	PDF/A-2b (`R2ID_PDFA2B`)	PDF/A-2b compliant output
	PDF/A-3b (`R2ID_PDFA3B`)	PDF/A-3b compliant output
	PDF/A-2u (`R2ID_PDFA2U`)	PDF/A-2u compliant output
	PDF/A-3u (`R2ID_PDFA3U`)	PDF/A-3u compliant output
	PDF/A-1a (`R2ID_PDFA1A`)	PDF/A-1a compliant output
	PDF/A-2a (`R2ID_PDFA2A`)	PDF/A-2a compliant output
	PDF/A-3a (`R2ID_PDFA3A`)	PDF/A-3a compliant output
Compression.CompForContents	BOOL	Use compression for Text and Line Art
Compression.CompForTTF	BOOL	Use compression for Embedded Files
Compression.UseFlate	BOOL	If this is `TRUE`, CSDK uses Flate compression for content stream, otherwise it creates uncompressed stream.
Compression.UseJBIG2	BOOL	If this is `TRUE`, CSDK uses JBIG2 compression for B/W images, otherwise it uses TIFF G4. JBIG2 can be used in PDF v1.5 and higher.
Compression.UseJPEG2000	BOOL	If this is `TRUE`, CSDK uses JPEG2000 compression for color and grayscale images, otherwise it uses JPEG. JPEG2000 can be used in PDF v1.5 and higher.
Compression.UseLZWInsteadOfFlate	BOOL	If this is `TRUE` and `UseFlate` is `FALSE`, CSDK uses LZW compression for content stream. If `UseFlate` is `TRUE`, this setting has no effect.
ConsolidatePages	BOOL	Consolidate pages or not.
ConvertTabs	BOOL	Convert tabulators into spaces or not.
Crossrefs	BOOL	Retain crossreferences or not.
DocAuthor	USTRING	Author of the document.
DocCategory	USTRING	Category of the document.
DocComments	USTRING	Comments of the document.
DocCompany	USTRING	Company name of the document.
DocCreator	USTRING	Creator of the PDF document. If it's empty, Kernel.Imf.PDF.Creator is used.
DocKeywords	USTRING	Keywords of the document.
DocManager	USTRING	Manager name of the document.
DocProducer	USTRING	Producer of the PDF document. If it's empty, Kernel.Imf.PDF.Producer is used.
DocSubject	USTRING	Subject of the document.
DocTitle	USTRING	Title of the document.
DropCaps	BOOL	Retain dropcaps or not.
EnableMetaData	BOOL	Enable use/generation of XMP-metadata or not.
CustomMetaData	USTRING	String to be used as custom XMP-metadata - should be a self-contained XMP-subtree.
EnableBWImageAsMask	BOOL	Enable black-mask-only display-mode for BW-images (instead of displaying all pixels of the BW-image).
EndCell	USTRING	String to be inserted into the output text signing the end of a cell.
EndParagraph	USTRING	String to be inserted into the output text signing the end of a paragraph.
EndTable	USTRING	String to be inserted into the output text signing the end of a table.
EndTableLine	USTRING	String to be inserted into the output text signing the end of a table line.
FieldCodes	BOOL	Retain fieldcodes or not.
HeadersFooters	ENUM	R2_HEADERS_RETENTION
	R2_HR_NONE	Do not export headers and footers at all.
	R2_HR_AUTO	Automatically select the most suitable headers-footers format from the options below, based on the output format and formatting level.
	R2_HR_BOXES	Export the text of headers and footers into multiple boxes into the headers-footers area for precise positioning.
	R2_HR_TABBEDBOX	Export each header and footer into one box in the headers-footers area, aligning their parts with tabulators.
	R2_HR_TABBED	Export headers and footers as tabulator aligned text into the headers-footers area of the document.
	R2_HR_CONVERT	Convert headers and footers into normal (non-header) text. This can also result textboxes in some cases.
HRBetweenSections	BOOL	Put Horizontal Ruleline between Sections
IndexPage	ENUM	TWriteIndex
	HWI_NO	No index page is created.
	HWI_SMPLE	A simple HTML page is created with links to the pages.
	HWI_FRAME	A two-frame HTML page is created. The links of the one frame open each page in the other frame.
InsertCharacterCoordinates	BOOL	Insert Character coordinates or not.
IntelUnicodeByteOrder	BOOL	This switches between big-endian and little-endian.
Linearized	BOOL	If this setting is true, the generated PDF will be a linearized PDF.
LineBreak	USTRING	This unicode string setting is the end of line mark (Default Value: "\r\n")
LineBreaks	BOOL	Insert Linebreaks or not.
ListSeparator	USTRING	This separates the cells in the case of CSV.
NavNextText	STRING	If you switched on the Indexpage generating setting by Simple or InFrame, you can change the text of the Next navigation text.
NavPrevText	STRING	If you switched on the Indexpage generating setting by Simple or InFrame, you can change the text of the Prev navigation text.
NavTOCText	STRING	If you switched on the Indexpage generating setting by Simple or InFrame, you can change the text of the Index navigation text.
NeedTaggedInfo	BOOL	Create tagged PDF
OutlineProps.Outline	BOOL	Bookmarks for pages
OutlineProps.OutlineNumbering	BOOL	Add page numbers to the page name
OutlineProps.OutlinePageName	USTRING	Page name in bookmark
OutputMode	ENUM	This setting specifies the output level to be used by the given converter when the value of the setting `APIPlus.Output.OutputLevel` is OL_AUTO. The symbolic values (kRecSettingGetSymbolic) of this setting can be the followings: `IgnoreAll` for OL_NOFORMAT `RFP` for OL_RFP `TruePage` for OL_TRUEPAGE `FlowingPage` for OL_FLOWINGPAGE `Spreadsheet` for OL_SPREADSHEET See OUTPUTLEVEL See also RecSetOutputLevel function
OverviewSheetName	STRING	The name of the last sheet. In RFP mode every table will be in a separate sheet, and every other text and image will be on the last Overview Sheet.
PageBreak	USTRING	The string that separates the pages (Default Value: "\f")
PageBreaks	BOOL or ENUM	This specifies whether the converter inserts page breaks or not at the positions where the original document has. In fact, our RTF and DOC converters generally insert "Section Break (Next Page)" instead of page break. There are some converters, in which the type of this setting is BOOL, in other ones this is R2_PAGEBREAKS. See the detailed table of each converter below. Different output levels do not support all the possible values. OL_RFP: `R2_PB_NEVER`, `R2_PB_ALWAYS` OL_FLOWINGPAGE: `R2_PB_ALWAYS`, `R2_PB_AUTO` OL_TRUEPAGE: `R2_PB_ALWAYS` OL_NOFORMAT: `R2_PB_NEVER`
	R2_PB_NEVER	Never inserts page break.
	R2_PB_ALWAYS	Always inserts page break at the position where the original document has.
	R2_PB_AUTO	Decides according to the output format.
PageColor	BOOL	Retain page BACKGROUND color or use default.
PageMargins	BOOL	Retain page margins or use default.
PDFForms	BOOL	Show form layer
PDFFormVisuality	BOOL	Show form visual components
PDFSecurity.EnableAdd	BOOL	Enable change or edit comments and form fields
PDFSecurity.EnableAssemble	BOOL	Enable doc assemble
PDFSecurity.EnableCopy	BOOL	Enable copy & extract
PDFSecurity.EnableExtract	BOOL	Enable extract text and graphic
PDFSecurity.EnableForms	BOOL	Enable fill forms
PDFSecurity.EnableModify	BOOL	Enable changing the document
PDFSecurity.EnablePrint	BOOL	Enable printing
PDFSecurity.EnablePrintQ	BOOL	Enable high print quality
PDFSecurity.EncryptMetaData	BOOL	Encrypt meta-data
PDFSecurity.OwnerPassword	USTRING	Owner Password
PDFSecurity.Type	ENUM	TPDFSecurityValues
	R2ID_PDFSECURITYNONE	None
	R2ID_PDFSECURITY40BITS	40 bit RC4
	R2ID_PDFSECURITY128BITS	128 bit RC4
	R2ID_PDFSECURITYAES	128 bit AES
	R2ID_PDFSECURITYAES256	256 bit AES
PDFSecurity.UserPassword	USTRING	User Password
PDFThumbnail	BOOL	Create Thumbnail images
PictureColor	ENUM	R2_PICTURES_BPP
	R2_BPP_ORIGINAL	Original
	R2_BPP_BLACKANDWHITE	BlackAndWhite
	R2_BPP_GRAYSCALE	Grayscale
	R2_BPP_24BPP	BPP24
Pictures	ENUM	R2_PICTURES_DPI
	R2_DPI_NONE	None
	R2_DPI_ORIGINAL	Original
	R2_DPI_72	DPI72
	R2_DPI_100	DPI100
	R2_DPI_150	DPI150
	R2_DPI_200	DPI200
	R2_DPI_300	DPI300
ProcessingMode.PDFForms	BOOL	Show form layer
ProcessingMode.ShowBackgroundImage	BOOL	Show background image layer
ProcessingMode.ShowText	BOOL	Show text layer
PutItSubdirectory	BOOL	If it is true, put every file ( e.g. pages, pictures, css files) into a subdirectory
RetainLineNumberingZones	BOOL	In the case of legal document recognition, it specifies whether the line numbering zones are to be saved into the output document or not.
RuleLines	BOOL	Retain RuleLines or not.
SchemaLocation	USTRING	The URL of the schema that was written into the xml.
SheetNamePrefix	STRING	The sheet names are generated. SheetNamePrefix + 1,2,3,... E.g. SheetNamePrefix = 'page' Sheet names: Page1, Page2, ...
ShowSubstitutes	BOOL	Cover suspect words with small images
Signature.CertificateDescription	USTRING	Certificate Description
Signature.CertificateSHA1	STRING	Certificate SHA1 thumbprint
Signature.SignatureType	ENUM	TSignatureTypevalues
	R2ID_SIGTYPENONE	None
	R2ID_SIGTYPEPPKLITE	PPKLite
	R2ID_SIGTYPEVERISIGN	VeriSign
SplitMaxPages	INT	If this is not 0, the converter tries to generate output files containing at most the specified number of pages instead of one file. The name of the output files are generated from the User-specified filename using ordinal numbers. For some output types the real number of pages may be greater by 1 depending on the content of the file.
SplitMaxSize	INT	If this is not 0, the converter tries to generate output files having their size lower than the specified bytes instead of generating one file. The name of the output files are generated from the User-specified filename using ordinal numbers. In some cases the resulted sizes may be over the specified one depending on the content of the pages.
Styles	BOOL	Retain styles or not.
Tables	ENUM	R2_TABLES_RETENTION
	R2_TR_NONE	No Tables
	R2_TR_RETAIN	RetainTables
	R2_TR_TO_TABBED	ConvertToSeparatedByTabs
	R2_TR_TO_SPACES	ConvertToSeparatedBySpaces
Tabs	BOOL	Retain original tab positions or use defaults.
Title	USTRING	This is an arbitrary unicode string that can be used freely by Users. All the converters have such a setting. This setting is accessible without calling RecSetOutputFormat (see the note IMPORTANT! at the top of this topic).
URLProps.URLBackground	INT	You can set the Background color of the URL. See REC_COLOR
URLProps.URLBackgroundDef	BOOL	Use default background color for the URLs.
URLProps.URLForeground	INT	You can set the Foreground color of the URL. See REC_COLOR
URLProps.URLForegroundDef	BOOL	Use default foreground color for the URLs.
URLProps.URLHighlight	BOOL	Highlight URLs
URLProps.URLUnderline	BOOL	Underline URLs
UseMRC	ENUM	TMRCTypeValues
	R2ID_PDFMRC_NO	Do not use MRC
	R2ID_PDFMRC_MIN	MRC with minimal size and lowest quality
	R2ID_PDFMRC_GOOD	MRC with medium size and good quality
	R2ID_PDFMRC_LOSLESS	MRC with large size and best quality
UseOSListSeparator	BOOL	Use List Separator or not.
UseXsdSchema	BOOL	Use Xsd schema or not.
Voice name	STRING	The name of the selected voice.

NAME	TYPE	DEFAULT VALUE
Converters.Text.Audio*.BeginCell	USTRING
Converters.Text.Audio*.BeginParagraph	USTRING
Converters.Text.Audio*.BeginTable	USTRING
Converters.Text.Audio*.BeginTableLine	USTRING
Converters.Text.Audio*.Bullets	BOOL	TRUE
Converters.Text.Audio*.DocAuthor	USTRING
Converters.Text.Audio*.DocCategory	USTRING
Converters.Text.Audio*.DocComments	USTRING
Converters.Text.Audio*.DocCompany	USTRING
Converters.Text.Audio*.DocKeywords	USTRING
Converters.Text.Audio*.DocManager	USTRING
Converters.Text.Audio*.DocSubject	USTRING
Converters.Text.Audio*.DocTitle	USTRING
Converters.Text.Audio*.EndCell	USTRING
Converters.Text.Audio*.EndParagraph	USTRING
Converters.Text.Audio*.EndTable	USTRING
Converters.Text.Audio*.EndTableLine	USTRING
Converters.Text.Audio*.HeadersFooters	ENUM	IgnoreHeadersFooters
Converters.Text.Audio*.LineBreak	USTRING
Converters.Text.Audio*.LineBreaks	BOOL	FALSE
Converters.Text.Audio*.OutputMode	ENUM	IgnoreAll
Converters.Text.Audio*.PageBreak	USTRING
Converters.Text.Audio*.PageBreaks	BOOL	FALSE
Converters.Text.Audio*.PictureColor	ENUM	Original
Converters.Text.Audio*.Pictures	ENUM	None
Converters.Text.Audio*.RetainLineNumberingZones	BOOL	FALSE
Converters.Text.Audio*.Styles	BOOL	FALSE
Converters.Text.Audio*.Tables	ENUM	ConvertToSeparatedByTabs
Converters.Text.Audio*.Title	USTRING	Wav Audio
Converters.Text.Audio*.Voice name	ENUM

Settings of the converters

Summary of converter settings

MP3 Audio converters

ePub converters

Kindle Document converter

Excel 2000 and XLSX converters

HTML3.2 converter

HTML4.0 converter

PDF converters

PDF converter

PDF Edited converter

PDF Image On Text converter

PDF ImageSubst converter

PowerPoint converters

Publisher98 converter

RTF and DOC converters

"Pages converter"

Text converters

CSV Comma Delimited converter

Unicode CSV Text converter

Formatted Text converter

Unicode Formatted Text converter

Simple Text converter

Text With Linebreaks converter

Unicode Text converter

Unicode Text With Linebreaks converter

WordPad converter

WordPerfect10 converter

XML converter

XPS and Searchable XPS converters

XPS converter

Searchable XPS converter