Format Property

Summary

Raster image format to use when saving the document.

Syntax

C++/CLI

Java

Python

public RasterImageFormat Format { get; set; }

public:  
   property RasterImageFormat^ Format 
   { 
      RasterImageFormat^ get() 
      void set(RasterImageFormat^ value) 
   }

public RasterImageFormat getFormat() 
public void setFormat(RasterImageFormat value)

Format # get and set (SaveDocumentOptions)

Property Value

The raster image format to use when saving the document. Default value is RasterImageFormat.Unknown.

Remarks

If the value of Format is the default RasterImageFormat.Unknown, then the document will be saved using the format of the original document.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Barcode; 
using Leadtools.Document.Converter; 
 
public void DocumentSaveToFileExample() 
{ 
   var options = new LoadDocumentOptions(); 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(LEAD_VARS.ImagesDir, "Protected.tif"), options)) 
   { 
      // The document is read-only by default. Ensure that we can modify it 
      document.IsReadOnly = false; 
      var page = document.Pages[1]; 
      var container = page.GetAnnotations(true); 
      var obj = new AnnEllipseObject(); 
      obj.Rect = LeadRectD.Create(0, 0, 1 * 720, 1 * 720); 
      obj.Stroke = AnnStroke.Create(AnnSolidColorBrush.Create("red"), LeadLengthD.Create(1)); 
      container.Children.Add(obj); 
      page.SetAnnotations(container); 
 
      var outName = Path.GetFileName(document.Uri.AbsolutePath).Replace(".", "_") + ".tif"; 
 
      var outFileName = Path.Combine(LEAD_VARS.ImagesDir, outName); 
      if (File.Exists(outFileName)) 
         File.Delete(outFileName); 
 
      var saveOptions = new SaveDocumentOptions(); 
      saveOptions.Format = RasterImageFormat.CcittGroup4; 
      saveOptions.BitsPerPixel = 1; 
      saveOptions.WebClient = null; 
      var annFileName = Path.ChangeExtension(outFileName, ".xml"); 
      if (File.Exists(annFileName)) File.Delete(annFileName); 
      saveOptions.AnnotationsUri = new Uri(annFileName); 
      document.SaveToFile(outFileName, saveOptions); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.FileOutputStream; 
import java.io.IOException; 
import java.net.MalformedURLException; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.net.URL; 
import java.nio.file.Files; 
import java.nio.file.Paths; 
import java.util.ArrayList; 
import java.util.Calendar; 
import java.util.List; 
import java.util.concurrent.Callable; 
import java.util.concurrent.ExecutorService; 
import java.util.concurrent.Executors; 
import java.util.concurrent.Future; 
import java.util.regex.Pattern; 
 
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.annotations.engine.*; 
import leadtools.barcode.*; 
import leadtools.caching.*; 
import leadtools.codecs.*; 
import leadtools.document.*; 
import leadtools.document.DocumentMimeTypes.UserGetDocumentStatusHandler; 
import leadtools.document.converter.*; 
import leadtools.document.writer.*; 
import leadtools.ocr.*; 
 
 
public void documentSaveToFileExample() throws URISyntaxException { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "leadtools.pdf"); 
   LoadDocumentOptions options = new LoadDocumentOptions(); 
   LEADDocument document = DocumentFactory.loadFromFile(srcFileName, options); 
   // The document is read-only by default. Ensure that we can modify it 
   document.setReadOnly(false); 
   DocumentPage page = document.getPages().get(0); 
   AnnContainer container = page.getAnnotations(true); 
   AnnEllipseObject obj = new AnnEllipseObject(); 
   obj.setRect(LeadRectD.create(0, 0, 1 * 720, 1 * 720)); 
   obj.setStroke(AnnStroke.create(AnnSolidColorBrush.create("red"), LeadLengthD.create(1))); 
   container.getChildren().add(obj); 
   page.setAnnotations(container); 
 
   String outputFileName = srcFileName.replace(".", "_") + ".tif"; 
 
   File outputFile = new File(outputFileName); 
   if (outputFile.exists()) 
      outputFile.delete(); 
 
   SaveDocumentOptions saveOptions = new SaveDocumentOptions(); 
   saveOptions.setFormat(RasterImageFormat.CCITT_GROUP4); 
   saveOptions.setBitsPerPixel(1); 
   String annFileName = outputFileName.replace(".tif", ".xml"); 
   File annFile = new File(annFileName); 
   if (annFile.exists()) 
      annFile.delete(); 
   saveOptions.setAnnotationsUri(Paths.get(annFileName).toUri()); 
   document.saveToFile(outputFileName, saveOptions); 
   assertTrue(new File(outputFileName).exists()); 
}

Requirements

Target Platforms

Reference

SaveDocumentOptions Class

SaveDocumentOptions Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies