 | |
Pdf | |
The PdfHtmlElement type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActualText |
Gets or sets the exact text represented by this element (the structure element's
/ActualText entry), used when the drawn glyphs do not map to readable text.
(Inherited from PdfPageElement) |
| AllowContentHeightResize | A flag indicating if the content height can be recalculated to better fit the page. This can introduce certain errors in some cases. The default is True. Set it to False if content is split to more pages than expected. |
| AlternateText |
Gets or sets the alternate text describing this element for assistive technology (the
structure element's /Alt entry). Required on figures for PDF/UA conformance.
(Inherited from PdfPageElement) |
| Artifact |
Gets or sets a value indicating whether this element is an artifact — decorative or layout
content that carries no meaning and is excluded from the logical structure (backgrounds,
rules, running headers). Takes precedence over TagType.
(Inherited from PdfPageElement) |
| Authentication | HTTP authentication credentials used when fetching the web page. |
| BackColor |
Gets or sets the background fill color.
(Inherited from PdfElement) |
| Blending |
Gets or sets the blending mode.
(Inherited from PdfElement) |
| ChromiumEnginePath | The full path of the Chromium rendering engine used to render the html. When not set, the engine is resolved automatically from the application folder. |
| ChromiumEngineTemporaryFilesPath | The path where the Chromium rendering engine writes its temporary files. When not set, the system temporary folder is used. |
| ClickElementsDelayAfter | Delay in milliseconds after each element click. Default: 200. |
| ClickElementsDelayBefore | Delay in milliseconds before each element click. Default: 20. |
| ClickElementsSelectors | Css selectors of elements to click before rendering. Useful for dismissing banners or expanding collapsed sections. |
| ColorSpace |
Gets or sets the color space for the pdf element rendering.
(Inherited from PdfElement) |
| ConsoleLog | Console log captured from the rendered web page. Populated after the element has been rendered onto a page; null beforehand. |
| ConversionDelay | Additional time in seconds the converter waits after the web page has loaded, before it is rendered. |
| CssMediaType | Css media type used when rendering the html. Default: Screen. |
| CustomCSS | Custom css injected into the page before rendering. |
| DenyLocalFileAccess | Deny local file access during conversion. Default: false. |
| DrawBackground | Render the web page background in the generated pdf. Default: true. |
| EnableOfflineMode | Puts the browser into offline mode before navigation so all network requests fail. Default: False. |
| ExternalLinksEnabled | Render external hyperlinks from the web page in the generated pdf. Default: true. |
| ForceOutOfProcess | Runs this element's rendering in a separate engine process, whatever ChromiumEngineHostMode says. |
| ForeColor |
Gets or sets the foreground color used for drawing outlines and text.
(Inherited from PdfElement) |
| Gradient |
Gets or sets the gradient fill. When set, overrides BackColor for fills.
(Inherited from PdfElement) |
| Height | Gets or sets the destination height in points. A value of -1 (the default) lets the content flow onto the pages that follow, wherever the element starts: the first page holds what fits in the room left below Y, the pages after it are full pages, and the last one ends where the content ends. A fixed height taller than what is left of the page continues on the pages that follow until that much height has been drawn. |
| HiddenWebElements | Hidden web elements options applied during the inner html-to-pdf conversion. Available in the full edition. |
| HttpCache | Selects what the engine's HTTP cache keeps from this conversion for the next one. |
| HttpCookies | Custom HTTP cookies sent when fetching the web page. |
| HttpHeaders | Custom HTTP headers sent when fetching the web page. |
| HttpPostParameters | Custom HTTP POST parameters sent when fetching the web page. |
| InternalLinksEnabled | Convert internal hyperlinks (anchor links inside the page) into internal pdf links. Default: true. |
| JavaScriptEnabled | Run javascript when rendering the html. Default: true. |
| LazyImagesLoadingDelay | If LazyImagesLoadingEnabled is set to True, this property specifies the delay inserted for each page of the generated PDF document. Default: 40. |
| LazyImagesLoadingEnabled | A flag indicating if the lazy loaded images are rendered in the generated pdf document. Default: True. |
| LFN | Path of the diagnostic log file written during conversion. When unset, no log is written. |
| LineStyle |
Gets or sets the line style for outline drawing.
(Inherited from PdfElement) |
| LoginOptions | Custom-page login options used to authenticate before rendering. |
| ManagedContentTrimming | Gets or sets whether the library decides where the rendered content ends on each page. Default: true. |
| ManagedContentTrimmingMode | Gets or sets how the rendering engine finds where the content ends when ManagedContentTrimming is on. Default: Ink. |
| MaxConversionTime | Timeout in seconds for the print phase that produces the PDF after the page has loaded. Default: 60. |
| MaxPageLoadTime |
The time in seconds to wait for the web page to load. Obsolete: use NavigationTimeout.
Obsolete |
| MinPageLoadTime |
Additional time in seconds to wait before the web page is rendered. Obsolete: use ConversionDelay.
Obsolete |
| NavigationTimeout | The time in seconds the converter waits for the web page to load. |
| PageRanges | Restricts the rendered content to a subset of pages, e.g. "1", "2-4", "1-3,5,7-". Empty means all pages. |
| PdfBookmarkOptions | Bookmarks options applied during the inner html-to-pdf conversion. The bookmarks produced by the conversion are merged into the destination document at render time. |
| PdfPagesRectangles | Rectangles in the destination document where each slice of the rendered html landed, in client-area coordinates of the page that received the slice. Index 0 is the slice drawn on the host page at (X, Y); subsequent entries are the overflow slices drawn on appended pages at (0, 0). Populated after the element has been rendered onto a page; null beforehand. |
| PostLoadingScript | Javascript code injected and executed after the page has fully loaded. |
| PostLoadingScriptDelayAfter | Delay in milliseconds after post-loading script injection. Default: 20. |
| ProxyOptions | Network proxy options used when fetching the web page. |
| RenderingEngine | Gets or sets the rendering engine used to load and render the html. |
| RenderPageOnTimeout | Render the page on timeout instead of throwing. Default: false. |
| Rotated |
Gets a value indicating whether a rotation has been applied.
(Inherited from PdfElement) |
| Scaled |
Gets a value indicating whether a scale has been applied.
(Inherited from PdfElement) |
| Skewed |
Gets a value indicating whether a skew has been applied.
(Inherited from PdfElement) |
| StartupMode | Controls how the conversion starts. Available in the full edition. |
| StartupScript | Javascript code injected into the page before any other script runs. Available in the full edition. |
| Tagged | Produce tagged, accessible (PDF/UA-style) logical structure from this element's rendered content. The structure is taken from the rendering engine's own tagged output and re-mapped onto the host document as the element is stamped, exactly like the HtmlToPdf converter's Options.Tagged. |
| TagType |
Gets or sets the structure type used to tag this element in a tagged (accessible) document.
Ignored unless the document's tagged mode (PdfDocument.Tagged) is enabled. Null
(default) leaves the element untagged unless Artifact is set.
(Inherited from PdfPageElement) |
| Translated |
Gets a value indicating whether a translation has been applied.
(Inherited from PdfElement) |
| Transparency |
Gets or sets the transparency level (0 = completely transparent, 100 = completely opaque).
(Inherited from PdfElement) |
| VisibleWebElementId |
Convert only the html element with the specified id.
Obsolete |
| VisibleWebElementSelector | Convert only the part of the page matched by this CSS selector; the rest is ignored. |
| WebGlEnabled | Controls WebGL support in the rendering engine. |
| WebPageFixedSize | Controls whether the content below WebPageHeight is left out of the generated pdf document. |
| WebPageHeight | Gets or sets the height of the converted web page as it would appear in the internal browser used to render the html. |
| WebPageInformation | Information about the rendered web page (size, scale factor). Populated after the element has been rendered onto a page; null beforehand. |
| WebPageWidth | Gets or sets the width of the converted web page as it would appear in the internal browser used to render the html. |
| Width | Gets or sets the destination width in points. A value of -1 (the default) fits the element to the available client width minus X. |
| WindowStatus | If set, the converter waits for window.status to equal this value before capturing the page. Empty disables the wait. |
| X | Gets or sets the element X position, in client-area coordinates. |
| Y | Gets or sets the element Y position, in client-area coordinates. |
See Also