GrapeCity.Documents.Html.GcHtmlRenderer
GcHtmlRenderer Class
Provides methods for converting HTML to PDF and images.
This class is deprecated as of GcHtml v6.0.0. While old code that uses this and related classes will continue to work, it is recommended to switch to using the new GcHtmlBrowser class instead. For information on how to convert existing code please see documentation at https://www.grapecity.com/documents-api-pdf/docs/online/render_html_to_pdf.html and https://www.grapecity.com/documents-api-imaging/docs/online/render_html_to_image.html.
Note that the 3 platform-specific packages (GrapeCity.Documents.Html.Windows.X64, GrapeCity.Documents.Html.Linux.X64 and GrapeCity.Documents.Html.Mac.X64) are no longer needed and should be removed from your projects even if you do not convert your code to using GcHtmlBrowser.Implements
Namespace: GrapeCity.Documents.Html
Assembly: DS.Documents.Html.dll
Syntax
[Obsolete("Use GcHtmlBrowser class instead.")]
public class GcHtmlRenderer : IDisposable<Obsolete("Use GcHtmlBrowser class instead.")>
Public Class GcHtmlRenderer
Implements IDisposableConstructors
| Name | Description |
|---|---|
| GcHtmlRenderer(string) | Initializes a new instance of GcHtmlRenderer from HTML string. |
| GcHtmlRenderer(Uri) | Initializes a new instance of GcHtmlRenderer from System.Uri. |
Fields
| Name | Description |
|---|---|
| LastLogMessage | Gets the last log message from the headless Chromium shell. |
Properties
| Name | Description |
|---|---|
| AuthServerWhitelist | Gets or sets a whitelist to passthrough Windows authentication for the specified domains. For example: "*example.com,*foobar.com,*baz". |
| BrowserDestinationFolder | Gets or sets the destination folder for the Chromium downloads. If this property is not set, the downloads are stored to [root]/.local-chromium, where [root] is where the project binaries are located. |
| IsDisposed | Gets a value indicating whether the GcHtmlRenderer has been disposed of. |
| IsSupported | Gets a value indicating if GcHtmlRenderer is available on the current platform. |
| PathToGcHtmlToPdf | Gets or sets the optional path to Chrome, Edge, or Chromium executable to run. |
| ProxyServer | Gets or sets a proxy server, overrides system settings. Affects HTTP and HTTPS requests only. For example: "https://proxy-ip:proxy-port" or "socks5://127.0.0.1:1080". |
| VirtualTimeBudget | Gets or sets the number of milliseconds to wait before deeming the page to be ready. Setting this property to a value greater than 0, activates LoadLazyImages mode. |
| WaitDuration | Gets or sets the maximum navigation time, in milliseconds. Defaults to 180000 ms. |
| WebSocketFactory | Gets or sets the optional factory for WebSocket implementations. For more information, see comments to WebSocketFactory. |
Methods
| Name | Description |
|---|---|
| ApplyGcImagingLicenseKey(string) | Applies a GcImaging license key to use by the current instance of GcHtmlRenderer. Up to five images can be created without a license. |
| ApplyGcPdfLicenseKey(string) | Applies a GcPdf license key to use by the current instance of GcHtmlRenderer. Up to five PDFs can be created without a license. |
| Dispose() | Clean up any resources being used. |
| Dispose(bool) | Performs cleanup operations on managed and unmanaged resources. |
| RenderToGcBitmap(GcBitmap, HtmlToImageFormat) | Renders the source HTML to an existing GcBitmap. |
| RenderToJpeg(Stream, JpegSettings) | Creates a JPEG image from the source HTML and saves it to a specified stream. |
| RenderToJpeg(string, JpegSettings) | Creates a JPEG image file from the source HTML. |
| RenderToPdf(Stream, PdfSettings) | Creates a PDF document from the source HTML and saves it to a specified stream. |
| RenderToPdf(string, PdfSettings) | Creates a PDF file from the source HTML. |
| RenderToPng(Stream, PngSettings) | Creates a PNG image from the source HTML and saves it to a specified stream. |
| RenderToPng(string, PngSettings) | Creates a PNG image file from the source HTML. |
| SetGcImagingLicenseKey(string) | Sets a GcImaging license key to use by all instances of GcHtmlRenderer. Up to five images can be created without a license. |
| SetGcPdfLicenseKey(string) | Sets a GcPdf license key to use by all instances of GcHtmlRenderer. Up to five PDFs can be created without a license. |