LEADTOOLS Forms (Leadtools.Forms.DocumentWriters assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
HtmlDocumentOptions Class
See Also  Members  
Leadtools.Forms.DocumentWriters Namespace : HtmlDocumentOptions Class



The HtmlDocumentOptions Class is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

Provides extra options to use when saving a document using the HyperText Markup Language (HTML) format.

Object Model

HtmlDocumentOptions Class

Syntax

Visual Basic (Declaration) 
Public Class HtmlDocumentOptions 
   Inherits DocumentOptions
Visual Basic (Usage)Copy Code
Dim instance As HtmlDocumentOptions
C# 
public class HtmlDocumentOptions : DocumentOptions 
C++/CLI 
public ref class HtmlDocumentOptions : public DocumentOptions 

Example

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

Visual BasicCopy Code
' Windows API functions needed to load/delete an EMF
   <DllImport("gdi32.dll")> _
   Private Shared Function GetEnhMetaFile(ByVal lpszMetaFile As String) As IntPtr
   End Function
   <DllImport("gdi32.dll")> _
   Private Shared Function DeleteEnhMetaFile(ByVal hemf As IntPtr) As Boolean
   End Function

   Private Sub HtmlDocumentOptionsExample()
      ' Unlock the support needed for LEADTOOLS Document Writers (with PDF output)
      RasterSupport.Unlock(RasterSupportType.DocumentWriters, "Replace with your own key here")

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

      Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Test.html")
      Dim emfFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.emf")

      ' Change the HTML options to add a background color
      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)

      ' Use the Windows API to load the EMF
      Dim emfHandle As IntPtr = GetEnhMetaFile(emfFileName)

      ' Add the page
      Dim page As DocumentPage = DocumentPage.Empty
      page.EmfHandle = emfHandle
      page.Image = Nothing

      Console.WriteLine("Adding EMF page from: {0}", emfFileName)
      docWriter.AddPage(page)

      ' Use the Windows API to delete the EMF
      DeleteEnhMetaFile(emfHandle)

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

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
// Windows API functions needed to load/delete an EMF
   [DllImport("gdi32.dll")]
   private static extern IntPtr GetEnhMetaFile(string lpszMetaFile);
   [DllImport("gdi32.dll")]
   private static extern bool DeleteEnhMetaFile(IntPtr hemf);
   private void HtmlDocumentOptionsExample()
   {
      // Unlock the support needed for LEADTOOLS Document Writers (with PDF output)
      RasterSupport.Unlock(RasterSupportType.DocumentWriters, "Replace with your own key here");

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

      string outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Test.html");
      string emfFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.emf");

      // Change the HTML options to add a background color
      HtmlDocumentOptions 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);

      // Use the Windows API to load the EMF
      IntPtr emfHandle = GetEnhMetaFile(emfFileName);

      // Add the page
      DocumentPage page = DocumentPage.Empty;
      page.EmfHandle = emfHandle;
      page.Image = null;

      Console.WriteLine("Adding EMF page from: {0}", emfFileName);
      docWriter.AddPage(page);

      // Use the Windows API to delete the EMF
      DeleteEnhMetaFile(emfHandle);

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

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Remarks

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:

  1. 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.
  2. Use the various HtmlDocumentOptions properties to change the options.
  3. Use DocumentWriter.SetOptions to set the new options in the engine.
  4. 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
HtmlDocumentOptions.DocumentType The type of the HTML document (Internet Explorer or Netscape compatible).
HtmlDocumentOptions.FontEmbedMode Control how the fonts are embedded in the final document created by the LEADTOOLS Document Writer.
HtmlDocumentOptions.UseBackgroundColor and HtmlDocumentOptions.BackgroundColor Set a background color in the final HTML document.

Inheritance Hierarchy

System.Object
   Leadtools.Forms.DocumentWriters.DocumentOptions
      Leadtools.Forms.DocumentWriters.HtmlDocumentOptions

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Forms.DocumentWriters requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features