CodecsHtmlEngine Enumeration

Summary

The HTML engine to use when rendering HTML files.

Syntax

C++/CLI

Python

public enum CodecsHtmlEngine

public: 
   enum class CodecsHtmlEngine sealed

class CodecsHtmlEngine(Enum): 
   Auto = 0 
   IE = 1 
   WebKit = 2

Members

Value	Member	Description
0	Auto	Use the default engine for the platform
1	IE	Use Internet Explorer
2	WebKit	Use the WebKit rendering engine (requires additional download)

Remarks

LEADTOOLS currently supports the following HTML rendering engines:

IE (Internet Explorer)

This engine uses the default Internet Explorer rendering engine that comes with the Windows operating system.

This engine is only supported by the Windows platform.

WebKit Requires additional download

This engine uses the WebKit rendering engine. For more information, refer to WebKit Rendering Engine Support.

This engine is supported by the Windows, Linux and macOS platforms.

Auto

The following behavior occurs when Auto (the default value) is used:

Windows: LEADTOOLS will search for Leadtools.WebKitEngine/ltWebKitEngine and wkhtmltox.dll/so. If found, then WebKit is used. Otherwise, IE is used.

Linux/macOS: Will always search for ltWebKitEngine and wkhtmltox.so. If not found, then loading of HTML is not supported.

Example

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
 
public void CodecsHtmlOptions_Example() 
{ 
   using (RasterCodecs codecs = new RasterCodecs()) 
   { 
      // Use the default HTML rendering engine - CodecsHtmlOptions & CodecsHtmlLoadOptions reference 
      codecs.Options.Html.Load.HtmlEngine = CodecsHtmlEngine.Auto; 
      // Set the HTML options to only allow loading resources from the leadtools.com domain: 
      codecs.Options.Html.Load.DomainWhitelist = "leadtools.com"; 
      // Disable all JavaScript embedded in the HTML file 
      codecs.Options.Html.Load.EnableJS = false; 
      // Load the image 
      using (RasterImage image = codecs.Load("file.html", 1)) 
      { 
         // Do something with image 
      } 
   } 
}

Requirements

Target Platforms

Reference

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 22.0.2023.5.5

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies