| | Class | Description |
|---|
  | GlobalProperties |
Global configuration knobs for the SelectPdf SDK. Settings here apply to every
conversion and every document produced in the current application domain.
|
| HtmlToPdf |
Html To Pdf Converter. This class offers the API needed to convert any web page url or html string to pdf.
|
| HtmlToPdfAuthenticationOptions |
Holds the credentials sent to a web server that protects the converted page with HTTP
authentication. Reached through Authentication; the credentials
are used only when the server challenges the request.
|
| HtmlToPdfDocumentInformation |
Specifies the document metadata (title, author, subject, keywords, creation date, language)
written into the generated pdf document. Reached through
PdfDocumentInformation.
|
| HtmlToPdfException |
The exception thrown when an HTML to PDF conversion fails, for example on a navigation
timeout, an unreachable URL, or a rendering engine error. Catch it around
ConvertUrl(String) / ConvertHtmlString(String).
|
| HtmlToPdfOptions |
This class contains various options used for the html to pdf conversion (page size and
orientation, margins, web page dimensions, JavaScript, css media type, compression,
security, document information, and more).
|
| HtmlToPdfProxyOptions |
Specifies the network proxy the converter uses to reach the web page being converted.
Reached through ProxyOptions; a proxy is used only when
Type is set to a value other than None.
|
| HtmlToPdfResult |
Holds detailed information produced by a completed HTML to PDF conversion — page counts,
web and pdf page sizes, the scale factor, the drawn rectangles, and the captured console log.
Obtained from ConversionResult after a convert call returns; all
properties are read-only to consumer code.
|
| HtmlToPdfViewerPreferences |
Controls how the generated pdf document is presented when opened in a pdf viewer such as
Adobe Reader — which chrome to hide, how to fit and position the window, and the initial
page mode and layout. Reached through ViewerPreferences.
|
| LoginOptions |
Drives an interactive, form-based login the converter performs before rendering a protected
page: it navigates to LoginPage, types Username and
Password into the fields identified by the CSS selectors, and clicks the submit
button. Reached through LoginOptions. Use this for pages behind
an HTML login form; use Authentication for HTTP authentication.
|
| PdfBookmark |
Represents a bookmark (outline entry) in a pdf document. Bookmarks appear in the
navigation pane of PDF readers and let users jump to specific locations in the document.
|
| PdfBookmarkOptions |
Instructs the converter to automatically create pdf outline bookmarks from the web page
elements matched by CssSelectors, optionally nesting them into a hierarchy.
Reached through PdfBookmarkOptions.
|
| PdfBookmarksCollection |
Represents the collection of bookmarks in a pdf document (accessed via
Bookmarks) or the children of a parent bookmark
(accessed via ChildNodes).
|
| PdfCanvas |
Base class for objects that can render pdf page elements.
|
| PdfColor |
Represents a color used in PDF graphic elements. Construct one from red / green / blue byte
components, from a gray level, from CMYK components, or convert implicitly to and from
Color.
|
| PdfCustomPageSize |
Represents a custom page size for PDF documents, specified in points. Construct one with
explicit dimensions, or use a predefined static size such as A4 or
Letter.
|
| PdfDestination |
Represents a destination in a pdf document.
|
| PdfDocument |
Represents a PDF document. Can be used to create a new empty PDF document or to load an existing one.
|
| PdfDocumentException |
Represents errors that occur during PDF document operations (loading, saving, page
manipulation, security, and rendering).
|
| PdfDocumentInformation |
Represents the document information properties of a PDF document (title, author, subject, etc.).
Accessed through DocumentInformation.
|
| PdfDocumentSecurity |
Represents the security settings of a PDF document, including passwords, encryption
algorithm / key size, and per-operation permissions. Accessed through
Security. Encryption is written to the output only when at least
one password is set or a permission is restricted; clearing both passwords on a loaded
document and saving strips existing encryption.
|
| PdfFont |
Represents a font in a pdf document. Five ways to create one:
- CreateStandardFont(PdfStandardFont, Single) — one of the 14 built-in
PDF fonts (Helvetica, Times, Courier, Symbol, ZapfDingbats). Fastest, smallest output,
but not embedded — rejected by PDF/A.
- CreateCJKFont(PdfStandardCJKFont, Single) — one of the 7 standard
CJK fonts. Also not embedded; shipped with PDF/A-compliant readers.
- CreateFromFile(String, Single) / CreateFromStream(Stream, Single)
/ CreateFromBytes(Byte, Single) — loads a TrueType (.ttf) or OpenType
(.otf) font from the filesystem or memory. The font is subset-embedded into the
output PDF, which is required for PDF/A output from scratch.
- CreateFromSystemFont(String, Single) — resolves a font installed on
the host system by family name. The font is subset-embedded, just like the file /
stream / bytes overloads.
|
| PdfFontCollection |
Collection of fonts associated with a PdfDocument. Accessed through
Fonts.
|
| PdfFooter |
Handles the properties of the footer of the generated pdf document.
|
| PdfHeader |
Handles the properties of the header of the generated pdf document.
|
| PdfHtmlSection |
Represents a html element that can be added to the header or footer templates of a pdf document.
|
| PdfImageSection |
Represents an image that can be added to the header or footer templates of a pdf document.
|
| PdfMargins |
Represents the margins (in points) of a PDF page or element. Used, for example, when adding a
page with Add(PdfCustomPageSize, PdfMargins) or when configuring
the conversion output.
|
| PdfPage |
Represents a page in a PDF document. Obtained from AddPage or
the document's Pages collection; add graphic elements to it with
Add(PdfPageElement).
|
| PdfPageCollection |
Represents the collection of pages in a PDF document. Accessed through
Pages; supports indexing, enumeration, and adding, inserting,
or removing pages.
|
| PdfPageElement |
Abstract base class for all graphic elements that can be added to a PDF page or template
(text, images, shapes, links). Concrete elements are created directly and placed on a page
with Add(PdfPageElement). In the full edition this base also carries the
tagging properties used when producing a tagged (accessible) document.
|
| PdfRenderingResult |
Contains the result of adding an element to a PDF page or template — the index of the last
page the element rendered on and the bounding rectangle of the content on that page. Returned
by Add(PdfPageElement).
|
| PdfSectionElement |
The abstract base class for the elements that can be added to the header or footer of a pdf document.
|
| PdfSecurityOptions |
Specifies the encryption and permission settings applied to the generated pdf document —
user and owner passwords, encryption key size and algorithm, and per-action permissions such
as printing, copying, and editing. Reached through SecurityOptions.
Encryption is written only when a password is set or a permission is restricted.
|
| PdfSystemFont |
Descriptor for a system-installed font. Resolves to an actual font file on the host
machine via PdfSystemFonts when the descriptor is handed to
Add(PdfSystemFont) or
CreateFromSystemFont(PdfSystemFont).
|
| PdfSystemFonts |
Discovery of fonts installed on the host system. Works on Windows, Linux and macOS.
|
| PdfTemplate |
Represents a template in a pdf document. A template contains elements that are repeated on more
than one page of the pdf document.
|
| PdfTemplateCollection |
Represents the collection of templates of a pdf document. A template is repeated on more than
one page of the pdf document. Reached via Templates.
|
| PdfTextSection |
Represents a text that can be added to the header or footer templates of a pdf document.
|
| PdfViewerPreferences |
Controls how the pdf document appears in a pdf viewer (Adobe Reader, Foxit, etc.) —
which panels are visible when the document opens, whether the viewer's chrome is
hidden, whether the window resizes to fit the first page, and so on. Obtained via
ViewerPreferences; mutations write through to the underlying
PDF immediately — no explicit apply step is needed. Works on every document origin:
new documents, loaded documents, and HtmlToPdf output.
|
| WebPageInformation |
Contains metadata read from the converted web page — its title, keywords, and description.
Obtained from WebPageInformation after a conversion completes.
|
Classes