Enabled Property

Summary

Enables or disables the LEADTOOLS Txt codec.

Syntax

Objective-C

C++/CLI

Java

Python

public bool Enabled { get; set; }

@property (nonatomic, assign) BOOL enabled;

public boolean isEnabled() 
public void setEnabled(boolean enabled)

public: 
property bool Enabled { 
   bool get(); 
   void set (    bool ); 
}

Enabled # get and set (CodecsTxtLoadOptions)

Property Value

Value	Description
true	To enable the LEADTOOLS Txt codecs (Leadtools.Codecs.Txt.dll).
false	To disable the LEADTOOLS Txt codecs (Leadtools.Codecs.Txt.dll). The default value is false.

Remarks

When this property is set to false, LEADTOOLS will not attempt to load TEXT files and rasterize them and the Leadtools.Codecs.Txt codecs will not be used.

Enabling the TEXT code will generally hinder performance when the RasterCodecs object is attempting to load a file on disk with a wrong or missing a file header.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
using Leadtools.Pdf; 
 
public void CodecsTxtOptionsExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "test.txt"); 
 
   // 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; 
 
   // CodecsTxtOptions & CodecsTxtLoadOptions reference 
   codecs.Options.Txt.Load.BackColor = RasterColor.White; 
   codecs.Options.Txt.Load.FaceName = "Courier New"; 
   codecs.Options.Txt.Load.FontColor = new RasterColor(255, 0, 0); 
   codecs.Options.Txt.Load.Highlight = RasterColor.White; 
   codecs.Options.Txt.Load.FontSize = 12; 
   codecs.Options.Txt.Load.Italic = false; 
   codecs.Options.Txt.Load.Strikethrough = false; 
   codecs.Options.Txt.Load.Underline = false; 
   codecs.Options.Txt.Load.Bold = true; 
   codecs.Options.Txt.Load.Enabled = true; 
   codecs.Options.Txt.Load.TabSize = 8; 
 
   RasterImage image = codecs.Load(srcFileName); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "txt.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 codecsTxtOptionsExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "Example.txt"); 
 
   // 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); 
 
   // CodecsTxtOptions & CodecsTxtLoadOptions reference 
   codecs.getOptions().getTxt().getLoad().setBackColor(RasterColor.WHITE); 
   codecs.getOptions().getTxt().getLoad().setFaceName("Courier New"); 
   codecs.getOptions().getTxt().getLoad().setFontColor(new RasterColor(255, 0, 0)); 
   codecs.getOptions().getTxt().getLoad().setHighlight(RasterColor.WHITE); 
   codecs.getOptions().getTxt().getLoad().setFontSize(12); 
   codecs.getOptions().getTxt().getLoad().setItalic(false); 
   codecs.getOptions().getTxt().getLoad().setStrikethrough(false); 
   codecs.getOptions().getTxt().getLoad().setUnderline(false); 
   codecs.getOptions().getTxt().getLoad().setBold(true); 
   codecs.getOptions().getTxt().getLoad().setEnabled(true); 
   RasterImage image = codecs.load(srcFileName); 
 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "txt.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

CodecsTxtLoadOptions Class

CodecsTxtLoadOptions Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies