ImgConverter Class |
This class offers the necessary API to create images in various formats from
a specified web page
Inheritance HierarchySystemObject
ExpertPdf.HtmlToPdfImgConverter
ExpertPdf.HtmlToPdfImgConverter
Namespace: ExpertPdf.HtmlToPdf
Assembly: ephtmltopdf (in ephtmltopdf.dll) Version: 17.0.0
SyntaxThe ImgConverter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ImgConverter |
Creates an image converter that auto detects the width and height
of the web page
|
| ImgConverter(Int32) |
Creates an image converter for a web page with the specified width and
an autodected height
|
| ImgConverter(Int32, Int32) |
Creates an image converter for a web page with the specified width and height
|
Properties| Name | Description | |
|---|---|---|
 | AddPadding |
Add padding at the end of the conversion result.
Default is false.
|
| AllowLocalAccess |
A flag indicating if local files can be loaded during the conversion. The default value is True and local files can be loaded.
|
| AuthenticationPassword |
Optionally set the Password property to authenticate to web server
before accessing the URL to be converted (e.g handles any IIS authentication method)
|
| AuthenticationUsername |
Optionally set the Username property to authenticate to web server
before accessing the URL to be converted (e.g handles any IIS authentication method)
|
| BinaryBehaviorsEnabled |
Internal use.
Default is false.
|
| BlinkEnginePath |
Gets or sets the full path (excluding the chrome.exe file name) of the Blink html rendering engine binaries.
|
| BlinkEngineTemporaryFilesPath |
Gets or sets the full path of a folder where Blink html rendering engine will write temporary files.
|
| CacheFolder |
Use this property to enable caching of web requests. Sets the full path of the local cache folder.
Note: This is used only by the WebKit rendering engine.
|
| ClickElementsDelayAfter |
Delay in miliseconds, after element click.
|
| ClickElementsDelayBefore |
Delay in miliseconds, before element click.
|
| ClickElementsSelectors |
Specifies elements from the web page that will be clicked before converting the page.
|
| ClipHtmlView |
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.
Note: This is used only by the WebKit rendering engine.
|
| ConversionDelay |
An additional time in seconds to wait for asynchronous items to be loaded
|
| CustomCSS |
Use this property to specify some CSS styles that will be injected into the page that is converted.
|
| ExternalBrowserEndpoint |
External browser service.
|
| HttpCookies |
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.
Note: This is used only by the WebKit rendering engine.
|
| HttpHeaders |
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.
Note: This is used only by the WebKit rendering engine.
|
| InternalFileName |
Sets the full path of the helper file.
Note: This is used only by the WebKit rendering engine.
|
| LazyImagesLoadingDelay |
Delay per page, in miliseconds, for lazy images loading.
|
| LazyImagesLoadingEnabled |
Enables a delay mechanism to allow images to fully load.
|
| LicenseKey |
Gets or sets the license key
|
| LoginOptions |
Handle custom page login.
|
| NavigationTimeout |
The navigation timeout in seconds. Default value is 60.
|
| PageHeight |
Gets or sets the web page height. If the width was not set aswell,
this property has no effect
|
| PageWidth |
Gets or sets the web page width
|
| PluginsEnabled |
A flag indicating if plugins are enabled in converter.
The default is true.
Note: This is used only by the WebKit rendering engine.
|
| PostLoadingScript |
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.
|
| PostLoadingScriptDelayAfter |
Delay in miliseconds, after post page loading javascript injection.
|
| ProxyOptions |
Gets a reference to an object encapsulating the proxy options used to access the HTML document to convert.
Note: This is used only by the WebKit rendering engine.
|
| RenderElementId |
Use this property to convert only a certain section of the page, specified by the html element ID.
Note: This is used only by the WebKit rendering engine.
|
| RenderingEngine |
Gets or sets the rendering engine used by the converter to load and render the html. The possible values are WebKit and IE.
The Webkit rendering engine is internal and renders similar to Chrome and Safari. For IE, the component uses the IE engine from the machine.
|
| SamplingEnabled |
Internal use only
|
| ScriptsEnabled |
Enable scripts when rendering HTML to image.
Default is true.
|
| StartupMode |
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()
Note: This is used only by the WebKit rendering engine.
|
| StartupScript |
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.
Note: This is used only by the WebKit rendering engine.
|
| xDf |
Internal use only
|
Methods| Name | Description | |
|---|---|---|
| GetImageBytesFromHtmlFile |
Gets binary format of an image generated from the specified HTML file in the
the specified System.Drawing.Imaging.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 System.Drawing.Imaging.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 System.Drawing.Imaging.ImageFormat format. 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 System.Drawing.Imaging.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 System.Drawing.Imaging.ImageFormat format. 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 System.Drawing.Imaging.ImageFormat format. The bytes can be further written in
any stream like a disk file or a web response.
|
| GetImageFromHtmlFile |
Gets an System.Drawing.Image object from the specified HTML file in the
the specified System.Drawing.Imaging.ImageFormat format
|
| GetImageFromHtmlStream(Stream, Encoding, ImageFormat) |
Gets an System.Drawing.Image object from the specified HTML stream in the
the specified System.Drawing.Imaging.ImageFormat format
|
| GetImageFromHtmlStream(Stream, Encoding, ImageFormat, String) |
Gets an System.Drawing.Image object from the specified HTML stream in the
the specified System.Drawing.Imaging.ImageFormat format. 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 htmlStream parameter.
|
| GetImageFromHtmlString(String, ImageFormat) |
Gets an System.Drawing.Image object from the specified HTML string in the
the specified System.Drawing.Imaging.ImageFormat format
|
| GetImageFromHtmlString(String, ImageFormat, String) |
Gets an System.Drawing.Image object from the specified HTML string in the
the specified System.Drawing.Imaging.ImageFormat format. 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 System.Drawing.Image object from the specified URL in the
the specified System.Drawing.Imaging.ImageFormat format
|
| GetImageFromUrlBytes | Obsolete.
Gets binary format of an image generated from the specified URL in the
the specified System.Drawing.Imaging.ImageFormat format. The bytes can be further written in
any stream like a disk file or a web response.
|
| 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
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
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
|
See Also