ComPDF Objective-C SDK
API Reference Documentation for ComPDF Objective-C SDK
Loading...
Searching...
No Matches
ConvertOptions Class Reference

Convert options. More...

#include <base_type.h>

Inheritance diagram for ConvertOptions:

Properties

BOOL enableAILayout
 Whether to remove AI content during conversion.
BOOL containImage
 Whether to include images (only effective when OCR is disabled)
BOOL contain_page_background_image
 Whether to contain page background images when converting,which takes effect only when enable_ocr is true.
BOOL jsonContainTable
 Whether to include tables when converting to JSON.
BOOL containAnnotation
 Whether to include annotations.
BOOL excelAllContent
 Whether to export all content to Excel.
ExcelWorksheetOption excelWorksheetOption
 Whether each worksheet contains only one table.
BOOL excelCSVFormat
 Whether to save as CSV format.
BOOL enableOCR
 Whether to enable OCR.
BOOL txtTableFormat
 Whether to format tables when converting to TXT.
BOOL imagePathEnhance
 Whether to enhance image paths.
float imageScaling
 Image scaling ratio.
BOOL formulaToImage
 Convert formulas to images.
BOOL auto_create_folder
 Whether to automatically create folder when exporting multiple documents.
BOOL output_document_per_page
 whether to output one document per page.
OCROption ocrOption
 OCR option scope.
htmlPageOption htmlPageOption
 Specify the Html page option.
PageLayoutMode pageLayoutMode
 Page layout mode.
ImageColorMode imageColorMode
 Image color mode.
ImageType imageType
 Image file type.
NSString * pageRanges
 Page ranges for conversion (e.g. "1-3,5,7-9")

Detailed Description

Convert options.

Definition at line 217 of file base_type.h.

Property Documentation

◆ auto_create_folder

- (BOOL) auto_create_folder
readwritenonatomicassign

Whether to automatically create folder when exporting multiple documents.

Definition at line 259 of file base_type.h.

◆ contain_page_background_image

- (BOOL) contain_page_background_image
readwritenonatomicassign

Whether to contain page background images when converting,which takes effect only when enable_ocr is true.

Definition at line 226 of file base_type.h.

◆ containAnnotation

- (BOOL) containAnnotation
readwritenonatomicassign

Whether to include annotations.

Definition at line 232 of file base_type.h.

◆ containImage

- (BOOL) containImage
readwritenonatomicassign

Whether to include images (only effective when OCR is disabled)

Definition at line 223 of file base_type.h.

◆ enableAILayout

- (BOOL) enableAILayout
readwritenonatomicassign

Whether to remove AI content during conversion.

Definition at line 220 of file base_type.h.

◆ enableOCR

- (BOOL) enableOCR
readwritenonatomicassign

Whether to enable OCR.

Definition at line 244 of file base_type.h.

◆ excelAllContent

- (BOOL) excelAllContent
readwritenonatomicassign

Whether to export all content to Excel.

Definition at line 235 of file base_type.h.

◆ excelCSVFormat

- (BOOL) excelCSVFormat
readwritenonatomicassign

Whether to save as CSV format.

Definition at line 241 of file base_type.h.

◆ excelWorksheetOption

- (ExcelWorksheetOption) excelWorksheetOption
readwritenonatomicassign

Whether each worksheet contains only one table.

Definition at line 238 of file base_type.h.

◆ formulaToImage

- (BOOL) formulaToImage
readwritenonatomicassign

Convert formulas to images.

Definition at line 256 of file base_type.h.

◆ htmlPageOption

- (htmlPageOption) htmlPageOption
readwritenonatomicassign

Specify the Html page option.

Definition at line 268 of file base_type.h.

◆ imageColorMode

- (ImageColorMode) imageColorMode
readwritenonatomicassign

Image color mode.

Definition at line 274 of file base_type.h.

◆ imagePathEnhance

- (BOOL) imagePathEnhance
readwritenonatomicassign

Whether to enhance image paths.

Definition at line 250 of file base_type.h.

◆ imageScaling

- (float) imageScaling
readwritenonatomicassign

Image scaling ratio.

Definition at line 253 of file base_type.h.

◆ imageType

- (ImageType) imageType
readwritenonatomicassign

Image file type.

Definition at line 277 of file base_type.h.

◆ jsonContainTable

- (BOOL) jsonContainTable
readwritenonatomicassign

Whether to include tables when converting to JSON.

Definition at line 229 of file base_type.h.

◆ ocrOption

- (OCROption) ocrOption
readwritenonatomicassign

OCR option scope.

Definition at line 265 of file base_type.h.

◆ output_document_per_page

- (BOOL) output_document_per_page
readwritenonatomicassign

whether to output one document per page.

Definition at line 262 of file base_type.h.

◆ pageLayoutMode

- (PageLayoutMode) pageLayoutMode
readwritenonatomicassign

Page layout mode.

Definition at line 271 of file base_type.h.

◆ pageRanges

- (NSString*) pageRanges
readwritenonatomiccopy

Page ranges for conversion (e.g. "1-3,5,7-9")

Definition at line 280 of file base_type.h.

◆ txtTableFormat

- (BOOL) txtTableFormat
readwritenonatomicassign

Whether to format tables when converting to TXT.

Definition at line 247 of file base_type.h.

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