Winnovative HTML to PDF Converter for .NET Core Documentation
Html
This class offers the necessary methods to create a SVG document from a web page at given URL or from a HTML string.
The generated SVG document can be saved into a memory buffer or into a file
Definition
Namespace: Winnovative
Assembly: WnvHtmlToPdf_NetCore (in WnvHtmlToPdf_NetCore.dll) Version: 18.0.0
Assembly: WnvHtmlToPdf_NetCore (in WnvHtmlToPdf_NetCore.dll) Version: 18.0.0
C#
public class HtmlToSvgConverterVB
Public Class HtmlToSvgConverter- Inheritance
- Object HtmlToSvgConverter
- Derived
Constructors
| HtmlToSvgConverter | Creates a HTML to SVG converter using the default width and height for the HTML viewer |
Properties
| 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 SVG 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 SVG 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 of the document to SVG. Default value is 2. |
| DefaultHtmlEncoding | The default HTML document text encoding to be used if there is no charset meta tag defined in the HTML document. By default this property is not set and an auto determined text encoding will be used by converter |
| DownloadAllResources | Gets or sets a flag indicating if the HTML to SVG converter should try to download all the resources even if this could cause a slower conversion. The default value is false. |
| Enable3DTransformations | Gets or sets a flag indicating if the accelerated CSS 3D transformations are enabled in the HTML to SVG converter. The default value is false |
| EnableAccelerated2DCanvas | Gets or sets a flag indicating if the accelerated 2D canvas is enabled in the HTML to SVG converter. The default value is false |
| EnableHttp2 | Gets or sets a flag indicating if the HTTP2 protocol is enabled in HTML to SVG converter. The property has effect only in NE version of the library. The default value is false |
| EnablePersistentStorage | Gets or sets a flag indicating if the persistent local storage is enabled in the HTML to SVG converter. The default value is false |
| EnableWebGL | Gets or sets a flag indicating if the WebGL is enabled in the HTML to SVG converter. The default value is false |
| ExtensionsEnabled | Gets or sets a flag indicating if the HTML viewer extensions are executed in HTML to SVG converter. The default value is false and no extension is executed. The Flash player for Mozilla Firefox must be installed in order to execute the flash content from HTML |
| HtmlViewerHeight | Gets or sets the HTML viewer height in pixels in HTML to SVG 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 HtmlToSvgConverter 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 SVG 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 HtmlToSvgConverter class constructor. The default value is 1024 pixels. |
| HtmlViewerZoom | Gets or sets the HTML viewer zoom percentage in HTML to SVG Converter similar to zoom level in a browser. The default value of this property is 100 |
| HttpPostFields | Returns the collection of HTTP POST fields to be used when accessing a web page in HTML to SVG 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 SVG 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 SVG 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 referrer or any other HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpRequestCookies property. |
| ImpersonationOptions | The impersonation options applied during navigation in the HTML to SVG converter. |
| InitialHtmlViewerHeight | Gets or sets the initial height in pixels of the HTML viewer in HTML to SVG 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 the HTML to SVG converter. The default value is false and the scripts are not interrupted |
| JavaScriptEnabled | A flag indicating if JavaScript execution is enabled in HTML to SVG converter during the HTML to SVG conversion. The default is true. |
| LicenseKey | Gets or sets the license key string received from the vendor when converting HTML to SVG. If this property is null the converter will automatically enter in evaluation mode and a demo watermark will be displayed on the generated image. |
| LocalFilesAccessEnabled | Gets or sets a flag indicating if the access to local files is enabled in the HTML to SVG converter. The default value is true |
| ManualTriggeringConversionDelay | An additional time in seconds to wait after manual triggering before starting the rendering in HTML to SVG converter. Default value is 2. |
| MaxHtmlViewerHeight | Gets or sets the maximum height in pixels to be rendered from the HTML document by HTML to SVG 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 HTML to SVG 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 SVG converter. This value of this property is ignored if the HtmlViewerHeight property is set |
| NavigationTimeout | The HTML to SVG converter navigation timeout in seconds. Default value is 60. |
| NavigatorUserAgent | The custom user agent to be used when accessing the HTML page. When this property is null or empty the default user agent is used |
| OutputResolution | The resolution of the SVG document |
| OutputSize | A flag indicating if the calculated size of the SVG document should be set in the generated document |
| PersistentHttpRequestHeaders | This property can be set on true to instruct the HTML to SVG 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 SVG converter should perform a pre-rendering. The default value is false |
| ProxyOptions | Gets a reference to an object encapsulating the proxy options used by HTML to SVG 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 SVG 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 the HTML to SVG conversion. The default value is false |
| TriggeringMode | The conversion triggering mode used by HTML to SVG converter. The default value is ConversionDelay. |
| WebFontsEnabled | Gets or sets a flag indicating if the Web Fonts are enabled in HTML during the HTML to SVG conversion. The default value is false |
| WnvInternalFileName | Sets the full path of wnvinternal.dat helper file of the HTML to SVG converter. By default this file is expected to be found in the same folder with wnvhtmltopdf.dll assembly. |
Methods
| ConvertHtml | Converts a HTML string into a SVG document using a base URL to resolve the external resources and returns the rendered SVG document into a memory buffer |
| ConvertHtmlToFile | Converts the specified HTML string into a SVG document using a base URL to resolve the external resources and saves the rendered SVG document to the specified file |
| ConvertHtmlToStream | Converts the specified HTML string into a SVG document using a base URL to resolve the external resources and saves the rendered SVG document to the specified stream |
| ConvertUrl | Converts an URL to a SVG document and returns the rendered SVG document into a memory buffer |
| ConvertUrlToFile | Converts the specified URL into a SVG document and saves the rendered SVG document to the specified file. |
| ConvertUrlToStream | Converts the specified URL into a SVG document and saves the rendered SVG document to the specified stream |
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| ToString | (Inherited from Object) |