HtmlDocumentOptions Class

C#
Visual Basic
WinRT C#
Java
Objective-C
WinRT JavaScript
C++

[DataContractAttribute()]
[SerializableAttribute()]
public class HtmlDocumentOptions : DocumentOptions

'Declaration

<DataContractAttribute()>
<SerializableAttribute()>
Public Class HtmlDocumentOptions 
   Inherits DocumentOptions

'Usage

Dim instance As HtmlDocumentOptions

public sealed class HtmlDocumentOptions : DocumentOptions

public class HtmlDocumentOptions extends DocumentOptions

function Leadtools.Forms.DocumentWriters.HtmlDocumentOptions()

[DataContractAttribute()]
[SerializableAttribute()]
public ref class HtmlDocumentOptions : public DocumentOptions

The options set in the HtmlDocumentOptions class will be used when the user saves a document using the DocumentFormat.Html format.

To change the options used with the DOC format, perform the following steps:

Use the DocumentWriter.GetOptions method of the DocumentWriter object being used. Passing DocumentFormat.Html to the format parameter. Note that the resulting object from the base DocumentOptions class needs to be cast to HtmlDocumentOptions.
Use the various HtmlDocumentOptions properties to change the options.
Use DocumentWriter.SetOptions to set the new options in the engine.
Now you can call the DocumentWriter.BeginDocument method (with DocumentFormat.Html for the format parameter) to create a new document and add the pages.

The HtmlDocumentOptions class contains the following properties:

Property	Description
DocumentType	The type of the HTML document (Internet Explorer or Netscape compatible).
FontEmbedMode	Control how the fonts are embedded in the final document created by the LEADTOOLS Document Writer.
UseBackgroundColor and BackgroundColor	Controls the background color in the final HTML document.

Note that this format does not support calling DocumentWriter.InsertPage.

This example will create a new HyperText Markup Language document (HTML) file using the various supported options.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools.Forms.DocumentWriters
Imports Leadtools
Imports Leadtools.Codecs

      
Public Sub HtmlDocumentOptionsExample()
   Dim inputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf")
   Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Example.html")
   ' Setup a new RasterCodecs object
   Dim codecs As New RasterCodecs()
   codecs.Options.RasterizeDocument.Load.Resolution = 300

   ' Get the number of pages in the input document
   Dim pageCount As Integer = codecs.GetTotalPages(inputFileName)

   ' Create a new instance of the LEADTOOLS Document Writer
   Dim docWriter As New DocumentWriter()

   ' Change the HTML options
   Dim htmlOptions As HtmlDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Html), HtmlDocumentOptions)
   htmlOptions.DocumentType = HtmlDocumentType.IENetscape
   htmlOptions.FontEmbedMode = DocumentFontEmbedMode.None
   htmlOptions.UseBackgroundColor = True
   htmlOptions.BackgroundColor = RasterColor.FromKnownColor(RasterKnownColor.LightBlue)
   docWriter.SetOptions(DocumentFormat.Html, htmlOptions)

   ' Create a new HTML document
   Console.WriteLine("Creating new HTML document: {0}", outputFileName)
   docWriter.BeginDocument(outputFileName, DocumentFormat.Html)

   ' Loop through all the pages
   For pageNumber As Integer = 1 To pageCount
      ' Get the page as SVG
      Console.WriteLine("Loading page {0}", pageNumber)
      Dim page As New DocumentSvgPage()
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, Nothing)

      ' Add the page
      Console.WriteLine("Adding page {0}", pageNumber)
      docWriter.AddPage(page)

      page.SvgDocument.Dispose()
   Next

   ' Finally finish writing the HTML file on disk
   docWriter.EndDocument()
   codecs.Dispose()
End Sub

using Leadtools.Forms.DocumentWriters;
using Leadtools;
using Leadtools.Codecs;

public void HtmlDocumentOptionsExample()
{
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf");
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.html");
   // Setup a new RasterCodecs object
   var codecs = new RasterCodecs();
   codecs.Options.RasterizeDocument.Load.Resolution = 300;

   // Get the number of pages in the input document
   var pageCount = codecs.GetTotalPages(inputFileName);

   // Create a new instance of the LEADTOOLS Document Writer
   var docWriter = new DocumentWriter();

   // Change the HTML options
   var htmlOptions = docWriter.GetOptions(DocumentFormat.Html) as HtmlDocumentOptions;
   htmlOptions.DocumentType = HtmlDocumentType.IENetscape;
   htmlOptions.FontEmbedMode = DocumentFontEmbedMode.None;
   htmlOptions.UseBackgroundColor = true;
   htmlOptions.BackgroundColor = RasterColor.FromKnownColor(RasterKnownColor.LightBlue);
   docWriter.SetOptions(DocumentFormat.Html, htmlOptions);

   // Create a new HTML document
   Console.WriteLine("Creating new HTML document: {0}", outputFileName);
   docWriter.BeginDocument(outputFileName, DocumentFormat.Html);

   // Loop through all the pages
   for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++)
   {
      // Get the page as SVG
      Console.WriteLine("Loading page {0}", pageNumber);
      var page = new DocumentSvgPage();
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null);

      // Add the page
      Console.WriteLine("Adding page {0}", pageNumber);
      docWriter.AddPage(page);

      page.SvgDocument.Dispose();
   }

   // Finally finish writing the HTML file on disk
   docWriter.EndDocument();
   codecs.Dispose();
}

Target Platforms

Reference

HtmlDocumentOptions Members
Leadtools.Forms.DocumentWriters Namespace
DocumentWriter Class
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features