The HtmlToImageElement type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| HtmlToImageElement(String) |
Creates a URL to image 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.
| |
| HtmlToImageElement(String, String) |
Creates a HTML string to image converter element that will be rendered at the (0,0) location in PDF page using a base URL to resolve the external resources.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
| |
| HtmlToImageElement(Single, Single, String) |
Creates a URL to image 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.
| |
| HtmlToImageElement(Single, Single, Single, String) |
Creates a URL to image converter element at the specified x and y coordinates with the specified
width. The height in PDF is auto determined.
| |
| HtmlToImageElement(Single, Single, String, String) |
Creates a HTML string to image converter element at the specified x and y coordinates in PDF page using a base URL to resolve the external resources.
The width of element in PDF page is the available width in PDF page and the height is auto determined.
| |
| HtmlToImageElement(Single, Single, Single, Single, String) |
Creates a URL to image converter element at the specified x and y coordinates with the specified
width and height.
| |
| HtmlToImageElement(Single, Single, Single, String, Int32) |
Creates a URL to image 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.
| |
| HtmlToImageElement(Single, Single, Single, String, String) |
Creates a HTML string to image converter element at the specified x and y coordinates with the specified
width using a base URL to resolve the external resources. The height in PDF is auto determined.
| |
| HtmlToImageElement(Single, Single, Single, Single, String, String) |
Creates a HTML string to image converter element at the specified x and y coordinates with the specified
width and height using a base URL to resolve the external resources.
| |
| HtmlToImageElement(Single, Single, Single, String, String, Int32) |
Create a HTML string to image converter element at the specified x and y coordinates with the specified
width using a base URL to resolve the external resources. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.
| |
| HtmlToImageElement(Single, Single, Single, Single, String, Int32, Int32) |
Create a URL to image converter element at the specified x and y coordinates with the specified
width and height. The virtual browser width and height in pixels are specified by the
htmlViewerWidth and htmlViewerHeight paramenters.
| |
| HtmlToImageElement(Single, Single, Single, Single, String, Int32, Int32, String) |
Create a URL to image 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 paramenters.
| |
| HtmlToImageElement(Single, Single, Single, Single, String, String, Int32, Int32) |
Creates a HTML string to image converter element at the specified x and y coordinates with the specified
width and height using a base URL to resolve the external resources. The virtual browser width and height in pixels is specified by
the htmlViewerWidth and htmlViewerHeight parameters.
| |
| HtmlToImageElement(Single, Single, Single, Single, String, String, String, Int32, Int32) |
Creates a HTML string to image 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.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) | |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Rotate |
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.) | |
| Scale |
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.) | |
| Skew |
Skews the x axis by an skewXAngle and the y axis by an skewYAngle
before rendering the element.
(Inherited from PageGraphicElement.) | |
| ToString | (Inherited from Object.) | |
| Translate |
Translates the coordinate system before rendering the element.
The coordinates of the element are relative to the translated coordinate system.
(Inherited from PageGraphicElement.) |
Fields
| Name | Description | |
|---|---|---|
| AUTO_HTML_VIEWER_HEIGHT_PX |
The default virtual browser height in pixels is set to autodetect the HTML content height.
| |
| AUTO_PDF_HEIGHT_POINTS |
The default width in PDF of the element is set to available width in PDF page.
| |
| AVAILABLE_PDF_WIDTH_POINTS |
The default width in PDF of the element is set to available width in PDF page.
| |
| DEFAULT_HTML_VIEWER_WIDTH_PX |
The default virtual browser width in pixels
|
Properties
| Name | Description | |
|---|---|---|
| AuthenticationOptions |
This property 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 Image element. They can be used for example to resolve the IIS Integrated Windows Authentication
or other types of IIS authentication.
| |
| BackColor |
Gets or sets element background color.
(Inherited from PageGraphicElement.) | |
| Blending |
Gets or sets blending mode for transparent rendering mode of the element.
(Inherited from PageGraphicElement.) | |
| ClipHtmlView |
If the HTML content is not entirely visible in the HTML viewer of the HTML to Image 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.
| |
| ClipRectangle |
The clip rectangle applied when the element is rendered in PDF
(Inherited from PageGraphicElement.) | |
| ConversionDelay |
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 Image element.
| |
| DownloadAllResources |
Gets or sets a flag indicating if the HTML to Image element should try to download all the resources even if this could cause
a slower conversion. The default value is false
| |
| EvoInternalFileName |
Sets the full path of evointernal.dat helper file of the HTML to Image element. By default this file is expected to be found
in the same folder with evohtmltopdf.dll assembly.
| |
| ExtensionsEnabled |
Gets or sets a flag indicating if the HTML viewer extensions are executed in the HTML to Image element converter. The default value is false and no extension is executed.
The Flash player for Google Chrome must be installed in order to execute the flash content from HTML
| |
| FitHeight |
When this property is true the resulted image will be resized if necessary to fit the available height in PDF page.
By default this property is false.
| |
| FitWidth |
When this property is true the resulted image will be resized if necessary to fit the available width in PDF page.
When false the image will be rendered at the real size. By default this property is true and
the image will be resized if necessary to fit the available width in PDF page
| |
| ForeColor |
Gets or sets the element foreground color.
(Inherited from PageGraphicElement.) | |
| Gradient |
The gradient used to fill a shape.
(Inherited from PageGraphicElement.) | |
| HtmlDocumentInfo |
Gets an object populated after conversion with the title, keywords, and description of the converted HTML document rendered by the HTML to Image element.
| |
| HtmlElementsMappingOptions |
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 Image 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.
| |
| HtmlViewerHeight |
Gets or sets the HTML viewer height in pixels of the HTML to Image 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 HtmlToImageElement 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 HtmlToImageElement class contructor. The default value is 0 to automatically determine
the HTML viewer height based on the HTML content and the HTML viewer width.
| |
| HtmlViewerWidth |
Gets or sets the preferred HTML viewer width in pixels of the HTML to Image 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 HtmlToImageElement class constructor. The default value is 1024 pixels.
| |
| HttpPostFields |
Returns the collection of HTTP POST fields to be used when accessing a web page in HTML to Image 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
| |
| HttpRequestCookies |
Gets a collection of custom HTTP cookies to be sent by the HTML to Image 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 the collection using the Add(String, String) method of the HttpRequestCookies property.
| |
| HttpRequestHeaders |
Gets a collection of custom HTTP headers to be sent by the HTML to Image 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 the collection using the Add(String, String) method of the HttpRequestHeaders property.
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 referer or any other
HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpRequestCookies property.
| |
| ImagePartSize |
Gets or sets the maximum height in pixels of an image part in HTML to Image element
| |
| ImpersonationOptions |
The impersonation options applied during navigation in HTML to Image element
| |
| InitialHtmlViewerHeight |
Gets or sets the initial height in pixels of the HTML viewer in HTML to Image element.
This value of this property is ignored if the HtmlViewerHeight property is set
| |
| InternalLinksEnabled |
When true this options instructs the HTML to Image element converter to convert the internal HTML links to internal PDF links.
The default value is true.
| |
| InterruptSlowJavaScript |
Gets or sets a flag indicating if the slow JavaScript script should be interrupted in HTML to Image element converter. The default value is false and the scripts are not interrupted
| |
| JavaScriptEnabled |
A flag indicating if JavaScript execution is enabled in the HTML to Image element converter.
The default is true.
| |
| LineStyle |
Gets or sets the line style for elements rendering lines.
(Inherited from PageGraphicElement.) | |
| LiveUrlsEnabled |
When true this options instructs the HTML to Image element converter to convert the HTML links to PDF links.
The default value is true.
| |
| MaxHtmlViewerHeight |
Gets or sets the maximum height in pixels to be rendered from the HTML document by the HTML to Image element.
The default value is 0 and the entire HTML document is rendered
| |
| MediaType |
Gets or sets the media type of the HTML document used by the HTML to Image 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
| |
| MinHtmlViewerHeight |
Gets or sets the minimum height in pixels to be rendered from HTML document by the HTML to Image element.
This value of this property is ignored if the HtmlViewerHeight property is set
| |
| NavigationTimeout |
The HTML to Image element converter navigation timeout in seconds. Default value is 60.
| |
| Opacity |
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.) | |
| Paginate |
When this property is true the HTML to Image element can be paginated to render many PDF pages if necessary.
| |
| PdfBookmarkOptions |
Gets a reference to the object controlling the bookmarks creation in PDF for the HTML to Image 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.
| |
| PersistentHttpRequestHeaders |
This property can be set on true to instruct the HTML to Image 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.
| |
| PrerenderEnabled |
Gets or sets a flag indicating if the HTML to Image element should perform a pre-rendering. The default value is true
| |
| ProxyOptions |
Gets a reference to an object encapsulating the proxy options used by the HTML to Image element to access the HTML document to convert.
| |
| RenderedHtmlElementSelector |
Get or set the CSS selector of the HTML element to be rendered by the HTML to Image element. 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
| |
| RenderedPagesRectangles |
The bounds of the rectangle rendered in each PDF page by the HTML to Image element. This property is assigned
after the element has been added to a PDF page.
| |
| Rotated |
A flag to indicate if this element was rotated.
(Inherited from PageGraphicElement.) | |
| Scaled |
A flag to indicate if this element was scaled.
(Inherited from PageGraphicElement.) | |
| Skewed |
A flag to indicate if this element was skewed.
(Inherited from PageGraphicElement.) | |
| StretchToFit |
This property has effect in HTML to Image 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.
| |
| SvgFontsEnabled |
Gets or sets a flag indicating if the SVG fonts are enabled in HTML in the HTML to Image element converter. The default value is true
| |
| Translated |
A flag to indicate if this element was translated.
(Inherited from PageGraphicElement.) | |
| TriggeringMode |
The conversion triggering mode used by the HTML to Image element converter. The default value is Auto
| |
| WebFontsEnabled |
Gets or sets a flag indicating if the Web Fonts are enabled in HTML in the HTML to Image element converter. The default value is true
| |
| XPSupplementalLanguages |
A flag in HTML to Image 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.
|
Events
| Name | Description | |
|---|---|---|
| AfterRenderPdfPageEvent |
The event is raised right after the HTML to Image element finished PDF page rendering. The PDF page configuration like
size, orientation, header or footer is already defined and cannot be changed.
In the handler of this event PDF elements can be added in the foreground of the rendered PDF page.
| |
| BeforeRenderPdfPageEvent |
The event is raised right before the page is rendered by HTML to Image element. The PDF page configuration like
size, orientation, header or footer is already defined and cannot be changed.
In the handler of this event PDF elements can be added in the background of the PDF page to be rendered.
| |
| PrepareRenderPdfPageEvent |
The event is raised after the HTML to Image element created the PDF page and before starting rendering it.
In the handler of this event the PDF page configuration like size, orientation, header or footer can still be changed
before starting rendering.
|