HiQPdf Next Library for .NET Documentation
Hi
This namespace defines the API required to convert HTML to PDF, HTML to image, Word DOCX to PDF, Excel XLSX to PDF, RTF to PDF, Markdown to PDF, PDF to text, PDF to image, search for text in PDF files, extract images from PDF documents and create or edit PDF documents.
Classes
| ExcelToPdfConverter | Provides functionality for converting Excel (.xlsx) documents to PDF format with support for customization options such as metadata, security and viewer preferences |
| ExcelToPdfDocumentOptions | This class encapsulates the options to control the PDF document redering process. The ExcelToPdfConverter class defines a reference to an object of this type |
| ExtractedImage | Encapsulates an image extracted from a PDF page |
| FindTextLocation | Represents the location of text on a PDF 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 |
| HtmlToImage | 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. The HTML to PDF conversion features require installing the corresponding core runtime in addition to the core library. It is recommended to use at least the HTML to PDF Converter NuGet package (or a meta-package depending on it) which provides the correct dependencies for all the HTML conversion features in the core library. |
| HtmlToPdf | 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. The HTML to PDF conversion features require installing the corresponding core runtime in addition to the core library. It is recommended to use at least the HTML to PDF Converter NuGet package (or a meta-package depending on it) which provides the correct dependencies for all the HTML conversion features in the core library. |
| 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 |
| HttpAuthentication | Encapsulates a username and a password to resolve various types of HTTP authentication |
| Installation | Contains global installation instructions that configure the behavior of the library within the application |
| KeyValue | Represents a key value pair |
| KeyValueCollection | Represents a collection of KeyValue objects |
| Licensing | Manages the license settings for the library tools |
| MarkdownToPdfConverter | Provides functionality for converting Markdown documents to PDF format with support for customization options such as metadata, security and viewer preferences |
| MarkdownToPdfDocumentOptions | This class encapsulates the options to control the PDF document redering process. The MarkdownToPdfConverter class defines a reference to an object of this type |
| PdfColor | Represents an RGB color with optional alpha (transparency). Used for defining fill and stroke colors in PDF rendering |
| PdfDigitalSignature | This class controls the digital signature of the PDF document created by HTML to PDF Converter. A reference to an object of this class is exposed by the DigitalSignature property of the PdfDocumentControl class. An object of PdfDocumentControl class is exposed by the Document property of the HtmlToPdf class |
| PdfDigitalSignatureAppearance | Controls the appearance of the digital signature applied to the PDF document created by HTML to PDF Converter. The PdfDigitalSignature class exposes a reference to an object of this class |
| PdfDocument | Represents a new PDF document being constructed in memory |
| PdfDocumentControl | This class controls the properties of the PDF document generated by the HTML to PDF Converter. A reference to an object of this class is exposed by the Document property of the HtmlToPdf class |
| PdfDocumentCreateSettings | Represents configuration settings for creating a PDF document |
| 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. /// The HTML to PDF conversion features require installing the corresponding core runtime in addition to the core library. It is recommended to use at least the HTML to PDF Converter NuGet package (or a meta-package depending on it) which provides the correct dependencies for all the HTML conversion features in the core library. |
| 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. The HTML to PDF conversion features require installing the corresponding core runtime in addition to the core library. It is recommended to use at least the HTML to PDF Converter NuGet package (or a meta-package depending on it) which provides the correct dependencies for all the HTML conversion features in the core library. |
| 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 |
| PdfImagesExtractionInfo | Holds information about the result of extracting images from a PDF. This object is populated after the conversion completes and is exposed via the ExtractionInfo property of the PDF Images Extractor. |
| PdfImagesExtractor | Encapsulates the PDF Images Extractor functionality and allows you to extract images from a PDF document |
| 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 |
| 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. |
| PdfPageImage | Represents an image of a PDF page |
| 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 | The PDF page size class used to define the standard and custom sizes of a PDF document page |
| PdfProcessorGlobalSettings | Contains global settings that configure the behavior of the library within application |
| PdfProcessorInstallation | Provides information about the global installation of the PDF processor |
| PdfProperties | Controls the title, subject, keywords, author and the creation date of the PDF document generated by converter |
| PdfRectangle | The coordinates of a rectangle |
| 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 |
| PdfSecurity | Controls the security attributes of the generated PDF document |
| PdfSecurityInfo | Represents security-related information extracted from a loaded PDF document. Includes encryption status, permission flags and encryption algorithm details |
| PdfTableOfContents | Controls the automatic creation of the table of contents in PDF from HTML heading tags |
| 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 |
| PdfToImageConversionInfo | Holds information about the result of a PDF to Image conversion. This object is populated after the conversion completes and is exposed via the ConversionInfo property of the PDF to Image converter. |
| PdfToImageConverter | Encapsulates PDF to image conversion functionality and allows converting PDF pages to PNG images |
| PdfToTextConversionInfo | Holds information about the result of a PDF to Text conversion. This object is populated after the conversion completes and is exposed via the ConversionInfo property of the PDF to Text converter. |
| PdfToTextConverter | Provides PDF to text conversion functionality |
| PdfViewer | The PDF viewer preferences class controls the way the PDF document created by the HTML to PDF converter is displayed in a PDF viewer |
| RtfToPdfConverter | Provides functionality for converting RTF documents to PDF format with support for customization options such as metadata, security and viewer preferences |
| RtfToPdfDocumentOptions | This class encapsulates the options to control the PDF document redering process. The RtfToPdfConverter class defines a reference to an object of this type |
| 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
| ConversionTriggerMode | The possible options for triggering the conversion after the page was loaded in converter |
| ConvertEntirePageMode | The modes used to convert the entire HTML page to image |
| ImageType | The image format types |
| LazyImagesLoadMode | The possible modes for the lazy image loading |
| 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 |
| PdfEncryptionLevel | The encryption level |
| PdfEncryptionMode | The PDF encryption mode |
| PdfFontStyle | Represents font style flags used in PDF text rendering. Multiple styles can be combined using bitwise OR (e.g., Bold | Italic) |
| PdfFullScreenExitMode | The viewer page mode on exiting full screen |
| PdfLineDashStyle | Specifies the dash style for line rendering |
| PdfPageImageColorSpace | Specifies the color space of a PDF page image |
| PdfPageLayout | The page layout to be used when the document is displayed |
| PdfPageMode | The page mode to be used when the document is displayed |
| PdfPageOrientation | This enumeration represents the possible PDF page orientations |
| PdfProcessorImageType | The possible image formats for PDF processor operations |
| PdfReadingOrder | The reading order when the document is displayed |
| 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 |
| PdfToTextLayout | The resulted text layout |