Provides extra options to use when saving a document using the HyperText Markup Language (HTML) format.
[SerializableAttribute()]
[DataContractAttribute()]
public class HtmlDocumentOptions : DocumentOptions
<DataContractAttribute()>
<SerializableAttribute()>
Public Class HtmlDocumentOptions
Inherits DocumentOptions
public class HtmlDocumentOptions extends DocumentOptions
[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:
The HtmlDocumentOptions class contains the following properties:
Property | Description |
---|---|
EmbedFonts | Indicates whether fonts are to be embedded in the document. |
FontEmbedMode | Control what fonts are embedded in the document. |
FontTypes | Font types to embed in the document. |
EmbedImages | Indicate whether images are to be embedded in the document. |
ImageType | Format to use when saving images in the document. |
EmbedCSS | Indicate whether CSS elements are to be embedded in the document. |
DropObjects | Controls which object types to drop from the document. |
UseBackgroundColor and BackgroundColor | Controls the background color in the 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.
using Leadtools.Document.Writer;
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.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 DocumentWriterSvgPage();
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();
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
Imports Leadtools.Document.Writer
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.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 DocumentWriterSvgPage()
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
Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
Leadtools.Document.Writer Namespace
Programming with LEADTOOLS Document Writers
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.