The ImgConverter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | ImgConverter()()()() |
Creates a HTML to Image converter using the default width and height for the HTML viewer.
The default HTML viewer width is 1024 pixels and the default HTML viewer height is 0 which means
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.
If the HTML content is not entirely visible in the HTML viewer at the default width of 1024 pixels, 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 width and height of the HTML viewer can also be controlled by the HtmlViewerWidth and HtmlViewerHeight properties
of the ImgConverter class.
|
| ImgConverter(Int32) |
Creates a HTML to Image converter using the specified width in pixels and the default height for the HTML viewer.
The default HTML viewer height is 0 which means 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.
If the 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 width and height of the HTML viewer can also be controlled by the HtmlViewerWidth and HtmlViewerHeight properties
of the ImgConverter class.
|
| ImgConverter(Int32, Int32) |
Creates a HTML to Image converter using the specified width and height in pixels for the HTML viewer.
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.
If the 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 width and height of the HTML viewer can also be controlled by the HtmlViewerWidth and HtmlViewerHeight properties
of the ImgConverter class.
|
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.) |
| GetImageBytesFromHtmlFile |
Gets binary format of an image generated from the specified HTML file in the
the specified ImageFormat format. The bytes can be further written in
any stream like a disk file or a web response.
|
| GetImageBytesFromHtmlStream(Stream, Encoding, ImageFormat) |
Gets binary format of an image generated from the specified HTML stream in the
the specified ImageFormat format. The bytes can be further written in
any stream like a disk file or a web response.
|
| GetImageBytesFromHtmlStream(Stream, Encoding, ImageFormat, String) |
Gets binary format of an image generated from the specified HTML stream in the
the specified ImageFormat format using a base URL to resolve the external resources. The urlBase parameter allows the converter to
determine the full URLs from relative URLs for images and CSS files appearing
in the HTML code from htmlString parameter.
The bytes can be further written in any stream like a disk file or a web response.
|
| GetImageBytesFromHtmlString(String, ImageFormat) |
Gets binary format of an image generated from the specified HTML string in the
the specified ImageFormat format. The bytes can be further written in
any stream like a disk file or a web response.
|
| GetImageBytesFromHtmlString(String, ImageFormat, String) |
Gets binary format of an image generated from the specified HTML string in the
the specified ImageFormat format using a base URL to resolve the external resources. The bytes can be further written in
any stream like a disk file or a web response. The urlBase parameter allows the converter to
determine the full URLs from relative URLs for images and CSS files appearing
in the HTML code from htmlString parameter.
|
| GetImageBytesFromUrl |
Gets binary format of an image generated from the specified URL in the
the specified ImageFormat format. The bytes can be further written in
any stream like a disk file or a web response.
|
| GetImageFromHtmlString(String) |
Gets an Image object from the specified HTML string.
|
| GetImageFromHtmlString(String, String) |
Gets an Image object from the specified HTML string.
The urlBase parameter allows the converter to
determine the full URLs from relative URLs for images and CSS files appearing
in the HTML code from htmlString parameter
|
| GetImageFromHtmlString(String, String, String) |
Gets an Image object from the specified HTML string.
The urlBase parameter allows the converter to
determine the full URLs from relative URLs for images and CSS files appearing
in the HTML code from htmlString parameter.
|
| GetImageFromUrl |
Gets an Image object from the specified URL
|
| GetImageTilesFromHtmlString(String) |
Gets an array of System.Drawing.Image objects from the specified HTML string.
The image is tiled to avoid working with very large images in memory
|
| GetImageTilesFromHtmlString(String, String) |
Gets an array of Image objects from the specified HTML string.
The image is tiled to avoid working with very large images in memory.
The urlBase parameter allows the converter to
determine the full URLs from relative URLs for images and CSS files appearing
in the HTML code from htmlString parameter
|
| GetImageTilesFromHtmlString(String, String, String) |
Gets an array of Image objects from the specified HTML string.
The image is tiled to avoid working with very large images in memory.
The urlBase parameter allows the converter to
determine the full URLs from relative URLs for images and CSS files appearing
in the HTML code from htmlString parameter.
|
| GetImageTilesFromUrl |
Gets an array of Image objects from the specified URL.
The image is tiled to avoid working with very large images in memory
|
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| SaveImageFromHtmlFileToFile |
This method produces a image from the specified HTML file in the specified format
and saves the image in the specified disk file. The existing file will be
overwritten
|
| SaveImageFromHtmlStreamToFile(Stream, Encoding, ImageFormat, String) |
This method produces a image from the specified HTML stream in the specified format
and saves the image in the specified disk file. The existing file will be
overwritten
|
| SaveImageFromHtmlStreamToFile(Stream, Encoding, ImageFormat, String, String) |
This method produces a image from the specified HTML stream in the specified format using a base URL to resolve the external resources
and saves the image in the specified disk file. The existing file will be overwritten
|
| SaveImageFromHtmlStringToFile(String, ImageFormat, String) |
This method produces a image from the specified HTML string in the specified format
and saves the image in the specified disk file. The existing file will be
overwritten
|
| SaveImageFromHtmlStringToFile(String, ImageFormat, String, String) |
This method produces a image from the specified HTML string in the specified format using a base URL to resolve the external resources
and saves the image in the specified disk file. The existing file will be overwritten
|
| SaveImageFromUrlToFile |
This method produces a image from the specified URL in the specified format
and saves the image in the specified disk file. The existing file will be
overwritten
|
| ToString | (Inherited from Object.) |
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 converter. They can be used for example to resolve the IIS Integrated Windows Authentication
or other types of IIS authentication.
|
| ClipHtmlView |
If the HTML content is not entirely visible in the HTML viewer of the HTML to Image converter 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.
|
| 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 converter.
|
| DownloadAllResources |
Gets or sets a flag indicating if the HTML to Image converter 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 converter. 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 during the HTML to Image conversion. 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
|
| HtmlViewerHeight |
Gets or sets the HTML viewer height in pixels in the HTML to Image converter.
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.
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 ImgConverter 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 in the HTML to Image converter.
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 ImgConverter 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 the HTML to Image converter.
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 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 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 converter
|
| ImpersonationOptions |
The impersonation options applied during navigation in HTML to Image converter
|
| InitialHtmlViewerHeight |
Gets or sets the initial height in pixels of the HTML viewer in HTML to Image converter.
This value of this property is ignored if the HtmlViewerHeight property is set
|
| InterruptSlowJavaScript |
Gets or sets a flag indicating if the slow JavaScript script should be interrupted in HTML to Image converter. The default value is false and the scripts are not interrupted
|
| JavaScriptEnabled |
A flag indicating if JavaScript execution is enabled in HTML to Image converter.
The default is true.
|
| LicenseKey |
Gets or sets the license key string received from the vendor in HTML to Image converter.
If this property is null the converter will automatically enter in evaluation mode
and a demo watermark will be displayed on the generated image.
|
| MaxHtmlViewerHeight |
Gets or sets the maximum height in pixels to be rendered from the HTML document by the HTML to Image converter.
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 converter. 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 converter.
This value of this property is ignored if the HtmlViewerHeight property is set
|
| NavigationTimeout |
The HTML to Image converter navigation timeout in seconds. Default value is 60.
|
| PersistentHttpRequestHeaders |
The PersistentHttpRequestHeaders property can be set on true to instruct the HTML to Image 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 converter should perform a pre-rendering. The default value is true
|
| ProxyOptions |
Gets a reference to an object encapsulating the proxy options used by HTML to Image converter 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 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
|
| SvgFontsEnabled |
Gets or sets a flag indicating if the SVG fonts are enabled in HTML during HTML to Image conversion. The default value is true
|
| TransparentBackground |
Gets or sets a flag indicating if the resulted image will have a transparent background when converting a HTML documement without a defined background color or image.
This property is false by default
|
| TriggeringMode |
The conversion triggering mode used by the HTML to Image converter. The default value is Auto
|
| WebFontsEnabled |
Gets or sets a flag indicating if the Web Fonts are enabled in HTML during the HTML to Image conversion. The default value is true
|
| XPSupplementalLanguages |
A flag in HTML to Image converter 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.
|
