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 |
| PdfAccessibilityOptions | Controls the accessibility settings of the generated PDF document. These settings take effect only when a PDF/UA or PDF/A standard requiring a tagged structure tree is selected using the PdfStandard property |
| PdfAccessibilityProperties | Accessibility metadata controlling how an element is inserted into the structure tree of a tagged PDF |
| PdfArcElement | Defines an elliptical arc drawn in a PDF document. The arc is a portion of the ellipse inscribed in the axis-aligned rectangle defined by X, Y, Width and Height. The arc starts at StartAngleDegrees and spans SweepAngleDegrees degrees, measured counter-clockwise from the positive X axis of that bounding rectangle. When Width equals Height the underlying ellipse is a circle and the arc is a circular arc. Coordinates are relative to the top-left corner of the page or template |
| PdfBaseFont | Represents a base font that can be used to create styled fonts |
| PdfCircleElement | Defines a circle drawn in a PDF document, specified by its center point and radius. Coordinates are relative to the top-left corner of the page or template |
| PdfColor | Represents a color used in PDF content |
| PdfDigitalSignature | This class encapsulates the options used to control the digital signature applied to a PDF document |
| PdfDigitalSignatureAppearance | This class encapsulates the options used to control the appearance of the digital signature applied to a PDF document |
| 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 |
| PdfElementRenderInfo | Contains metadata about where an element was rendered in the document. Each entry in RenderedRectangles describes one occurrence on a specific page or template |
| PdfEllipseElement | Defines an ellipse drawn in a PDF document, inscribed within an axis-aligned bounding rectangle before any rotation is applied. Coordinates are relative to the top-left corner of the page or template |
| PdfFileAttachment | Represents a file attached to a PDF document. The attachment is added to the document's Attachments panel in PDF viewers. To also display a clickable icon on a specific page, use PdfFileAttachmentAnnotation instead. Use one of the static factory methods (FromBytes(Byte, String), FromFile(String), FromExternalPath(String), FromUrl(String)) to create an instance, then pass it to AddFileAttachment on the document, editor, merger or HTML to PDF document options |
| PdfFileAttachmentAnnotation | Represents a file attachment displayed as a clickable icon on a specific page of the PDF. Clicking the icon opens or extracts the attached file. The file is also added to the Attachments panel alongside any other attachments. Use one of the static factory methods (FromBytes(Byte, String, Int32, Int32, Int32), FromFile(String, Int32, Int32, Int32), FromExternalPath(String, Int32, Int32, Int32), FromUrl(String, Int32, Int32, Int32)) to create an instance, then pass it to AddFileAttachmentAnnotation on the document, editor, merger, or HTML-to-PDF options |
| PdfFont | Represents a font used to render text in a PDF document |
| PdfFontManager | Provides methods for loading, registering and creating PDF fonts |
| PdfFormOptions | Specifies options for converting HTML form controls into interactive PDF form fields |
| 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. |
| PdfHtmlTemplatePlacement | Describes the final placement of a HTML template on a specific PDF page |
| 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. Exposes both the axis-aligned bounding box and the rotated four-corner outline, together with the page dimensions and the portion of the bounding box that remains visible inside the 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 |
| PdfLineElement | Defines a straight line segment drawn between two points in a PDF document. Coordinates are relative to the top-left corner of the page or template |
| PdfLineStyle | Defines the appearance of a stroked line, including width, dash pattern, endpoint shape and corner join style |
| PdfLinkAnnotation |
A clickable hyperlink annotation placed on a PDF page. Use one of
the static factory methods (FromUrl(String, Int32, Single, Single, Single, Single), ToPage(Int32, Int32, Single, Single, Single, Single),
ToPageLocation(Int32, PdfLinkPageLocation, Int32, Single, Single, Single, Single) to
build the link, then pass it to
AddLinkAnnotation on the document, editor, merger or
HTML-to-PDF document options.
For PDF/UA compliance, set Description to a meaningful alternative description |
| PdfLinkPageLocation | Describes how the target page is positioned and zoomed when a PdfLinkAnnotation created with ToPageLocation(Int32, PdfLinkPageLocation, Int32, Single, Single, Single, Single) is followed. Use one of the static factory methods (FitPage, FitWidth(Single), FitHeight(Single), AtCoordinates(Single, Single, NullableSingle)) to construct an instance |
| 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. Tagging and AcroForms are not preserved during the merge process |
| 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 | This class represents a PDF page size |
| PdfPathElement | Defines a generic path composed of move, line, cubic Bezier and close operations. Use this element when none of the dedicated shape elements is expressive enough to describe the desired geometry. Coordinates are relative to the top-left corner of the page or template |
| PdfPathOperation | Represents a single drawing operation that contributes to the geometry of a PdfPathElement. Use the factory methods to construct operations rather than directly populating fields, since each operation type uses a different subset of coordinates |
| PdfPointF | Represents a point in the public PDF coordinate space used by the library |
| PdfPolygonElement | Defines a closed polygon drawn through a sequence of points in a PDF document. The polygon can be both stroked and filled. Coordinates are relative to the top-left corner of the page or template |
| PdfPolylineElement | Defines an open polyline drawn through a sequence of points in a PDF document. The polyline is stroked but not filled. Coordinates are relative to the top-left corner of the page or template |
| 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 |
| PdfQuadF | Represents the four transformed corners of a rectangle in page space |
| PdfRectangle | Encapsulates a rectangle coordinates |
| PdfRectangleElement | Defines a rectangle to be drawn in the PDF document. Coordinates are relative to the top-left corner of the page or template |
| PdfRectangleF | Represents a rectangle in the PDF coordinate space used by the library |
| PdfRenderedRectangle | Represents a single occurrence of an element on a PDF page. Carries the axis-aligned bounding rectangle, the rotated four-corner outline and the page dimensions |
| PdfRoundedRectangleElement | Defines a rectangle with rounded corners drawn in a PDF document. Coordinates are relative to the top-left corner of the page or template |
| 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 |
| PdfSignatureInfo | Represents digital signature information extracted from a loaded PDF document. Reports the presence and metadata of signatures, but does NOT validate cryptographic integrity, certificate trust chains, or timestamp validity. Use a dedicated validator for cryptographic verification |
| PdfTableOfContents | Controls the automatic creation of the table of contents in PDF from HTML heading tags |
| PdfTemplate | Represents a reusable template object |
| PdfTemplatePlacement | Describes the final placement of a template on a specific PDF page and maps coordinates from template space to page space |
| PdfTextAnnotation | Represents a sticky-note style annotation displayed as a clickable icon on a specific page of the PDF. Clicking the icon opens a popup with the note text. The annotation also appears in the viewer's Comments panel alongside any other comments. Use Create(String, Int32, Int32, Int32) to create an instance, then pass it to AddTextAnnotation on the document, editor or merger |
| PdfTextElement | Represents a block of text to be rendered in a PDF document. Supports positioning, styling and multi-page continuation |
| PdfTextPageRenderInfo | Carries the per-page render result for a text element: the geometric rectangle on a specific page together with the portion of text drawn on that page. One instance is produced for each page on which a portion of the text was rendered |
| PdfTextRenderInfo | Contains metadata about where and how text was rendered across pages. For each page on which a portion of the text was drawn, the corresponding entry in Pages exposes both the geometric rectangle and the text actually rendered on that page |
| 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 |
| PdfUnicodeRanges | Provides predefined Unicode character ranges for use with CreateBaseFont(String, Boolean, IListInt32). Each range is an array of two integers representing the inclusive start and end Unicode codepoints |
| 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 possible image formats |
| LazyImagesLoadMode | This enumeration defines the possible options for the lazy image loading mode |
| PdfArcClosureType | Specifies how an arc element is closed and whether it can be filled |
| PdfAttachmentIcon | Icon displayed for an attachment annotation on a PDF page |
| PdfAttachmentRelationship | Relationship between an attached file and the host PDF document, per PDF/A-3 and PDF/A-4 specifications |
| PdfCertificationLevel | PDF certification levels |
| PdfColorModel | Represents the color model used by a color instance |
| 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 |
| PdfFieldNamingMode | Specifies how PDF field names are generated from HTML form controls |
| PdfFontStyle | Represents font style flags used in text rendering |
| PdfFullScreenExitMode | The viewer page mode on exiting full screen |
| PdfLineCapStyle | Specifies the shape used at the endpoints of a stroked open path |
| PdfLineDashStyle | Specifies the dash style for line rendering |
| PdfLineJoinStyle | Specifies the shape used at corners where two stroked path segments meet |
| PdfLinkBorderStyle | Border style drawn around a PdfLinkAnnotation hotspot. Default is None -- typical for text hyperlinks where the clickable area is implied by the underlying text content |
| PdfLinkHighlightMode | Visual feedback shown when the user activates a PdfLinkAnnotation hotspot |
| PdfLinkPageFit | Page-fit type used by PdfLinkPageLocation to describe how the target page is displayed when the link is followed |
| 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 orientations of the PDF pages of a PDF document |
| PdfPathOperationType | Identifies the type of operation stored in a PdfPathOperation |
| PdfProcessorImageType | The possible image formats for PDF processor operations |
| PdfReadingOrder | The reading order when the document is displayed |
| PdfRotationPivot | Defines the pivot point used when rotating a PDF element. The pivot represents the fixed point around which the element is rotated |
| PdfStandard | Specifies the PDF standards compliance level for the generated 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 |
| PdfStructureType | Identifies the PDF logical structure role attached to a content element when the document is tagged |
| PdfSubmitBehavior | Specifies how submit actions are generated for PDF buttons |
| PdfSubmitFormat | Specifies the format used when a PDF form is submitted |
| 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 |
| PdfTextAnnotationIcon | Icon displayed on the page surface for a sticky-note text annotation |
| PdfTextDirection | Specifies the direction in which the text flows in the PDF |
| PdfToTextLayout | The resulted text layout |
| PdfValidationBehavior | Specifies how HTML validation metadata is mapped to PDF form behavior |