HtmlToImageConverter Class

NReco.ImageGenerator (HTML-to-Image) Class Library
Html to Image converter (wrapper for WkHtmlToImage command line tool)
Inheritance Hierarchy

SystemObject
  NReco.ImageGeneratorHtmlToImageConverter

Namespace:  NReco.ImageGenerator
Assembly:  NReco.ImageGenerator (in NReco.ImageGenerator.dll) Version: 1.1.1.0 (1.1.1.0)
Syntax

public class HtmlToImageConverter

The HtmlToImageConverter type exposes the following members.

Constructors

  NameDescription
Public methodHtmlToImageConverter
Create new instance of HtmlToImageConverter.
Top
Properties

  NameDescription
Public propertyCustomArgs
Get or set custom WkHtmlToImage command line arguments
Public propertyExecutionTimeout
Get or set maximum execution time for running WkHtmlToImage process (null is by default = no timeout)
Public propertyHeight
Get or set minimum image height (default 0: in this case height is calculated automatically)
Public propertyProcessPriority
Get or set WkHtmlToImage process priority (Normal by default)
Public propertyToolPath
Get or set path where WkHtmlToImage tool is located
Public propertyWidth
Get or set minimum image width
Public propertyWkHtmlToImageExeName
Get or set WkHtmlToImage tool executive file name ('wkhtmltoimage.exe' by default)
Public propertyZoom
Get or set zoom factor
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 methodGenerateImage(String, String)
Generate image by specifed HTML content
Public methodGenerateImage(String, String, Stream)
Generate image by specfied HTML content and write output into output stream
Public methodGenerateImageFromFile(String, String)
Generate image for specified HTML file path or URL
Public methodGenerateImageFromFile(String, String, Stream)
Generate image for specified HTML file or URL and write resulting image to output stream
Public methodGenerateImageFromFile(String, String, String)
Generate image for specified HTML file or URL and write resulting image to output file
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 methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventLogReceived
Occurs when log line is received from WkHtmlToImage process.
Top
See Also

Reference