←Select platform

UseBackgroundColor Property

Summary
Indicates whether the HTML document will use the a background color or not.
Syntax
C#
Objective-C
C++/CLI
Java
Python
public bool UseBackgroundColor { get; set; } 
@property (nonatomic, assign) BOOL useBackgroundColor; 
public boolean getUseBackgroundColor() 
public void setUseBackgroundColor(boolean useBackgroundColor) 
public: 
property bool UseBackgroundColor { 
   bool get(); 
   void set (    bool ); 
} 
UseBackgroundColor # get and set (HtmlDocumentOptions) 

Property Value

true to use the background color in the HTML document; false, otherwise.

Remarks

The HTML format supports adding a background color to the final document. To use a background color, set the value of the UseBackgroundColor property to true and set the color value required in the BackgroundColor property.

If the value of the UseBackgroundColor property is false, then the final document will not contain a background color and the value of the BackgroundColor property will not be used when creating the HTML document.

Example
C#
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 
   Debug.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 
      Debug.WriteLine("Loading page {0}", pageNumber); 
      var page = new DocumentWriterSvgPage(); 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
      // Add the page 
      Debug.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:\LEADTOOLS22\Resources\Images"; 
} 
Requirements

Target Platforms

Help Version 22.0.2023.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Writer Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.