Click or drag to resize

HtmlToPdfArea Class

A HTML string or URL to be added to the header or footer of the rendered PDF document. The PdfConverter.PdfHeaderOptions.HtmlToPdfArea property should be set with an object of this type.
Inheritance Hierarchy
SystemObject
  ExpertPdf.Anywhere.HtmlToPdfPdfElement
    ExpertPdf.Anywhere.HtmlToPdfHtmlToPdfArea

Namespace: ExpertPdf.Anywhere.HtmlToPdf
Assembly: ExpertPdf.Anywhere (in ExpertPdf.Anywhere.dll) Version: 22.0
Syntax
public class HtmlToPdfArea : PdfElement

The HtmlToPdfArea type exposes the following members.

Constructors
 NameDescription
Public methodHtmlToPdfArea(String) Create a URL to PDF converter element at the specified x and y coordinates with the specified width and height. The URL to converter is given by the urlToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight parameters.
Public methodHtmlToPdfArea(String, String) Create a HTML string to PDF converter element at the specified x and y coordinates with the specified width. The HTML string to convert is given by the htmlStringToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight parameters.
Public methodHtmlToPdfArea(Single, Single, String) Create a URL to PDF converter element at the specified x and y coordinates with the specified width and height. The URL to converter is given by the urlToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, String) Create a URL to PDF converter element at the specified x and y coordinates with the specified width and height. The URL to converter is given by the urlToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, String, String) Create a HTML string to PDF converter element at the specified x and y coordinates with the specified width. The HTML string to convert is given by the htmlStringToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, String, Int32) Create a URL to PDF converter element at the specified x and y coordinates with the specified width and height. The URL to converter is given by the urlToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, String, String) Create a HTML string to PDF converter element at the specified x and y coordinates with the specified width. The HTML string to convert is given by the htmlStringToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, String, Int32, Int32) Create a URL to PDF converter element at the specified x and y coordinates with the specified width and height. The URL to converter is given by the urlToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, String, String, Int32) Create a HTML string to PDF converter element at the specified x and y coordinates with the specified width. The HTML string to convert is given by the htmlStringToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, Single, String, Int32, Int32) Create a URL to PDF converter element at the specified x and y coordinates with the specified width and height. The URL to converter is given by the urlToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, String, String, Int32, Int32) Create a HTML string to PDF converter element at the specified x and y coordinates with the specified width. The HTML string to convert is given by the htmlStringToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Public methodHtmlToPdfArea(Single, Single, Single, Single, String, String, Int32, Int32) Create a HTML string to PDF converter element at the specified x and y coordinates with the specified width. The HTML string to convert is given by the htmlStringToConvert parameter. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight paramenters.
Top
Properties
 NameDescription
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 propertyAuthenticationOptions HTTP authentication options (user name and password) for accessing the URL to convert.
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 PageWidth 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 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 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 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 when the HtmlToPdfArea is added to a PDF page. 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 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 area 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 area may take after the page has loaded. Default value is 60.
Public propertyNavigationTimeout The navigation timeout in seconds. Default value is 60.
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 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 propertyScriptsEnabled Enable scripts when rendering HTML to selectable PDF. Default is true.
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 area.
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
Fields
 NameDescription
Public fieldStatic memberDEFAULT_HTML_VIEWER_WIDTH_PX The default virtual browser width in pixels
Top
See Also