Conversion API. More...

#include <filesystem>
#include <pdfsdk/cxx/core.h>
#include <pdfsdk/convert/pdf2docx.h>
#include <pdfsdk/convert/pdf2html.h>
#include <pdfsdk/convert/pdf2pptx.h>
#include <pdfsdk/convert/pdf2xlsx.h>
#include <pdfsdk/convert/pdf2rtf.h>
#include <pdfsdk/convert/pdf2text.h>
#include <pdfsdk/convert/pdf2json.h>

Enumerations
enum class	PDF::ConvertPdfToExcelType { TablePerSheet , PagePerSheet , DocumentPerSheet }
	The type of conversion to perform when converting a PDF document to Excel format. More...

Functions
void	PDF::ConvertPdfToWord (const PDF::Document &input, bool ignoreHeadersAndFooters, const std::filesystem::path &outputFile, const std::vector< size_t > &pageIndexes={}, PDF::ProgressMonitor *progress=nullptr)
	Coverts a PDF file (or a part of it) into a MS Word Document format (.docx).

void	PDF::ConvertPdfToExcel (const PDF::Document &input, ConvertPdfToExcelType convertType, bool keepTablesOnly, const std::filesystem::path &outputFile, const std::vector< size_t > &pageIndexes={}, PDF::ProgressMonitor *progress=nullptr)
	Coverts a PDF file (or a part of it) into a MS Excel Document format (.xlsx).

void	PDF::ConvertPdfToPowerPoint (const PDF::Document &input, const std::filesystem::path &outputFile, const std::vector< size_t > &pageIndexes={}, PDF::ProgressMonitor *progress=nullptr)
	Coverts a PDF file (or a part of it) into a MS PowerPoint Document format (.pptx).

void	PDF::ConvertPdfToHtml (const PDF::Document &input, const std::filesystem::path &outputFolder, const std::vector< size_t > &pageIndexes={}, PDF::ProgressMonitor *progress=nullptr)
	Coverts a PDF file (or a part of it) into a HTML Document format (.html).

void	PDF::ConvertPdfToRtf (const PDF::Document &input, const std::filesystem::path &outputFile, const std::vector< size_t > &pageIndexes={}, PDF::ProgressMonitor *progress=nullptr)
	Coverts a PDF file (or a part of it) into a Rich Text Document format (.rtf).

void	PDF::ConvertPdfToText (const PDF::Document &input, const std::wstring &pageDivider, bool convertCroppedText, const std::filesystem::path &outputFile, const std::vector< size_t > &pageIndexes={}, PDF::ProgressMonitor *progress=nullptr)
	Coverts a PDF file (or a part of it) into plain text format.

void	PDF::ConvertPdfToJson (const PDF::Document &input, const std::filesystem::path &outputFile, const std::vector< size_t > &pageIndexes={}, PDF::ProgressMonitor *progress=nullptr)
	Coverts a PDF file (or a part of it) into a JSON format.

Detailed Description

Conversion API.

Enumeration Type Documentation

◆ ConvertPdfToExcelType

enum class PDF::ConvertPdfToExcelType

strong

The type of conversion to perform when converting a PDF document to Excel format.

Enumerator
TablePerSheet	Each table is converted onto a separate excel sheet.
PagePerSheet	Each page is converted onto a separate excel sheet.
DocumentPerSheet	The entire document is converted onto a single excel sheet.

Function Documentation

◆ ConvertPdfToExcel()

void PDF::ConvertPdfToExcel	(	const PDF::Document &	input,
		ConvertPdfToExcelType	convertType,
		bool	keepTablesOnly,
		const std::filesystem::path &	outputFile,
		const std::vector< size_t > &	pageIndexes = {},
		PDF::ProgressMonitor *	progress = nullptr )

inline

Coverts a PDF file (or a part of it) into a MS Excel Document format (.xlsx).

After the conversion the original Author and Title of the PDF document are preserved and transferred over onto the Excel document.

Parameters

[in]	input	A reference to the PDF document object to convert into Excel.
[in]	convertType	The type of conversion to perform (TablePerSheet, PagePerSheet, DocumentPerSheet).
[in]	keepTablesOnly	Whether to keep only the tables in the converted document.
[in]	outputFile	A reference to the path of the output Excel file.
[in]	pageIndexes	A reference to the indexes of the pages to convert. The first page of a document has index 0. Pass an empty vector to convert all pages.
[in,out]	progress	A pointer to an optional progress monitor for tracking the conversion progress page by page. Inherit the class ProgressMonitor and define the needed methods.

See also: ProgressMonitor

◆ ConvertPdfToHtml()

void PDF::ConvertPdfToHtml	(	const PDF::Document &	input,
		const std::filesystem::path &	outputFolder,
		const std::vector< size_t > &	pageIndexes = {},
		PDF::ProgressMonitor *	progress = nullptr )

inline

Coverts a PDF file (or a part of it) into a HTML Document format (.html).

Parameters

