ComPDFKit Objective-C SDK
API Reference Documentation for ComPDFKit Objective-C SDK
Loading...
Searching...
No Matches
CPDFConversion Class Reference

Provides functionalities to convert PDF files into various formats such as Word, Excel, PPT, HTML, etc. More...

#include <conversion.h>

Inheritance diagram for CPDFConversion:

Class Methods

(ErrorCode) + startPDFToWord:password:outputPath:options:
 Starts the conversion of a PDF file to a Word document.
(ErrorCode) + startPDFToRtf:password:outputPath:options:
 Starts the conversion of a PDF file to an RTF document.
(ErrorCode) + startPDFToExcel:password:outputPath:options:
 Starts the conversion of a PDF file to an Excel document.
(ErrorCode) + startPDFToHtml:password:outputPath:options:
 Starts the conversion of a PDF file to an HTML document.
(ErrorCode) + startPDFToImage:password:outputPath:options:
 Starts the conversion of a PDF file to images.
(ErrorCode) + startPDFToTxt:password:outputPath:options:
 Starts the conversion of a PDF file to a TXT file.
(ErrorCode) + startPDFToJson:password:outputPath:options:
 Starts the conversion of a PDF file to a JSON file.
(ErrorCode) + startPDFToPpt:password:outputPath:options:
 Starts the conversion of a PDF file to a PowerPoint presentation.
(ErrorCode) + startPDFToSearchablePDF:password:outputPath:options:
 Starts the conversion of a PDF file to a searchable PDF.
(ErrorCode) + startPDFToMarkdown:password:outputPath:options:
(void) + cancel
 Cancels any ongoing PDF conversion process.

Detailed Description

Provides functionalities to convert PDF files into various formats such as Word, Excel, PPT, HTML, etc.

Definition at line 11 of file conversion.h.

Method Documentation

◆ cancel

+ (void) cancel

Cancels any ongoing PDF conversion process.

References cancel.

Referenced by cancel.

◆ startPDFToExcel:password:outputPath:options:

+ (ErrorCode) startPDFToExcel: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (ExcelOptions *_Nonnull) options 

Starts the conversion of a PDF file to an Excel document.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output Excel file path
optionsConversion settings (ExcelOptions)
Returns
Error code, 0 for success

◆ startPDFToHtml:password:outputPath:options:

+ (ErrorCode) startPDFToHtml: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (HtmlOptions *_Nonnull) options 

Starts the conversion of a PDF file to an HTML document.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output HTML file path
optionsConversion settings (HtmlOptions)
Returns
Error code, 0 for success

◆ startPDFToImage:password:outputPath:options:

+ (ErrorCode) startPDFToImage: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (ImageOptions *_Nonnull) options 

Starts the conversion of a PDF file to images.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output image file path
optionsConversion settings (ImageOptions)
Returns
Error code, 0 for success

◆ startPDFToJson:password:outputPath:options:

+ (ErrorCode) startPDFToJson: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (JsonOptions *_Nonnull) options 

Starts the conversion of a PDF file to a JSON file.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output JSON file path
optionsConversion settings (JsonOptions)
Returns
Error code, 0 for success

◆ startPDFToMarkdown:password:outputPath:options:

+ (ErrorCode) startPDFToMarkdown: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (MarkdownOptions *_Nonnull) options 

◆ startPDFToPpt:password:outputPath:options:

+ (ErrorCode) startPDFToPpt: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (PptOptions *_Nonnull) options 

Starts the conversion of a PDF file to a PowerPoint presentation.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output PPT file path
optionsConversion settings (PptOptions)
Returns
Error code, 0 for success

◆ startPDFToRtf:password:outputPath:options:

+ (ErrorCode) startPDFToRtf: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (RtfOptions *_Nonnull) options 

Starts the conversion of a PDF file to an RTF document.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output RTF file path
optionsConversion settings (RtfOptions)
Returns
Error code, 0 for success

◆ startPDFToSearchablePDF:password:outputPath:options:

+ (ErrorCode) startPDFToSearchablePDF: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (SearchablePdfOptions *_Nonnull) options 

Starts the conversion of a PDF file to a searchable PDF.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output searchable PDF file path
optionsConversion settings (SearchablePdfOptions)
Returns
Error code, 0 for success

◆ startPDFToTxt:password:outputPath:options:

+ (ErrorCode) startPDFToTxt: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (TxtOptions *_Nonnull) options 

Starts the conversion of a PDF file to a TXT file.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output TXT file path
optionsConversion settings (TxtOptions)
Returns
Error code, 0 for success

◆ startPDFToWord:password:outputPath:options:

+ (ErrorCode) startPDFToWord: (NSString *_Nonnull) filePath
password: (NSString *_Nonnull) password
outputPath: (NSString *_Nonnull) outputPath
options: (WordOptions *_Nonnull) options 

Starts the conversion of a PDF file to a Word document.

Parameters
filePathThe input PDF file path
passwordPassword for opening the PDF file (if required)
outputPathThe output Word file path
optionsConversion settings (WordOptions)
Returns
Error code, 0 for success

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