HtmlToPdfElement Class

EVO HTML to PDF Converter Client Documentation
This class encapsulates a HTML to PDF converter functionality. Objects of this class can be added at any location in a PDF page or Template to render HTML. The conversion is performed when the element is added to a page or Template.
Inheritance Hierarchy

SystemObject
  EvoPdf.HtmlToPdfClientPageElement
    EvoPdf.HtmlToPdfClientPageGraphicElement
      EvoPdf.HtmlToPdfClientHtmlToPdfElement
        EvoPdf.HtmlToPdfClientHtmlToPdfVariableElement

Namespace:  EvoPdf.HtmlToPdfClient
Assembly:  EvoHtmlToPdfClient (in EvoHtmlToPdfClient.dll) Version: 7.5.0.0 (7.5.0.0)
Syntax

public class HtmlToPdfElement : PageGraphicElement

The HtmlToPdfElement type exposes the following members.

Constructors

  NameDescription
Public methodHtmlToPdfElement(String)
Creates an URL to PDF converter element at the (0,0) location in PDF page. The width of element in PDF page is the available width in PDF page and the height is auto determined.
Public methodHtmlToPdfElement(String, String)
Creates a HTML string to PDF converter element that will be rendered at the (0,0) location in PDF page using a base URL to resolve the external resources and a document URL to resolve the internal links. The width of element in PDF page is the available width in PDF page and the height is auto determined.
Public methodHtmlToPdfElement(Single, Single, String)
Creates an URL to PDF converter element at the specified x and y coordinates in PDF page. The width of element in PDF page is the available width in PDF page and the height is auto determined.
Public methodHtmlToPdfElement(Single, Single, Single, String)
Creates an URL to PDF converter element at the specified x and y coordinates with the specified width. The height in PDF is auto determined.
Public methodHtmlToPdfElement(Single, Single, String, String)
Creates a HTML string to PDF converter element at the specified x and y coordinates in PDF page using a base URL to resolve the external resources and a document URL to resolve the internal links. The width of element in PDF page is the available width in PDF page and the height is auto determined.
Public methodHtmlToPdfElement(Single, Single, Single, Single, String)
Creates an URL to PDF converter element at the specified x and y coordinates with the specified width and height.
Public methodHtmlToPdfElement(Single, Single, Single, String, Int32)
Creates an URL to PDF converter element at the specified x and y coordinates with the specified width. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.
Public methodHtmlToPdfElement(Single, Single, Single, String, String)
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources and a document URL to resolve the internal links. The height in PDF is auto determined.
Public methodHtmlToPdfElement(Single, Single, Single, Single, String, String)
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources and a document URL to resolve the internal links.
Public methodHtmlToPdfElement(Single, Single, Single, String, String, Int32)
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources and a document URL to resolve the internal links. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.
Public methodHtmlToPdfElement(Single, Single, Single, Single, String, Int32, Int32)
Creates a URL to PDF converter element at the specified x and y coordinates with the specified width and height using a document URL to resolve the internal links. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight parameters.
Public methodHtmlToPdfElement(Single, Single, Single, Single, String, String, Int32, Int32)
Creates a HTML string to PDF converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources and a document URL to resolve the internal links. The virtual browser width and height in pixels is specified by the htmlViewerWidth and htmlViewerHeight parameters.
Top
Properties

  NameDescription
