|
#include <Convert.h>
Public Types | |
| enum | ContentReflowSetting { e_fixed_position = 0, e_reflow_paragraphs, e_reflow_full } |
| enum | SearchableImageSetting { e_ocr_image_text = 0, e_ocr_image, e_ocr_text, e_ocr_off, e_ocr_always } |
Protected Attributes | |
| TRN_Obj | m_obj |
| SDF::ObjSet | m_objset |
Friends | |
| class | Convert |
A class containing options common to ToHtml and ToEpub functions
| pdftron::PDF::HTMLOutputOptions::HTMLOutputOptions | ( | ) |
Creates an HTMLOutputCommonOptions object with default settings
| StructuredOutputOptions::SectionConversionSetting pdftron::PDF::HTMLOutputOptions::GetFootnotesSetting | ( | ) |
Get the setting for footnotes from this options object.
| StructuredOutputOptions::SectionConversionSetting pdftron::PDF::HTMLOutputOptions::GetHeadersAndFootersSetting | ( | ) |
Get the setting for headers and footers from this options object.
| void pdftron::PDF::HTMLOutputOptions::SetConnectHyphens | ( | bool | connect | ) |
| void pdftron::PDF::HTMLOutputOptions::SetContentReflowSetting | ( | ContentReflowSetting | reflow | ) |
Switch between fixed (pre-paginated) and reflowable HTML generation. Default is e_fixed_position. In e_reflow_paragraphs mode (now deprecated), conversions require that the optional PDFTron HTML reflow paragraphs add-on module is available. In e_reflow_full mode, conversions require that the optional PDFTron StructuredOutput add-on module is available.
| reflow | the generated HTML will be either fixed or reflowable. |
| void pdftron::PDF::HTMLOutputOptions::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.
| disable | if true, the detection of section columns are disabled. |
| void pdftron::PDF::HTMLOutputOptions::SetDPI | ( | UInt32 | dpi | ) |
The output resolution, from 1 to 1000, in Dots Per Inch (DPI) at which to render elements which cannot be directly converted. Default is 140.
| dpi | the resolution in Dots Per Inch |
| void pdftron::PDF::HTMLOutputOptions::SetEmbedImages | ( | bool | embed | ) |
Specifies whether images are embedded in the HTML without having to link to external files. Default is true.
| embed | if true, images are embedd in the HTML, otherwise, images are saved as external files. |
| void pdftron::PDF::HTMLOutputOptions::SetExternalLinks | ( | bool | enable | ) |
Enable the conversion of external URL navigation. Default is false.
| enable | if true, links that specify external URL's are converted into HTML. |
| void pdftron::PDF::HTMLOutputOptions::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.
| seconds | the timeout in seconds. |
| void pdftron::PDF::HTMLOutputOptions::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::HTMLOutputOptions::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::HTMLOutputOptions::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 is 192.
| dpi | the resolution in Pixels Per Inch. |
| void pdftron::PDF::HTMLOutputOptions::SetInternalLinks | ( | bool | enable | ) |
Enable the conversion of internal document navigation. Default is false.
| enable | if true, links that specify page jumps are converted into HTML. |
| void pdftron::PDF::HTMLOutputOptions::SetJPGQuality | ( | UInt32 | quality | ) |
Specifies the compression quality to use when generating JPEG images.
| quality | the JPEG compression quality, from 0 (highest compression) to 100 (best quality). |
| void pdftron::PDF::HTMLOutputOptions::SetLanguage | ( | OutputOptionsOCR::LanguageChoice | language | ) |
Specifies the OCR language. Default is automatic language detection.
| language | the OCR language. |
| void pdftron::PDF::HTMLOutputOptions::SetMaximumImagePixels | ( | UInt32 | max_pixels | ) |
Specifies the maximum image slice size in pixels. Default is 2000000.
| max_pixels | the maximum number of pixels an image can have |
| void pdftron::PDF::HTMLOutputOptions::SetNoPageWidth | ( | bool | enable | ) |
Determines whether to flow contents across the entire browser window. Default is false.
| enable | if true, content will flow across entire page. |
| void pdftron::PDF::HTMLOutputOptions::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::HTMLOutputOptions::SetPDFPassword | ( | const UString & | password | ) |
| void pdftron::PDF::HTMLOutputOptions::SetPreferJPG | ( | bool | prefer_jpg | ) |
Use JPG files rather than PNG. This will apply to all generated images. Default is true.
| prefer_jpg | if true JPG images will be used whenever possible. |
| void pdftron::PDF::HTMLOutputOptions::SetPreferredOCREngine | ( | OutputOptionsOCR::PreferredOCREngine | engine | ) |
Specifies preferred OCR engine.
| engine | The PreferredOCREngine to OCR. |
| void pdftron::PDF::HTMLOutputOptions::SetReportFile | ( | const UString & | path | ) |
Generate a XML file that contains additional information about the conversion process. By default no report is generated.
| path | the file path to which the XML report is written to. |
| void pdftron::PDF::HTMLOutputOptions::SetScale | ( | double | scale | ) |
Set an overall scaling of the generated HTML pages. Default is 1.0.
| scale | A number greater than 0 which is used as a scale factor. For example, calling SetScale(0.5) will reduce the HTML body of the page to half its original size, whereas SetScale(2) will double the HTML body dimensions of the page and will rescale all page content appropriately. |
| void pdftron::PDF::HTMLOutputOptions::SetSearchableImageSetting | ( | SearchableImageSetting | setting | ) |
Specifies how scanned image pages should be converted. Default is e_ocr_image_text.
| setting | the searchable image setting. |
| void pdftron::PDF::HTMLOutputOptions::SetSimpleLists | ( | bool | enable | ) |
Determines whether to use tags for list items. Default is false.
| enable | if true, tags are used for list items. |
| void pdftron::PDF::HTMLOutputOptions::SetSimplifyText | ( | bool | enable | ) |
Controls whether converter optimizes DOM or preserves text placement accuracy. Default is false.
| enable | if true, converter will try to reduce DOM complexity at the expense of text placement accuracy. |
| void pdftron::PDF::HTMLOutputOptions::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::HTMLOutputOptions::SetTitle | ( | const UString & | title | ) |
Specifies the title for the output HTML.
| title | the title of the output HTML. |
|
protected |
