PDFix SDK  6.4.0
PdfHtmlDoc Struct Referenceabstract

PdfHtmlDoc class. More...

Public Member Functions

virtual bool Close ()=0
 Closes PdfHtmlDoc. More...
 
virtual bool Save (const wchar_t *path, PdfHtmlParams *params, PdfCancelProc cancel_proc, void *cancel_data)=0
 
virtual bool SaveDocHtml (PsStream *stream, PdfHtmlParams *params, PdfCancelProc cancel_proc, void *cancel_data)=0
 
virtual bool SavePageHtml (PsStream *stream, PdfHtmlParams *params, int page_num, PdfCancelProc cancel_proc, void *cancel_data)=0
 Writes HTLML data for of a page into stream. More...
 

Detailed Description

PdfHtmlDoc class.

A PdfHtmlDoc allow you to set convert PDF to HTML.

Member Function Documentation

◆ Close()

virtual bool PdfHtmlDoc::Close ( )
pure virtual

Closes PdfHtmlDoc.

See also
PdfToHtml::CreateHtmlDoc

◆ Save()

virtual bool PdfHtmlDoc::Save ( const wchar_t *  path,
PdfHtmlParams params,
PdfCancelProc  cancel_proc,
void *  cancel_data 
)
pure virtual

Writes html for the document into the file. Data contains document HTML, CSS and JS content including all pages. Any external reference like image or stylesheet is saved into the same folder as the input path unless kHtmlNoExternal flag is used.

Parameters
pathPath to the output html file.
paramsHtml parameters that allow modify the conversion algorithm.
cancel_procCallback to check for canceling operations.
cancel_dataPointer to client data for the cancel procedure.
Returns
true if the html document was created successfully or false in case of an error.

◆ SaveDocHtml()

virtual bool PdfHtmlDoc::SaveDocHtml ( PsStream stream,
PdfHtmlParams params,
PdfCancelProc  cancel_proc,
void *  cancel_data 
)
pure virtual

Writes html for the document into the stream. Data contains document specific html content excluding any page content.

Parameters
streamThe stream to write data into.
paramsHtml parameters that allow modify the conversion algorithm.
cancel_procCallback to check for canceling operations.
cancel_dataPointer to client data for the cancel procedure.
Returns
true if the document html was written successfully or false in case of an error.

◆ SavePageHtml()

virtual bool PdfHtmlDoc::SavePageHtml ( PsStream stream,
PdfHtmlParams params,
int  page_num,
PdfCancelProc  cancel_proc,
void *  cancel_data 
)
pure virtual

Writes HTLML data for of a page into stream.

Parameters
streamThe stream to write data into.
paramsHtml parameters that allow modify the conversion algorithm.
page_numThe page number of the page to get html data. The first page is 0.
cancel_procCallback to check for canceling operations.
cancel_dataPointer to client data for the cancel procedure.
Returns
true if the page html was written successfully or false in case of an error.