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 }
 
enum  BookmarkConversionMethod { e_bm_none = 0, e_bm_page, e_bm_extract }
 
enum  SearchableImageSetting { e_ocr_image_text = 0, e_ocr_image, e_ocr_text }
 

Public Member Functions

 WordOutputOptions ()
 
void SetJPGQuality (UInt32 quality)
 
void SetImageDPI (UInt32 dpi)
 
void SetWordOutputFormat (WordOutputFormat format)
 
void SetFileConversionTimeoutSeconds (int seconds)
 
void SetPages (int pageFrom, int pageTo)
 
void SetPDFPassword (const UString &password)
 
void SetBookmarkConversionMethod (BookmarkConversionMethod method)
 
void SetSearchableImageSetting (SearchableImageSetting setting)
 
void SetShrinkCharacterSpacingToPreventWrap (bool shrink)
 
void SetMatchPDFLineBreaks (bool match)
 
void SetConnectHyphens (bool connect)
 
void SetDoNotAdjustFonts (bool do_not_adjust)
 
void SetDisableVerticalSplit (bool disable)
 

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 1490 of file Convert.h.

Member Enumeration Documentation

Enumerator
e_bm_none 
e_bm_page 
e_bm_extract 

Definition at line 1547 of file Convert.h.

Enumerator
e_ocr_image_text 
e_ocr_image 
e_ocr_text 

Definition at line 1561 of file Convert.h.

Enumerator
e_wof_docx 
e_wof_doc 
e_wof_rtf 

Definition at line 1511 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::SetBookmarkConversionMethod ( BookmarkConversionMethod  method)

Specifies if and how PDF bookmarks should be converted into Word. Default is e_bm_none.

Parameters
methodthe bookmark conversion method.
See Also
BookmarkConversionMethod
void pdftron::PDF::WordOutputOptions::SetConnectHyphens ( bool  connect)

Specifies whether hyphens in the PDF should be connected. This only works with English words. Default is false.

Parameters
connectif true, hyphens in the PDF will be connected.
void pdftron::PDF::WordOutputOptions::SetDisableVerticalSplit ( bool  disable)

Specifies whether to disable the detection of section columns. Default is false. Enable this if your tables are coming out as section columns.

Parameters
disableif true, the detection of section columns are disabled.
void pdftron::PDF::WordOutputOptions::SetDoNotAdjustFonts ( bool  do_not_adjust)

Specifies whether to disable font adjustments during conversion. Default is false.

Parameters
do_not_adjustif true, font adjustments are disabled during conversion.
void pdftron::PDF::WordOutputOptions::SetFileConversionTimeoutSeconds ( int  seconds)

Specifies the amount of time in seconds after which the conversion fails. Default is 300. Very long files need more time to convert.

Parameters
secondsthe timeout in seconds.
void pdftron::PDF::WordOutputOptions::SetImageDPI ( UInt32  dpi)

Specifies the output image resolution, from 8 to 600, in Pixels Per Inch (PPI). The higher the PPI, the larger the image. Default 192.

Parameters
dpithe resolution in Pixels Per Inch.
void pdftron::PDF::WordOutputOptions::SetJPGQuality ( UInt32  quality)

Specifies the compression quality to use when generating JPEG images.

Parameters
qualitythe JPEG compression quality, from 0 (highest compression) to 100 (best quality). Default is 75.
void pdftron::PDF::WordOutputOptions::SetMatchPDFLineBreaks ( bool  match)

Specifies whether PDF line breaks should come out as line breaks in the Word output. This causes each line of text to become a separate paragraph. Default is false.

Parameters
matchif true, line breaks will come out as line breaks in the Word output.
void pdftron::PDF::WordOutputOptions::SetPages ( int  pageFrom,
int  pageTo 
)

Specifies a range of pages to be converted. By default all pages are converted. The first page has the page number of 1. Use a negative value to specify the last page in the PDF.

Parameters
pageFromthe first page to be converted.
pageTothe last page to be converted (inclusive).
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::SetSearchableImageSetting ( SearchableImageSetting  setting)

Specifies how image + hidden text pages should be converted. Default is e_ocr_image_text.

Note
This feature does not perform OCR.
Parameters
settingthe searchable image setting.
See Also
SearchableImageSetting
void pdftron::PDF::WordOutputOptions::SetShrinkCharacterSpacingToPreventWrap ( bool  shrink)

Specifies whether to shrink character spaces in order to prevent word wraps. Default is false.

Parameters
shrinkif true, character spaces are shrunk in order to prevent word wraps.
void pdftron::PDF::WordOutputOptions::SetWordOutputFormat ( WordOutputFormat  format)

Specifies the output document format (DOCX, DOC, RTF). It is the most useful when the output file extension is not .docx, .doc or .rtf.

Parameters
formatthe output document format (DOCX, DOC, RTF).
See Also
WordOutputFormat

Friends And Related Function Documentation

friend class Convert
friend

Definition at line 1610 of file Convert.h.

Member Data Documentation

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

Definition at line 1609 of file Convert.h.

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

Definition at line 1611 of file Convert.h.


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