Conversion Summary

The ConversionSummary property of the PdfConverter class returns an object, populated after the call of one of the render methods described in PdfConverter Class section, with a set of data that can be used to display details about the conversion that has just finished or to further customize the generated PDF document as described in the Post Convert Customization section.

The most important properties of the ConversionSummary object are the PdfPageCount, which represents the total number of pages rendered by the converter and the RenderedPagesRectangles, which gives for each rendered PDF page the bounding rectangle for the content rendered in that page.

For example, if you want to add more elements at the end of the generated PDF document after a conversion, you can find where the conversion ended from the last rectangle of the RenderedPagesRectangles array. For this important scenario, two other properties were also added to the conversion summary: LastPageIndex and LastPageRectangle giving the zero based index of the last rendered page and the bounding rectangle of the content rendered in this last page.

Sample Code

Usage of conversion summary object is illustrated below:

Copy

// initialize pdf converter
PdfConverter pdfConverter = new PdfConverter();

// call the converter and get a Document object from URL
Document pdfDocument = pdfConverter.GetPdfDocumentObjectFromUrl(url);

// get the conversion summary object
ConversionSummary conversionSummary = pdfConverter.ConversionSummary;

// the PDF page where the previous conversion ended
PdfPage lastPage = pdfDocument.Pages[conversionSummary.LastPageIndex];

// the last rectangle in the last PDF page where the previous conversion nded
RectangleF lastRectangle = conversionSummary.LastPageRectangle;

// add another html element right below the content of the initial conversion
HtmlToPdfElement htmlToPdfUrl2 = new HtmlToPdfElement(lastRectangle.Left, lastRectangle.Bottom, url2);
lastPage.AddElement(htmlToPdfUrl2);

// save document
pdfDocument.Save(file);

// close document
pdfDocument.Close();

' initialize pdf converter
Dim pdfConverter As New PdfConverter()

' call the converter and get a Document object from URL
Dim pdfDocument As Document = pdfConverter.GetPdfDocumentObjectFromUrl(url)

' get the conversion summary object
Dim conversionSummary As ConversionSummary = pdfConverter.ConversionSummary

' the PDF page where the previous conversion ended
Dim lastPage As PdfPage = pdfDocument.Pages(conversionSummary.LastPageIndex)

' the last rectangle in the last PDF page where the previous conversion nded
Dim lastRectangle As RectangleF = conversionSummary.LastPageRectangle

' add another html element right below the content of the initial conversion
Dim htmlToPdfUrl2 As New HtmlToPdfElement(lastRectangle.Left, lastRectangle.Bottom, url2)
lastPage.AddElement(htmlToPdfUrl2)

' save document
pdfDocument.Save(file)

' close document
pdfDocument.Close()