All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::PDF::WordOutputOptions Class Reference

#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 SetConnectHyphens (bool connect)
 
void SetLanguage (OutputOptionsOCR::LanguageChoice language)
 
void SetPreferredOCREngine (OutputOptionsOCR::PreferredOCREngine engine)
 
void SetCustomOCRLanguage (const UString &ocrlang)
 
void SetPrioritizeVisualAppearance (bool replica)
 

Protected Attributes

TRN_Obj m_obj
 
SDF::ObjSet m_objset
 

Friends

class Convert
 

Detailed Description

A class containing options common to ToWord functions

Definition at line 1792 of file Convert.h.

Member Enumeration Documentation

Enumerator
e_ocr_image_text 
e_ocr_image 
e_ocr_text 
e_ocr_off 
e_ocr_always 

Definition at line 1830 of file Convert.h.

Enumerator
e_wof_docx 
e_wof_doc 
e_wof_rtf 
e_wof_txt 

Definition at line 1800 of file Convert.h.

Constructor & Destructor Documentation

pdftron::PDF::WordOutputOptions::WordOutputOptions ( )

Creates a WordOutputOptions object with default settings.

Member Function Documentation

void pdftron::PDF::WordOutputOptions::SetConnectHyphens ( bool  connect)

Specifies whether hyphens in the PDF should be connected. Default is false.

Parameters
connectif true, hyphens in the PDF will be connected.
void pdftron::PDF::WordOutputOptions::SetCustomOCRLanguage ( const UString ocrlang)

Specifies the custom OCR languages to use.

Note
Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.
Parameters
ocrlangthe OCR language(s).
void pdftron::PDF::WordOutputOptions::SetLanguage ( OutputOptionsOCR::LanguageChoice  language)

Specifies the OCR language. Default is automatic language detection.

Parameters
languagethe 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.

Parameters
page_fromthe first page to be converted.
page_tothe 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)

Specifies the password if the PDF requires one.

Parameters
passwordthe PDF password, if required; an empty string otherwise.
void pdftron::PDF::WordOutputOptions::SetPreferredOCREngine ( OutputOptionsOCR::PreferredOCREngine  engine)

Specifies preferred OCR engine.

Parameters
engineThe 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.

Parameters
replicaFalse 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.

Parameters
settingthe searchable image setting.
Remarks
Pre-existing OCRed content is ignored and a new OCR is performed from scratch.
See Also
SearchableImageSetting
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.

Parameters
formatthe output document format (DOCX, RTF, TXT).
Remarks
The DOC file format is now deprecated, DOCX is used automatically instead.
See Also
WordOutputFormat

Friends And Related Function Documentation

friend class Convert
friend

Definition at line 1880 of file Convert.h.

Member Data Documentation

TRN_Obj pdftron::PDF::WordOutputOptions::m_obj
protected

Definition at line 1879 of file Convert.h.

SDF::ObjSet pdftron::PDF::WordOutputOptions::m_objset
protected

Definition at line 1881 of file Convert.h.


The documentation for this class was generated from the following file: