Html to Image converter (wrapper for WkHtmlToImage command line tool)
Inheritance Hierarchy
NReco.ImageGeneratorHtmlToImageConverter
Namespace: NReco.ImageGenerator
Assembly: NReco.ImageGenerator (in NReco.ImageGenerator.dll) Version: 1.1.1.0 (1.1.1.0)
Syntax
The HtmlToImageConverter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| HtmlToImageConverter |
Create new instance of HtmlToImageConverter.
|
Properties
| Name | Description | |
|---|---|---|
| CustomArgs |
Get or set custom WkHtmlToImage command line arguments
| |
| ExecutionTimeout |
Get or set maximum execution time for running WkHtmlToImage process (null is by default = no timeout)
| |
| Height |
Get or set minimum image height (default 0: in this case height is calculated automatically)
| |
| ProcessPriority |
Get or set WkHtmlToImage process priority (Normal by default)
| |
| ToolPath |
Get or set path where WkHtmlToImage tool is located
| |
| Width |
Get or set minimum image width
| |
| WkHtmlToImageExeName |
Get or set WkHtmlToImage tool executive file name ('wkhtmltoimage.exe' by default)
| |
| Zoom |
Get or set zoom factor
|
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
| GenerateImage(String, String) |
Generate image by specifed HTML content
| |
| GenerateImage(String, String, Stream) |
Generate image by specfied HTML content and write output into output stream
| |
| GenerateImageFromFile(String, String) |
Generate image for specified HTML file path or URL
| |
| GenerateImageFromFile(String, String, Stream) |
Generate image for specified HTML file or URL and write resulting image to output stream
| |
| GenerateImageFromFile(String, String, String) |
Generate image for specified HTML file or URL and write resulting image to output file
| |
| 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.) | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
| LogReceived |
Occurs when log line is received from WkHtmlToImage process.
|
See Also