[in]	input	A reference to the PDF document object to convert into HTML.
[in]	outputFolder	A reference to the folder where the HTML file will be saved.
[in]	pageIndexes	A reference to the indexes of the pages to convert. The first page of a document has index 0. Pass an empty vector to convert all pages.
[in,out]	progress	A pointer to an optional progress monitor for tracking the conversion progress page by page. Inherit the class ProgressMonitor and define the needed methods.

See also: ProgressMonitor

◆ ConvertPdfToJson()

void PDF::ConvertPdfToJson	(	const PDF::Document &	input,
		const std::filesystem::path &	outputFile,
		const std::vector< size_t > &	pageIndexes = {},
		PDF::ProgressMonitor *	progress = nullptr )

inline

Coverts a PDF file (or a part of it) into a JSON format.

Parameters

[in]	input	A reference to the PDF document object to convert into JSON format.
[in]	outputFile	A reference to the path of the output JSON file.
[in]	pageIndexes	A reference to the indexes of the pages to convert. The first page of a document has index 0. Pass an empty vector to convert all pages.
[in,out]	progress	A pointer to an optional progress monitor for tracking the conversion progress page by page. Inherit the class ProgressMonitor and define the needed methods.

See also: ProgressMonitor

◆ ConvertPdfToPowerPoint()

void PDF::ConvertPdfToPowerPoint	(	const PDF::Document &	input,
		const std::filesystem::path &	outputFile,
		const std::vector< size_t > &	pageIndexes = {},
		PDF::ProgressMonitor *	progress = nullptr )

inline

Coverts a PDF file (or a part of it) into a MS PowerPoint Document format (.pptx).

Parameters

[in]	input	A reference to the PDF document object to convert into PowerPoint.
[in]	outputFile	A reference to the path to the path of the output PowerPoint file.
[in]	pageIndexes	A reference to the indexes of the pages to convert. The first page of a document has index 0. Pass an empty vector to convert all pages.
[in,out]	progress	A pointer to an optional progress monitor for tracking the conversion progress page by page. Inherit the class ProgressMonitor and define the needed methods.

See also: ProgressMonitor

◆ ConvertPdfToRtf()

void PDF::ConvertPdfToRtf	(	const PDF::Document &	input,
		const std::filesystem::path &	outputFile,
		const std::vector< size_t > &	pageIndexes = {},
		PDF::ProgressMonitor *	progress = nullptr )

inline

Coverts a PDF file (or a part of it) into a Rich Text Document format (.rtf).

Parameters

[in]	input	A reference to the PDF document object to convert into RTF.
[in]	outputFile	The path of the output RTF file.
[in]	pageIndexes	A reference to the indexes of the pages to convert. The first page of a document has index 0. Pass an empty vector to convert all pages.
[in,out]	progress	A pointer to an optional progress monitor for tracking the conversion progress page by page. Inherit the class ProgressMonitor and define the needed methods.

See also: ProgressMonitor

◆ ConvertPdfToText()

void PDF::ConvertPdfToText	(	const PDF::Document &	input,
		const std::wstring &	pageDivider,
		bool	convertCroppedText,
		const std::filesystem::path &	outputFile,
		const std::vector< size_t > &	pageIndexes = {},
		PDF::ProgressMonitor *	progress = nullptr )

inline

Coverts a PDF file (or a part of it) into plain text format.

Parameters

[in]	input	A reference to the PDF document object to convert into plain text format.
[in]	pageDivider	The string used to separate pages in the output text file.
[in]	convertCroppedText	Whether to convert only the cropped text on each page.
[in]	outputFile	A reference to the path of the output text file.
[in]	pageIndexes	A reference to the indexes of the pages to convert. The first page of a document has index 0. Pass an empty vector to convert all pages.
[in,out]	progress	A pointer to an optional progress monitor for tracking the conversion progress page by page. Inherit the class ProgressMonitor and define the needed methods.

See also: ProgressMonitor

◆ ConvertPdfToWord()

void PDF::ConvertPdfToWord	(	const PDF::Document &	input,
		bool	ignoreHeadersAndFooters,
		const std::filesystem::path &	outputFile,
		const std::vector< size_t > &	pageIndexes = {},
		PDF::ProgressMonitor *	progress = nullptr )

inline

Coverts a PDF file (or a part of it) into a MS Word Document format (.docx).

After the conversion the original Author and Title of the PDF document are preserved and transferred over onto the Word document.

Parameters

[in]	input	A reference to the PDF document object to convert into Word.
[in]	ignoreHeadersAndFooters	Disable headers and footers analysis.
[in]	outputFile	A reference to the path of the output Word file.
[in]	pageIndexes	A reference to the indexes of the pages to convert. The first page of a document has index 0. Pass an empty vector to convert all pages.
[in,out]	progress	A pointer to an optional progress monitor for tracking the conversion progress page by page. Inherit the class ProgressMonitor and define the needed methods.

See also: ProgressMonitor

PDF SDK Documentation

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ConvertPdfToExcelType

Function Documentation

◆ ConvertPdfToExcel()

◆ ConvertPdfToHtml()

◆ ConvertPdfToJson()

◆ ConvertPdfToPowerPoint()

◆ ConvertPdfToRtf()

◆ ConvertPdfToText()

◆ ConvertPdfToWord()