Winnovative PDF Chromium for .NET Documentation
Winnovative.
This namespace defines the necessary API to convert HTML to PDF and HTML to Image. The main classes of the namespace are HtmlToPdfConverter and HtmlToImgCoverter that can be used to convert web pages and HTML strings to PDF and images in various formats.
Classes
| AuthenticationOptions | Authentication options allow you to specify a username and password when accessing an HTML page |
| GlobalSettings | Contains global settings that configure the behavior of the library within application |
| HtmlElementInfo | Represents detailed style and content information about a single HTML element |
| HtmlElementInfoCollection | Represents a collection of HTML elements and provides lookup functionality |
| HtmlToImageConverter | This class offers the necessary methods to create a raster image from a web page at given URL or from a HTML string. The generated image can be saved into a memory buffer or into a file |
| HtmlToPdfConversionInfo | Holds information about the result of an HTML to PDF conversion. This object is populated after the conversion completes and is exposed by the ConversionInfo property of the HTML to PDF converter. It contains details about the generated pages, inserted pages, and the total output. |
| HtmlToPdfConverter | 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 at given URL or from a HTML string. The generated PDF document can be saved into a memory buffer or into a file |
| Installation | Contains global installation instructions that configure the behavior of the library within the application |
| Licensing | Manages the license settings for the library tools |
| NameValuePair | Represents a name value pair |
| NameValuePairsCollection | Represents a collection of NameValuePair objects |
| PdfColor | Represents an RGB color with optional alpha (transparency). Used for defining fill and stroke colors in PDF rendering |
| PdfDigitalSignature | This class encapsulates the options to control the digital signature applied to the PDF document created by HTML to PDF Converter. The HtmlToPdfConverter class defines a reference to an object of this type |
| PdfDigitalSignatureAppearance | This class encapsulates the options to control the appearance of the digital signature applied to the PDF document created by HTML to PDF Converter. The PdfDigitalSignature class defines a reference to an object of this type |
| PdfDocument | Represents a new PDF document being constructed in memory |
| PdfDocumentCreateSettings | Represents configuration settings for creating a PDF document |
| PdfDocumentInfo | This class encapsulates the options to control the PDF document description (author, title, keywords, etc) |
| PdfDocumentOptions | This class encapsulates the options to control the PDF document redering process. The HtmlToPdfConverter class defines a reference to an object of this type |
| PdfEditor | Allows editing of existing PDF documents by adding HTML content, setting metadata, applying security options, and digital signatures. Use Save or SaveToFile(String) to generate the final PDF and release resources |
| PdfFont | Represents a font used to render text in the PDF document |
| PdfFontManager | Manages font creation and caching for PDF rendering |
| PdfHtmlHeaderFooter | A PDF Template can be used to repeat an HTML content in many PDF pages. The HTML can contain placeholders such as {page-number} and {total-pages} to be replaced when the PDF is generated. |
| PdfHtmlTemplate | A PDF Template can be used to repeat HTML content on multiple PDF pages. The HTML content can contain placeholders such as {page-number} and {total-pages} to be replaced when generating the final PDF. |
| PdfImageElement | Represents an image element that can be rendered into a PDF document. Supports positioning, scaling and alignment |
| PdfImageRenderInfo | Contains metadata about how and where an image was rendered on a PDF page |
| PdfLineStyle | Represents the appearance of a line including width and style |
| PdfMargins | The PDF document margins class used by PDF pages |
| PdfMerge | The PdfMerge class provides functionality to merge multiple PDF files or streams into a single PDF document. It supports adding password protected PDFs, preserving bookmarks, annotations and internal links from the source files |
| PdfMergeInfo | An object of this class is exposed by the PdfMerge class to provide details such as the total number of pages produced and the number of pages from each merged document |
| PdfPadding | Represents padding for a PDF element. |
| PdfPageInfo | Represents page-specific information extracted from a loaded PDF document. Includes details like page size, rotation, crop box, media box, and other boundaries. All dimensions are expressed in points (1 point = 1/72 inch) |
| PdfPageSize | This class represents a PDF page size. |
| PdfRectangle | Encapsulates a rectangle coordinates |
| PdfRectangleElement | Defines a rectangle to be drawn in the PDF document. Coordinates are relative to the top-left of the page |
| PdfRenderedRectangle | Represents a rectangular area on a specific PDF page where content was rendered |
| PdfSecurityInfo | Represents security-related information extracted from a loaded PDF document. Includes encryption status, permission flags and encryption algorithm details |
| PdfSecurityOptions | This class encapsulates the options to control the PDF document security like permissions, encryption, password protection |
| PdfTemplate | Represents a reusable template object |
| PdfTextElement | Represents a block of text to be rendered in a PDF document. Supports positioning, styling and multi-page continuation |
| PdfTextRenderInfo | Contains metadata about where and how text was rendered across pages |
| TableOfContentsOptions | This class encapsulates the options to control the table of content automatically generated in PDF from HTML heading tags |
| ViewerPreferences | Represents the viewer preferences of the PDF document generated by the HTML to PDF converter |
| WordToPdfConverter | Provides functionality for converting Word (.docx) documents to PDF format with support for customization options such as metadata, security and viewer preferences |
| WordToPdfDocumentOptions | This class encapsulates the options to control the PDF document redering process. The WordToPdfConverter class defines a reference to an object of this type |
Enumerations
| CaptureEntirePageMode | This enumeration defines the possible options for capturing the image of the entire HTML page, not just the visible viewport |
| EncryptionAlgorithm | This enumeration contains the possible values of the encryption algorithm used to encrypt a PDF document |
| EncryptionKeySize | This enumeration contains the possible values of the length of the encryption key used to encrypt a PDF document |
| ImageType | The possible image formats |
| LazyImagesLoadMode | This enumeration defines the possible options for the lazy image loading mode |
| PdfElementHorizontalAlign | Specifies the horizontal alignment of a PDF element on a PDF page |
| PdfElementVerticalAlign | Specifies the vertical alignment of a PDF element on a PDF page |
| PdfFontStyle | Represents font style flags used in PDF text rendering. Multiple styles can be combined using bitwise OR (e.g., Bold | Italic) |
| PdfLineDashStyle | Specifies the dash style for line rendering |
| PdfPageOrientation | This enumeration represents the possible orientations of the PDF pages of a PDF document |
| PdfStandardFont | Represents standard built-in PDF fonts that are always available in PDF readers. These fonts do not require embedding and are useful for small file sizes |
| PdfTemplateHorizontalAlign | Specifies the horizontal alignment of a PDF template on a PDF page |
| PdfTemplateVerticalAlign | Specifies the vertical alignment of a PDF template on a PDF page |
| PdfTextAlignment | Specifies the horizontal alignment of text when rendering in a PDF document |
| PdfTextDirection | Specifies the direction in which the text flows in the PDF |
| TriggeringMode | This enumeration represents the possible modes to trigger the conversion of a HTML document |
| ViewerFullScreenExitMode | Used in ViewerPreferences to specify how to display the document on exiting full-screen mode |
| ViewerPageLayout | A name object specifying the page layout to be used when the document is opened. |
| ViewerPageMode | A name object specifying how the document should be displayed when opened. |
| ViewerTextOrder | Used in ViewerPreferences to specify the predominant reading order for text. |