Leadtools.Forms.DocumentWriters Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
HtmlDocumentOptions Class
See Also  Members   Example 
Leadtools.Forms.DocumentWriters Namespace : HtmlDocumentOptions Class



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

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 = LeadtoolsExamples.Common.ImagesPath.Path + "Test.html"
   Dim emfFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "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 = Color.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
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 = LeadtoolsExamples.Common.ImagesPath.Path + "Test.html"; 
   string emfFileName = LeadtoolsExamples.Common.ImagesPath.Path + "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 = Color.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(); 
}

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:
PropertyDescription
HtmlDocumentOptions.DocumentTypeThe type of the HTML document (Internet Explorer or Netscape compatible).
HtmlDocumentOptions.FontEmbedModeControl how the fonts are embedded in the final document created by the LEADTOOLS Document Writer.
HtmlDocumentOptions.UseBackgroundColor and HtmlDocumentOptions.BackgroundColorSet 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 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

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