Click or drag to resize

HtmlToPdfElement Properties

The HtmlToPdfElement type exposes the following members.

Properties
 NameDescription
Public propertyActualText Gets or sets the exact text this element stands for in a tagged document, when its content does not spell it (text drawn as an image or with an unusual font, for example). The default value is null.
(Inherited from PageElement)
Public propertyAllowContentHeightResize A flag indicating if the content height can be recalculated to better fit the page. This can introduce certain errors in some cases.
Public propertyAllowLocalAccess A flag indicating if local files can be loaded during the conversion. The default value is True and local files can be loaded.
Public propertyAlternateText Gets or sets the alternate description of this element in a tagged document, read by assistive technology instead of the content - the description of a figure, for example. PDF/UA requires it for figures. The default value is null.
(Inherited from PageElement)
Public propertyArtifact Gets or sets whether this element is decorative in a tagged document: it is marked as an artifact (a background, a rule, a running header) and left out of the logical structure. The default value is false.
(Inherited from PageElement)
Public propertyAuthenticationOptions HTTP authentication options (user name and password) for accessing the URL to convert.
Public propertyBackColor Gets or sets the element background color.
(Inherited from PageGraphicElement)
Public propertyBlending Gets or sets the blending mode for the transparent rendering of the element.
(Inherited from PageGraphicElement)
Public propertyCefEnginePath Gets or sets the full path of the folder containing the Chromium rendering engine.
Public propertyCefEngineTemporaryFilesPath Gets or sets the full path of a folder where the Chromium rendering engine will write temporary files.
Public propertyClickElementsDelayAfter Delay in miliseconds, after element click.
Public propertyClickElementsDelayBefore Delay in miliseconds, before element click.
Public propertyClickElementsSelectors Specifies elements from the web page that will be clicked before converting the page.
Public propertyClipHtmlView If the HTML content is not entirely visible in the HTML viewer at the specified width, the ClipHtmlView property will control whether the HTML content is clipped or the HTML viewer width is automatically extended to make visible the whole HTML content. The HTML viewer width is given by the HtmlViewerWidth property. The default value of this property is false. The width is handled the same way whether this is set or not; when this property is true and a height is set with the HtmlViewerHeight property, the HTML viewer is rendered at that fixed height and the content below it is left out of the generated PDF. With a height of 0 this property has no effect.
Public propertyColorSpace Gets or sets the color space the element colors are written in: RGB (the default), CMYK or grayscale.
(Inherited from PageGraphicElement)
Public propertyConsoleLog Returns the console log of the browser used to render the web page.
Public propertyConversionDelay An additional time in seconds to wait for asynchronous items to be loaded
Public propertyCreateFormFields Converts the controls of the HTML forms into fillable PDF form fields.
Public propertyCustomCSS Use this property to specify some CSS styles that will be injected into the page that is converted.
Public propertyDrawBackground Gets or sets a flag indicating if the HTML page background is rendered in PDF. Default value is true. Setting this property to false can make visible the existing PDF content behind this element.
Public propertyFitWideContent Gets or sets whether content wider than the HTML viewer is kept by laying the page out at the width the content needs and scaling it down to fit.
Public propertyForceOutOfProcess Runs this conversion in a separate engine process, whatever ChromiumEngineHostMode says.
Public propertyForeColor Gets or sets the element foreground color.
(Inherited from PageGraphicElement)
Public propertyGradient Gets or sets the gradient used to fill a shape.
(Inherited from PageGraphicElement)
Public propertyHtmlDocumentInfo Gets an object populated after conversion with the title, keywords, and description of the converted HTML document.
Public propertyHtmlElementsMappingOptions Gets a reference to the object controlling the retrieval of HTML elements position in the generated PDF. In order to retrieve the position in PDF for a list of HTML elements, the HtmlElementIds property of HtmlElementsMappingOptions must be set with an array of strings containing the HTML IDs of the HTML elements. The positions of the HTML elements in the generated PDF document will be returned in the HtmlElementsMappingResult object after the element was added to the page.
Public propertyHtmlExcludedRegionsOptions Gets a reference to the object controlling the exclusion of HTML elements from rendering to PDF. In order to exclude from PDF for a list of HTML elements, the HtmlElementIds and HtmlTagNames properties of HtmlExcludedRegionsOptions must be set with an array of strings containing the HTML IDs or tag names of the HTML elements excluded from conversion to PDF.
Public propertyHtmlViewerHeight Gets or sets the HTML viewer height in pixels. If the viewer width was not set, this property has no effect
Public propertyHtmlViewerWidth Gets or sets the HTML viewer width in pixels
Public propertyHttpCache Selects what the rendering engine's HTTP cache keeps from this conversion for the next one.
Public propertyHttpCookies Gets a collection of custom HTTP cookies to be sent by the converter to the web server when the web page to convert and the resources (image, css, etc) referenced by the web page are requested. A cookie is defined by a name and a value pair that can be added to the collection using the Add(string, string) method of the HttpCookies property.
Public propertyHttpHeaders Gets a collection of custom HTTP headers to be sent by the converter to the web server when the web page is requested from a URL. A custom HTTP header is defined by a name and a value pair that can be added to the collection using the Add(string, string) method of the HttpHeaders property. The custom HTTP headers can be used to define cookies, authentication options, URL referer or any other HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpCookies property.
Public propertyHttpPostParameters Gets the collection of custom HTTP POST parameters used for the conversion.
Public propertyInternalLinksEnabled When true this options instructs the converter to convert the internal HTML links to internal PDF links. The default value is true.
Public propertyLazyImagesLoadingDelay Delay per page, in miliseconds, for lazy images loading.
Public propertyLazyImagesLoadingEnabled Enables a delay mechanism to allow images to fully load.
Public propertyLineStyle Gets or sets the line style of the elements that render lines.
(Inherited from PageGraphicElement)
Public propertyLiveUrlsEnabled When true this options instructs the converter to convert the HTML links in PDF links. The default value is true.
Public propertyLoginOptions Handle custom page login.
Public propertyManagedContentTrimming Gets or sets whether the library decides where the rendered content of this element ends. The default is True.
Public propertyManagedContentTrimmingMode Gets or sets how the rendering engine reports where the rendered content ends when ManagedContentTrimming is True. The default is Ink.
Public propertyMaxConversionTime The maximum time in seconds the conversion of this element may take after the page has loaded. Default value is 60.
Public propertyNavigationTimeout The navigation timeout in seconds. Default value is 60.
Public propertyPdfBookmarkOptions Gets a reference to the object controlling the bookmarks creation for the rendered PDF document. In order to enable creation of bookmarks you have to set the TagNames property of PdfBookmarkOptions with the names of the HTML tags you want to bookmark.
Public propertyPostLoadingScript Use this property to specify some JavaScript code that will be injected into the page that is converted and executed after the page was fully loaded.
Public propertyPostLoadingScriptDelayAfter Delay in miliseconds, after post page loading javascript injection.
Public propertyProxyOptions Gets a reference to an object encapsulating the proxy options used to access the HTML document to convert.
Public propertyRenderedPagesRectangles The bounds of the rendered rectangle on each PDF page. This property is assigned after the element has been added to a PDF page.
Public propertyRenderElementId Use this property to convert only a certain section of the page, specified by the html element ID.
Public propertyRenderElementSelector Use this property to convert only the part of the page matched by this CSS selector.
Public propertyRenderingEngine Gets or sets the rendering engine used to load and render the HTML, and where it runs: on this machine (Chromium) or in a remote ExpertPdf engine (ChromiumRemote).
Public propertyRenderOnTimeout A flag indicating if the page is rendered even if a navigation timeout occurs. The default value is false and a navigation timeout exception is raised.
Public propertyRotated Gets whether the element is rotated (Rotate was called with a non-zero angle).
(Inherited from PageGraphicElement)
Public propertyScaled Gets whether the element is scaled (Scale was called with a factor other than 1).
(Inherited from PageGraphicElement)
Public propertyScriptsEnabled Enable scripts when rendering HTML to selectable PDF. Default is true.
Public propertySkewed Gets whether the element is skewed (Skew was called with a non-zero angle).
(Inherited from PageGraphicElement)
Public propertyStartupMode Use this property to specify the converter startup mode. By default this is set to Automatic and the conversion is started as soon as the page loads (and ConversionDelay elapses). If set to Manual, the conversion is started only by a javascript call to ExpertPdfJSObj.startConversion()
Public propertyStartupScript Use this property to specify some JavaScript code that will be injected into the page that is converted. The JavaScript code specified here will run before any other script on the page.
Public propertyTagged Produce tagged, accessible (PDF/UA) logical structure from the rendered content of this HTML element. The structure (headings, paragraphs, lists, tables, figures, links, reading order) comes from the rendering engine's tagged output and is added to the document structure tree.
Public propertyTagType Gets or sets the structure type of this element in a tagged document (a heading, a paragraph, a figure and so on). Every element added to a tagged document must have a tag type or be an Artifact. Ignored in a document that is not tagged. The default value is null.
(Inherited from PageElement)
Public propertyTranslated Gets whether the element is translated (Translate was called with a non-zero offset).
(Inherited from PageGraphicElement)
Public propertyTransparency Gets or sets the element transparency, as a value between 0 and 100: 0 means completely transparent and 100 completely opaque. The default value is 100.
(Inherited from PageGraphicElement)
Public propertyUsePrintCSSMediaType A flag indicating if @media print css styles are used or not. The default is false and @media screen css styles are used.
Public propertyWebGlEnabled Controls WebGL support in the rendering engine.
Top
See Also