PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
pdf2xlsx.h File Reference

PDF to XLSX conversion API. More...

#include <pdfsdk/core.h>

Go to the source code of this file.

Classes

struct  PDFConvertToXlsxParams
 Contains conversion-related parameters such as the output file, the Excel sheet makeup, and a flag specifying whether to convert only tables from the PDF file. More...
 

Macros

#define PDF_PDF2XLSX_API   PDFSDK_IMPORT_
 

Enumerations

enum  PDFConvertToXlsxType { kPDFConvertToXlsxTablePerSheet , kPDFConvertToXlsxPagePerSheet , kPDFConvertToXlsxDocumentPerSheet }
 Defines how the content is organized in the resulting Excel file. More...
 

Functions

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFConvertToXlsx (PDDoc source, const PDPageRange *pageRange, const PDProgressMonitor *progress, void *progressData, const PDFConvertToXlsxParams *params)
 A function to covert a PDF file (or a part of it) into a MS Excel Document format (.xlsx).
 

Detailed Description

PDF to XLSX conversion API.

Enumeration Type Documentation

◆ PDFConvertToXlsxType

Defines how the content is organized in the resulting Excel file.

This enumeration specifies the option to structure the converted data in the desired way.

Enumerator
kPDFConvertToXlsxTablePerSheet 

Each table from the PDF is placed on a separate sheet in the Excel file.

kPDFConvertToXlsxPagePerSheet 

Each page of the PDF is placed on a separate sheet in the Excel file.

kPDFConvertToXlsxDocumentPerSheet 

The entire content of the PDF is placed on a single sheet in the Excel file.

Function Documentation

◆ PDFConvertToXlsx()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFConvertToXlsx ( PDDoc source,
const PDPageRange * pageRange,
const PDProgressMonitor * progress,
void * progressData,
const PDFConvertToXlsxParams * params )

A function to covert 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]sourceThe already opened PDF document object to convert into .xlsx file format.
[in]pageRangeA pointer to the specific pages to convert. If a null pointer is passed the whole document is converted. To select specific pages, pass an array of the desired pages (i.e. {0,2} for p.1 and p.3) along with it's size.
[in]progressA pointer to the progress monitor to receive notifications about the conversion process. It may be null.
[in]progressDataA pointer to the progress data which is passed to progress monitor to update the process. It may be null.
[in]paramsA pointer to the conversion parameters like the output folder and file name, the Excel document makeup, and a flag specifying whether to convert only the tables from the PDF file (if there are any).