|
#include <Convert.h>
Public Types | |
| enum | WordOutputFormat { e_wof_docx = 0, e_wof_doc, e_wof_rtf, e_wof_txt } |
| enum | SearchableImageSetting { e_ocr_image_text = 0, e_ocr_image, e_ocr_text, e_ocr_off, e_ocr_always } |
Public Member Functions | |
| WordOutputOptions () | |
| void | SetWordOutputFormat (WordOutputFormat format) |
| void | SetPages (int page_from, int page_to) |
| void | SetPDFPassword (const UString &password) |
| void | SetSearchableImageSetting (SearchableImageSetting setting) |
| void | SetTextRecoveryNSE (bool use_ocr) |
| void | SetDetectTOC (bool detect_toc) |
| void | SetConnectHyphens (bool connect) |
| void | SetLanguage (OutputOptionsOCR::LanguageChoice language) |
| void | SetPreferredOCREngine (OutputOptionsOCR::PreferredOCREngine engine) |
| void | SetCustomOCRLanguage (const UString &ocrlang) |
| void | SetPrioritizeVisualAppearance (bool replica) |
| void | SetHeadersAndFootersSetting (StructuredOutputOptions::SectionConversionSetting option) |
| void | SetFootnotesSetting (StructuredOutputOptions::SectionConversionSetting option) |
| StructuredOutputOptions::SectionConversionSetting | GetHeadersAndFootersSetting () |
| StructuredOutputOptions::SectionConversionSetting | GetFootnotesSetting () |
Protected Attributes | |
| TRN_Obj | m_obj |
| SDF::ObjSet | m_objset |
Friends | |
| class | Convert |
| pdftron::PDF::WordOutputOptions::WordOutputOptions | ( | ) |
Creates a WordOutputOptions object with default settings.
| StructuredOutputOptions::SectionConversionSetting pdftron::PDF::WordOutputOptions::GetFootnotesSetting | ( | ) |
Get the setting for footnotes from this options object.
| StructuredOutputOptions::SectionConversionSetting pdftron::PDF::WordOutputOptions::GetHeadersAndFootersSetting | ( | ) |
Get the setting for headers and footers from this options object.
| void pdftron::PDF::WordOutputOptions::SetConnectHyphens | ( | bool | connect | ) |
| void pdftron::PDF::WordOutputOptions::SetCustomOCRLanguage | ( | const UString & | ocrlang | ) |
Specifies the custom OCR languages to use.
| ocrlang | the OCR language(s). |
| void pdftron::PDF::WordOutputOptions::SetDetectTOC | ( | bool | detect_toc | ) |
Specifies whether Table of Contents should be detected from the document content when converting to Word. Default is true.
| detect_toc | If true, Table of Contents is automatically detected. If false, no Table of Contents detection is performed. |
| void pdftron::PDF::WordOutputOptions::SetFootnotesSetting | ( | StructuredOutputOptions::SectionConversionSetting | option | ) |
Specifies how footnotes should be converted. Default is e_Recover, which will include them as footnotes.
| option | The footnote setting. |
| void pdftron::PDF::WordOutputOptions::SetHeadersAndFootersSetting | ( | StructuredOutputOptions::SectionConversionSetting | option | ) |
Specifies how header and footers should be converted. Default is e_Recover, which will include them as headers and footers.
| option | The header and footer setting. |
| void pdftron::PDF::WordOutputOptions::SetLanguage | ( | OutputOptionsOCR::LanguageChoice | language | ) |
Specifies the OCR language. Default is automatic language detection.
| language | the OCR language. |
| void pdftron::PDF::WordOutputOptions::SetPages | ( | int | page_from, |
| int | page_to | ||
| ) |
Specifies a range of pages to be converted. By default all pages are converted. The first page has the page number of 1.
| page_from | the first page to be converted. |
| page_to | the last page to be converted (inclusive). Use a negative value to specify the last page in the PDF. |
| void pdftron::PDF::WordOutputOptions::SetPDFPassword | ( | const UString & | password | ) |
| void pdftron::PDF::WordOutputOptions::SetPreferredOCREngine | ( | OutputOptionsOCR::PreferredOCREngine | engine | ) |
Specifies preferred OCR engine.
| engine | The PreferredOCREngine to OCR. |
| void pdftron::PDF::WordOutputOptions::SetPrioritizeVisualAppearance | ( | bool | replica | ) |
Specifies whether to prefer an exact visual replica of the PDF at the expense of preventing reflow of document paragraphs. Default is false.
| replica | False is preferred for most documents that contain paragraphs. Consider using true for documents that don't flow, such as CAD drawings, Illustrator-generated files. |
| void pdftron::PDF::WordOutputOptions::SetSearchableImageSetting | ( | SearchableImageSetting | setting | ) |
Specifies how scanned image pages should be converted. Default is e_ocr_text.
| setting | the searchable image setting. |
| void pdftron::PDF::WordOutputOptions::SetTextRecoveryNSE | ( | bool | use_ocr | ) |
Specifies whether to use OCR in order to automatically recover text with a non-standard encoding. Default is true.
| use_ocr | If true, problem characters are automatically recovered using OCR. If false, no automatic repair is performed. |
| void pdftron::PDF::WordOutputOptions::SetWordOutputFormat | ( | WordOutputFormat | format | ) |
Specifies the output document format (DOCX, RTF, TXT). It is the most useful when the output file extension is not .docx, .rtf or .txt.
| format | the output document format (DOCX, RTF, TXT). |
|
protected |