Public propertyAuthenticationOptions
The AuthenticationOptions can be set with an username and a password in order to authenticate to the web server before accessing the URL to be converted in HTML to PDF element converter. They can be used for example to resolve the IIS Integrated Windows Authentication or other types of IIS authentication. They cannot be used to resolve ASP.NET Forms Authentication or a custom authentication method defined at application level.
Public propertyAvoidHtmlElementsBreakSelectors
Gets or sets the CSS selectors of the HTML elements to not be broken between PDF pages if possible when the HTML to PDF element is rendered
Public propertyAvoidImageBreak
When true this property instructs the HTML to PDF element converter to try to avoid cutting off the images between PDF pages
Public propertyAvoidTextBreak
When true this property instructs the HTML to PDF element converter to try to avoid cutting off the text between PDF pages. This property is true by default
Public propertyBackColor
Gets or sets element background color.
(Inherited from PageGraphicElement.)
Public propertyBaseUrl
Gets or sets the base URL of the HTML string to be converted to PDF
Public propertyBlending
Gets or sets blending mode for transparent rendering mode of the element.
(Inherited from PageGraphicElement.)
Public propertyBottomSpacing
A space in points to introduce at the bottom of PDF pages where the HTML element is rendered. 1 point is 1/72 inch. By default the bottom spacing is 0.
Public propertyClipHtmlView
If the HTML content is not entirely visible in the HTML viewer of the HTML to PDF element 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.
Public propertyClipRectangle
The clip rectangle applied when the element is rendered in PDF
(Inherited from PageGraphicElement.)
Public propertyConversionDelay
An additional time in seconds to wait for asynchronous items to be completely loaded or for a web page redirect to finish before starting the rendering in HTML to PDF element converter. Default value is 0.
Public propertyDefaultHtmlEncoding
The default HTML document text encoding to be used if there is no charset meta tag defined in the HTML document. By default this property is not set and an auto determined text encoding will be used by converter
Public propertyDownloadAllResources
Gets or sets a flag indicating if the HTML to PDF element should try to download all the resources even if this could cause a slower conversion. The default value is false.
Public propertyEmbedFonts
When true this options instructs the HTML to PDF element converter to embed all the true type fonts into the PDF document. The default value is true
Public propertyEnable3DTransformations
Gets or sets a flag indicating if the accelerated CSS 3D transformations are enabled in the HTML to PDF element converter. The default value is false
Public propertyEnableAccelerated2DCanvas
Gets or sets a flag indicating if the accelerated 2D canvas is enabled in the HTML to PDF element converter. The default value is false
Public propertyEnablePersistentStorage
Gets or sets a flag indicating if the persistent local storage is enabled in the HTML to PDF element converter. The default value is false
Public propertyEnableWebGL
Gets or sets a flag indicating if the WebGL is enabled in the HTML to PDF element converter. The default value is false
Public propertyEnhancedGraphicsQuality
A flag indicating the PDF graphics are rendered at the best quality by HTML to PDF element. The default property value is true
Public propertyExtensionsEnabled
Gets or sets a flag indicating if the HTML viewer extensions are executed in HTML to PDF element converter. The default value is false and no extension is executed. The Flash player for Mozilla Firefox must be installed in order to execute the flash content from HTML
Public propertyFitHeight
When this property is true the content produced by the HTML to PDF element will be resized if necessary to fit the available height in PDF page. By default this property is false.
Public propertyFitWidth
When this property is true the content produced by the HTML to PDF element will be resized if necessary to fit the available width in PDF page. When false the HTML content will be rendered at the real size. By default this property is true and the content will be resized if necessary to fit the available width in PDF page.
Public propertyForeColor
Gets or sets the element foreground color.
(Inherited from PageGraphicElement.)
Public propertyGradient
The gradient used to fill a shape.
(Inherited from PageGraphicElement.)
Public propertyHeight
Gets or sets the destination height in points of the rendered content. If the specified height is less or equal to 0, the destination height will be auto determined so all the content can be rendered.
Public propertyHiddenHtmlElementsSelectors
Gets or sets the CSS selectors of the HTML elements to be excluded from rendering in HTML to PDF element
Public propertyHtml
Gets or sets the HTML string to be converted to PDF
Public propertyHtmlDocumentInfo
Gets an object populated after conversion with the title, keywords, and description of the HTML document rendered by the HTML to PDF element.
Public propertyHtmlElementsMappingOptions
Gets a reference to the object that can be used to obtain the position in PDF of the HTML elements rendered by the HTML to PDF element. In order to retrieve the position in PDF for a list of HTML elements, the HtmlElementSelectors property of HtmlElementsMappingOptions class must be set with an array of strings containing the CSS selectors of the HTML elements you want to map. 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 propertyHtmlViewerHeight
Gets or sets the HTML viewer height in pixels of the HTML to PDF element. If the specified HTML viewer height is 0 the HTML viewer height will be automatically determined based on the HTML content and the HTML viewer width in order to make visible the whole HTML content. The HTML viewer width is given by the HtmlViewerWidth property of the HtmlToPdfElement class. 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 height can also be specified in the HtmlToPdfElement class contructor. The default value is 0 to automatically determine the HTML viewer height based on the HTML content and the HTML viewer width.
Public propertyHtmlViewerWidth
Gets or sets the preferred HTML viewer width in pixels of the HTML to PDF element. 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. By default the ClipHtmlView property is false and the HTML viewer is automatically extended in width to make visible the whole HTML content. The HTML viewer width can also be specified in the HtmlToPdfElement class constructor. The default value is 1024 pixels.
Public propertyHtmlViewerZoom
Gets or sets the HTML viewer zoom percentage in HTML to PDF element similar to zoom level in a browser. The default value of this property is 100
Public propertyHttpPostFields
Returns the collection of HTTP POST fields to be used when accessing a web page in HTML to PDF element. If there are elements in collection then the converter will make a POST request to the web page URL with the fields from this collection, otherwise it will make a GET request
Public propertyHttpRequestCookies
Gets a collection of custom HTTP cookies to be sent by the HTML to PDF element 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 HttpRequestCookies collection.
Public propertyHttpRequestHeaders
Gets a collection of custom HTTP headers to be sent by the HTML to PDF element 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 HttpRequestHeaders cllection. The PersistentHttpRequestHeaders property can be set on true to instruct the converter to send the custom headers each time an external resource (image, css, etc) referenced by the web page is requested. By default the PersistentHttpRequestHeaders property is false and the custom headers are not automatically sent to the web server when the web page resources are requested. The custom HTTP headers can be used to define cookies, authentication options, URL referrer or any other HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpRequestCookies property.
Public propertyImagePartSize
Gets or sets the maximum height in pixels of an image part in HTML to PDF element converter
Public propertyImagesScalingEnabled
A flag indicating if the images scaling is allowed in HTML to PDF element. The default property value is false
Public propertyImpersonationOptions
The impersonation options applied during navigation by HTML to PDF element converter
Public propertyInitialHtmlViewerHeight
Gets or sets the initial height in pixels of the HTML viewer in HTML to PDF element converter. This value of this property is ignored if the HtmlViewerHeight property is set
Public propertyInsertNewPagesEnabled
A flag indicating if the HTML to PDF element will always insert a new page in the PDF document when rendering next page instead of trying to use an already existing PDF page. This property is false by default
Public propertyInteractiveHiddenElements
A flag indicating if the interactive features are enabled for hidden HTML elements. This property is false by default
Public propertyInternalLinksEnabled
When true this options instructs the HTML to PDF element to convert the internal HTML links to internal PDF links. The default value is true.
Public propertyInterruptSlowJavaScript
Gets or sets a flag indicating if the slow JavaScript script should be interrupted in the HTML to PDF element converter. The default value is false and the scripts are not interrupted
Public propertyJavaScriptEnabled
A flag indicating if JavaScript execution is enabled in HTML to PDF element converter. The default is true.
Public propertyLineStyle
Gets or sets the line style for elements rendering lines.
(Inherited from PageGraphicElement.)
Public propertyLiveUrlsEnabled
When true this options instructs the HTML to PDF element to convert the HTML links to PDF links. The default value is true.
Public propertyLocalFilesAccessEnabled
Gets or sets a flag indicating if the access to local files is enabled in the HTML to PDF element converter. The default value is true
Public propertyManualTriggeringConversionDelay
An additional time in seconds to wait after manual triggering before starting the rendering in HTML to PDF element. Default value is 0.
Public propertyMaxHtmlViewerHeight
Gets or sets the maximum height in pixels to be rendered from the HTML document by the HTML to PDF element converter. The default value is 0 and the entire HTML document is rendered
Public propertyMediaType
Gets or sets the media type of the HTML document used by the HTML to PDF element. The default media type is 'screen'. If you set this property with 'print' then the CSS properties defined in '@media print' rule will be used to render the document
Public propertyMinHtmlViewerHeight
Gets or sets the minimum height in pixels to be rendered from HTML document by the HTML to PDF element converter. This value of this property is ignored if the HtmlViewerHeight property is set
Public propertyNavigationTimeout
The HTML to PDF element converter navigation timeout in seconds. Default value is 60.
Public propertyNoSizeElementsEnabled
A flag indicating if the hidden elements are rendered by the HTML to PDF element. The default property value is false
Public propertyOpacity
Gets or sets element opacity. The opacity is expressed as a value between 0 and 100. 0 means completely transparent and 100 completely opaque. The default value of this property is 100.
(Inherited from PageGraphicElement.)
Public propertyPageBreakAfterHtmlElementsSelectors
Gets or sets the CSS selectors of the HTML elements after which to force a page break in PDF document when the HTML to PDF element is rendered
Public propertyPageBreakBeforeHtmlElementsSelectors
Gets or sets the CSS selectors of the HTML elements before which to force a page break in PDF document when the HTML to PDF element is rendered
Public propertyPaginate
When this property is true the HTML to PDF element can be paginated to render many PDF pages if necessary.
Public propertyPdfBookmarkOptions
Gets a reference to the object controlling the bookmarks creation in PDF for the HTML to PDF element. In order to enable creation of bookmarks you have to set the HtmlElementSelectors property of PdfBookmarkOptions class with the CSS selectors of the HTML elements you want to bookmark.
Public propertyPdfFormOptions
Gets a reference to the object controlling the automatic conversion of a HTML form to a PDF form in the generated PDF document
Public propertyPersistentHttpRequestHeaders
This property can be set on true to instruct the HTML to PDF element converter to send the custom headers defined by the HttpRequestHeaders property each time an external resource (image, css, etc) referenced by the web page is requested. The default value of this property is true and the custom headers are automatically sent to the web server when the web page resources are requested.
Public propertyPostScriptFontsEnabled
Gets or sets a flag indicating if the fonts with PostScript outlines are enabled in the HTML to PDF element converter. The default value is true
Public propertyPrerenderEnabled
Gets or sets a flag indicating if the HTML to PDF element should perform a pre-rendering. The default value is true
Public propertyProxyOptions
Gets a reference to an object encapsulating the proxy options used by HTML to PDF element to access the HTML document to convert.
Public propertyRenderedHtmlElementSelector
Get or set the CSS selector of the HTML element to be rendered by the HTML to PDF element converter. If the selector selects multiple HTML elements, only the the first one will be converted. The CSS selector is case sensitive. If this property is not set then the entire HTML document is rendered
Public propertyRenderedPagesRectangles
The bounds of the rectangle rendered in each PDF page by the HTML to PDF element. This property is assigned after the element has been added to a PDF page.
Public propertyShowFooterInEvenPages
Gets or sets a flag indicating if the footer is displayed in the even pages of the PDF document where this element is rendered
Public propertyShowFooterInOddPages
Gets or sets a flag indicating if the footer is displayed in the odd pages of the PDF document where this element is rendered
Public propertyShowHeaderInEvenPages
Gets or sets a flag indicating if the header is displayed in the even pages of the PDF document where this element is rendered
Public propertyShowHeaderInOddPages
Gets or sets a flag indicating if the header is displayed in the odd pages of the PDF document where this element is rendered
Public propertyStackRepeatedTableFooters
Get or sets a flag indicating if the repeated HTML table footers are stacked at the bottom of the PDF page when multiple HTML tables have repeated footers on that PDF page. Default value is true
Public propertyStackRepeatedTableHeaders
Get or sets a flag indicating if the repeated HTML table headers are stacked at the top of the PDF page when multiple HTML tables have repeated headers on that PDF page. Default value is true
Public propertyStretchToFit
This property has effect in HTML to PDF element only when FitWidth property is true. When FitWidth is true and this property is true the HTML content will be stretched if necessary to fit the available width in PDF page. By default this property is false and the content will not be stretched to fit the available width in PDF page.
Public propertySvgFontsEnabled
Gets or sets a flag indicating if the SVG fonts are enabled in the HTML to PDF element converter. The default value is false
Public propertyTableFooterRepeatEnabled
Get or sets a flag indicating if the repeating of the HTML table footer in PDF pages generated by the HTML to PDF element is enabled. Default value is true
Public propertyTableHeaderRepeatEnabled
Get or sets a flag indicating if the repeating of the HTML table header in PDF pages generated by the HTML to PDF element is enabled. Default value is true
Public propertyTableOfContentsEnabled
Get or sets a flag indicating if this HTML to PDF element can contribute to the PDF document table of contents. The PDF document table of contents is controlled by TableOfContents property. Default value is true
Public propertyTiledRenderingEnabled
A flag indicating if rendering of HTML document is tiled in HTML to PDF element. This property is true by default
Public propertyTopSpacing
A space in points to introduce at the top of PDF pages where the HTML element is rendered. 1 point is 1/72 inch. By default the top spacing is 0.
Public propertyTransparentImagesEnabled
A flag indicating if the HTML to PDF element converter uses transparency information of the images. The default property value is true
Public propertyTriggeringMode
The conversion triggering mode used by HTML to PDF element converter. The default value is Auto.
Public propertyUrl
Gets or sets the URL of the HTML document to be converted to PDF
Public propertyWebFontsEnabled
Gets or sets a flag indicating if the Web Fonts are enabled in the HTML to PDF element converter. The default value is true
Public propertyWidth
Gets or sets the destination width in points of the rendered content. If the specified width is less or equal to 0, the destination width will be given by the available width in page
Public propertyX
Gets or sets the x position in points where the rendered content will be placed in PDF page
Public propertyXPSupplementalLanguages
A flag in HTML to PDF element indicating if the supplemental languages (complex script, right-to-left, East Asian) support was enabled in Windows XP Regional and Language Options. The default value is false.
Public propertyY
Gets or sets the y position in points where the rendered content will be placed in PDF page
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRotate
Rotates the coordinate system axes clockwise by the specified angle before rendering the element. The coordinates of the element are relative to the rotated coordinates system.
(Inherited from PageGraphicElement.)
Public methodScale
Scales the coordinates so that 1 unit in the horizontal and vertical dimensions of the new coordinate system is the same size as sx and sy units, respectively, in the previous coordinate system.
(Inherited from PageGraphicElement.)
Public methodSkew
Skews the x axis by an skewXAngle and the y axis by an skewYAngle before rendering the element.
(Inherited from PageGraphicElement.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTranslate
Translates the coordinate system before rendering the element. The coordinates of the element are relative to the translated coordinate system.
(Inherited from PageGraphicElement.)
Top
Fields

  NameDescription
Public fieldStatic memberAUTO_HTML_VIEWER_HEIGHT_PX
The default virtual browser height in pixels is set to autodetect the HTML content height.
Public fieldStatic memberAUTO_PDF_HEIGHT_POINTS
The default width in PDF of the element is set to available width in PDF page.
Public fieldStatic memberAVAILABLE_PDF_WIDTH_POINTS
The default width in PDF of the element is set to available width in PDF page.
Public fieldStatic memberDEFAULT_HTML_VIEWER_WIDTH_PX
The default virtual browser width in pixels
Top
See Also

Reference