BackColor Property

Summary

Gets or sets the background color used when rendering RTF documents.

Syntax

Objective-C

C++/CLI

Java

Python

public RasterColor BackColor { get; set; }

@property (nonatomic, copy) LTRasterColor *backColor;

public RasterColor getBackColor() 
public void setBackColor(RasterColor backColor)

public: 
property RasterColor BackColor { 
   RasterColor get(); 
   void set (    RasterColor ); 
}

BackColor # get and set (CodecsRtfLoadOptions)

Property Value

The background color used when rendering RTF documents. Default value is "white". The default value is #FFFFFFFF.

Remarks

Background is the color used to fill the resulting image before rendering the RTF contents on top of it.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
using Leadtools.Pdf; 
 
public void CodecsRtfOptionsExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "test.rtf"); 
 
   // Setting new options. 
   codecs.Options.RasterizeDocument.Load.LeftMargin = 1.00; 
   codecs.Options.RasterizeDocument.Load.TopMargin = 1.25; 
   codecs.Options.RasterizeDocument.Load.PageWidth = 8.50; 
   codecs.Options.RasterizeDocument.Load.PageHeight = 11.00; 
   codecs.Options.RasterizeDocument.Load.BottomMargin = 1.00; 
   codecs.Options.RasterizeDocument.Load.RightMargin = 1.25; 
   codecs.Options.Rtf.Load.BackColor = RasterColor.White; // CodecsRtfOptions & CodecsRtfLoadOptions reference 
 
   RasterImage image = codecs.Load(srcFileName); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "rtf.bmp"), RasterImageFormat.Bmp, image.BitsPerPixel); 
 
   // Clean up 
   image.Dispose(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.nio.file.Paths; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.core.MinMaxBitsCommand; 
 
 
public void codecsRtfOptionsExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Examples\\Forms\\DotNet\\MasterFormsEditor\\src\\Resources"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "Info.rtf"); 
 
   // Setting new options. 
   codecs.getOptions().getRasterizeDocument().getLoad().setLeftMargin(1.00); 
   codecs.getOptions().getRasterizeDocument().getLoad().setTopMargin(1.25); 
   codecs.getOptions().getRasterizeDocument().getLoad().setPageWidth(8.50); 
   codecs.getOptions().getRasterizeDocument().getLoad().setPageHeight(1.00); 
   codecs.getOptions().getRasterizeDocument().getLoad().setBottomMargin(1.00); 
   codecs.getOptions().getRasterizeDocument().getLoad().setRightMargin(1.25); 
   codecs.getOptions().getRtf().getLoad().setBackColor(RasterColor.WHITE); // CodecsRtfOptions & CodecsRtfLoadOptions 
                                                                           // reference 
   RasterImage image = codecs.load(srcFileName); 
 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "rtf.bmp"); 
   codecs.save(image, outputFileName, RasterImageFormat.BMP, image.getBitsPerPixel()); 
 
   assertTrue("File unsuccessfully saved to " + outputFileName, (new File(outputFileName)).exists()); 
   System.out.printf("File successfully saved to %s%n", outputFileName); 
 
   // Clean up 
   image.dispose(); 
   codecs.dispose(); 
}

Requirements

Target Platforms

Reference

CodecsRtfLoadOptions Class

CodecsRtfLoadOptions Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies