Click or drag to resize

ExpertPdf.HtmlToPdf Namespace

ExpertPdf.HtmlToPdf defines the HTML to PDF and HTML to image conversion API. The main classes of the namespace are PdfConverter and ImgCoverter that can be used to convert web pages and HTML strings to PDF documents and images.
Classes
 ClassDescription
Public classAuthenticationOptions Authentication options for accessing a URL in HTML to PDF converter (e.g IIS authentication).
Public classBeforeCreateNextPageEventArgs BeforeCreateNextPage event arguments
Public classBeforeRenderNextPageEventArgs BeforeRenderNextPage event arguments
Public classConversionSummary Offers summary information about the conversion process. After a successfull conversion the PdfConverter.ConversionSummary property is initialized with an instance of this class.
Public classConverterUtils HTML converter utilities
Public classHtmlConvertException Exception thrown by the HTML to PDF Converter library.
Public classHtmlDocumentInfo This class encapsulates the information about a converted HTML document like title, keywords and description.
Public classHtmlElementMapping Represents te mapping of a HTML element in the PDF document as collection of PDF rectangles. A HTML element can span on many pages in the generated PDF document and therefore, in general, many PDF rectangles are necessary to completely describe the mapping of a HTML element in PDF.
Public classHtmlElementMappingsCollection Represents a collection of mappings of HTML elements in PDF.
Public classHtmlElementPdfRectangle Represents the rectangle occupied by a HTML element in a page of the generated PDF document.
Public classHtmlElementsMappingOptions Defines the necessary API to retrieve the positions in the generated PDF document for the HTML elements specified in a list. The HTML elements are specified by their unique HTML ID or HTML tag name.
Public classHtmlExcludedRegionsOptions Defines the necessary API to define a set of HTML regions to be excluded from conversion to PDF. The HTML regions to be excluded are defined as HTML elements specified by their unique HTML ID or HTML tag name.
Public classHtmlToPdfArea A HTML string or URL to be added to the header or footer of the rendered PDF document. The PdfConverter.PdfHeaderOptions.HtmlToPdfArea property should be set with an object of this type.
Public classImageArea A image to be added to the header or footer of the rendered PDF document. The PdfConverter.PdfHeaderOptions.ImageArea property should be set with an object of this type.
Public classImgConverter This class offers the necessary API to create images in various formats from a specified web page
Public classLoginOptions This class contains options that are used to handle login pages.
Public classPdfBookmarkOptions Controls the bookmark generation
Public classPdfConverter This class is the main class of the HTML to PDF Converter which offers the necessary methods to create a PDF document from a web page or from a HTML string. The generated PDF document can be saved in memory or in a file.
Public classPdfDocumentInfo This class encapsulates the options to control the PDF document description (author, title, keywords, etc). The PDFConverter class define a reference to an object of this type
Public classPdfDocumentOptions This class encapsulates the options to control the PDF document redering process. The PdfConverter class define a reference to an object of this type.
Public classPdfElement The base class for the PDF elements that can be added to header and footer.
Public classPdfFooterOptions This class encapsulates the options to control the appearance of the footer in the rendered PDF document. The PDFConverter class contains a reference to an object of this type. If the ShowFooter property from PDFDocumentOptions object is false, the footer options have no efect
Public classPdfHeaderOptions This class encapsulates the options to control the appearance of the header in the rendered PDF document. The PDFConverter class contains a reference to an object of this type. If the ShowHeader property of the PDFDocumentOptions object is false, the header options have no efect
Public classPdfSecurityOptions This class encapsulates the options to control the PDF document security options. The PDFConverter class define a reference to an object of this type.
Public classPostConvertActionEventArgs This class encapsulates the arguments for the PostConvertAction event handler.
Public classProxyOptions The proxy settings used to resolve the requests. Note: This is used only by the WebKit rendering engine.
Public classRenderImageFormatConverter This class converts a RenderImageFormat to System.Drawing.ImageFormat
Public classTextArea A text to be added to the header or footer of the rendered PDF document. The PdfConverter.PdfHeaderOptions.TextArea property should be set with an object of this type.
Public classUnitsConverter Converts between various graphic units (pixels, points, etc).
Public classViewerPreferences Represents the viewer preferences of the PDF document
Delegates
 DelegateDescription
Public delegateBeforeCreateNextPageHandler BeforeCreateNextPage event handler
Public delegateBeforeRenderNextPageHandler BeforeRenderNextPage event handler
Public delegatePostConvertActionHandler The delegate type for handling the PostConvertAction event of PdfConverter class.
Enumerations
 EnumerationDescription
Public enumerationColorSpace The possible color spaces for the generated PDF document.
Public enumerationEncryptionKeySize The length of the encryption key
Public enumerationHorizontalTextAlign Specifies horizontal alignment of text.
Public enumerationInternetSecurityZone Specifies the internet security zone settings used by the HTML converter to convert web sites.
Public enumerationNetworkProxyType The type of proxy used by converter to resolve requests
Public enumerationPdfCompressionLevel The rendered PDF compression level.
Public enumerationPdfFontType The list of supported fonts for the header and footer
Public enumerationPDFPageOrientation PDF page orientation
Public enumerationPdfPageSize The PDF document size
Public enumerationPdfStandardSubset The PDF subset used by the document.
Public enumerationRenderImageFormat The supporter image formats
Public enumerationRenderingEngine Specifies the rendering engine used by the converter to load and render the html.
Public enumerationStartupMode Specifies the converter startup mode. By default this is set to Automatic and the conversion is started as soon as the page loads (and ConversionDelay elapses). If set to Manual, the conversion is started only by a javascript call to ExpertPdfJSObj.startConversion()
Public enumerationVerticalTextAlign Specifies vertical alignment of text.
Public enumerationViewerFullScreenExitMode Used in ViewerPreferences to specify how to display the document on exiting full-screen mode
Public enumerationViewerPageLayout A name object specifying the page layout to be used when the document is opened.
Public enumerationViewerPageMode A name object specifying how the document should be displayed when opened.
Public enumerationViewerTextOrder Used in ViewerPreferences to specify the predominant reading order for text.