AnnDeserializeOptions Class

Summary

Options to use when loading annotation objects.

Syntax

Objective-C

C++/CLI

Java

Python

public class AnnDeserializeOptions

@interface LTAnnDeserializeOptions : NSObject

public class AnnDeserializeOptions

public: 
   ref class AnnDeserializeOptions

class AnnDeserializeOptions:

Remarks

This class is used as the type for AnnCodecs.DeserializeOptions and contains the following members:

Member	Description
DeserializeObject	Event to trigger for each annotation object being loaded. Allows you to monitor and skip any object.
DeserializeObjectError	Event to trigger when an error occurs during loading an annotation object. Allows you to handle the error or skip it.

Example

This example will create a container, adds a line and rectangle objects to it and saves it. Then it will show how to monitor the objects being loaded.

Java

using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Annotations.Rendering; 
 
public void AnnCodecs_AnnDeserializeOptions() 
{ 
   // Create a new annotation container, 8.5 by 11 inches 
   AnnContainer container = new AnnContainer(); 
   // Size must be in annotation units (1/720 of an inch) 
   container.Size = LeadSizeD.Create(8.5 * 720, 11 * 720); 
 
   double inch = 720.0; 
   // Add a red line object, from 1in 1in to 2in 2in 
   AnnPolylineObject lineObj = new AnnPolylineObject(); 
   lineObj.Points.Add(LeadPointD.Create(1 * inch, 1 * inch)); 
   lineObj.Points.Add(LeadPointD.Create(2 * inch, 2 * inch)); 
   lineObj.Stroke = AnnStroke.Create(AnnSolidColorBrush.Create("Red"), LeadLengthD.Create(1)); 
   container.Children.Add(lineObj); 
 
   // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
   AnnRectangleObject rectObj = new AnnRectangleObject(); 
   rectObj.Rect = LeadRectD.Create(3 * inch, 3 * inch, 1 * inch, 1 * inch); 
   rectObj.Stroke = AnnStroke.Create(AnnSolidColorBrush.Create("Blue"), LeadLengthD.Create(1)); 
   rectObj.Fill = AnnSolidColorBrush.Create("Yellow"); 
   container.Children.Add(rectObj); 
 
   // Show the container 
   ShowContainer("Before save", container); 
 
   // Create the codecs object to save and load annotations 
   AnnCodecs codecs = new AnnCodecs(); 
 
   // Save the container 
   string destFileName = @"container.xml"; 
   codecs.Save(destFileName, container, AnnFormat.Annotations, 1); 
 
   // delete the container 
   container = null; 
 
   // Create a new instance of AnnDeserializeOptions and Hook to the DeserializeObject and DeserializeObjectError events 
   AnnDeserializeOptions deserializeOptions = new AnnDeserializeOptions(); 
   deserializeOptions.DeserializeObject += deserializeOptions_DeserializeObject; 
   deserializeOptions.DeserializeObjectError += deserializeOptions_DeserializeObjectError; 
 
   // Set it as our deserialize options 
   codecs.DeserializeOptions = deserializeOptions; 
 
   // Load the container we just saved 
   container = codecs.Load(destFileName, 1); 
 
   // Show it 
   ShowContainer("After load", container); 
} 
 
void deserializeOptions_DeserializeObjectError(object sender, AnnSerializeObjectEventArgs e) 
{ 
   Debug.WriteLine(e.Error.Message); 
} 
 
void deserializeOptions_DeserializeObject(object sender, AnnSerializeObjectEventArgs e) 
{ 
   Debug.WriteLine("loading object of type: " + e.TypeName); 
}

 
import java.io.File; 
import java.io.IOException; 
import java.io.OutputStream; 
import java.io.FileOutputStream; 
import java.io.FileWriter; 
import java.util.Scanner; 
 
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.*; 
 
 
public void annCodecsAnnDeserializeOptions() throws IOException { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
 
   // Create a new annotation container, 8.5 by 11 inches 
   AnnContainer container = new AnnContainer(); 
 
   // Size must be in annotation units (1/720 of an inch) 
   container.setSize(LeadSizeD.create(8.5 * 720, 11 * 720)); 
 
   double inch = 720.0; 
 
   // Add a red line object, from 1in 1in to 2in 2in 
   AnnPolylineObject lineObj = new AnnPolylineObject(); 
   lineObj.getPoints().add(LeadPointD.create(1 * inch, 1 * inch)); 
   lineObj.getPoints().add(LeadPointD.create(2 * inch, 2 * inch)); 
   lineObj.setStroke(AnnStroke.create(AnnSolidColorBrush.create("Red"), 
         LeadLengthD.create(1))); 
   container.getChildren().add(lineObj); 
 
   // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
   AnnRectangleObject rectObj = new AnnRectangleObject(); 
   rectObj.setRect(LeadRectD.create(3 * inch, 3 * inch, 1 * inch, 1 * inch)); 
   rectObj.setStroke(AnnStroke.create(AnnSolidColorBrush.create("Blue"), 
         LeadLengthD.create(1))); 
   rectObj.setFill(AnnSolidColorBrush.create("Yellow")); 
   container.getChildren().add(rectObj); 
 
   // Show the container 
   showContainer("Before save", container); 
 
   // Create the codecs object to save and load annotations 
   AnnCodecs codecs = new AnnCodecs(); 
 
   AnnContainer[] containers = new AnnContainer[1]; 
   containers[0] = container; 
 
   // Save the container 
   String destFileName = combine(LEAD_VARS_IMAGES_DIR, "container.xml"); 
   FileWriter writer = new FileWriter(destFileName); 
 
   // Write the xml data to destFileName 
   codecs.saveAll(writer, containers, AnnFormat.ANNOTATIONS); 
 
   // Load the xml data from the file 
   // You can do this or String xmlData = codecs.saveAll(containers, 
   // AnnFormat.ANNOTATIONS); 
   File file = new File(destFileName); 
   Scanner scanner = new Scanner(file); 
   String xmlData = ""; 
   while (scanner.hasNext()) { 
      xmlData += scanner.nextLine(); 
   } 
   scanner.close(); 
   System.out.println("Raw data from file:\n" + xmlData); 
 
   // For testing correctness 
   AnnContainer savedContainer = container; 
 
   // Delete the container 
   container = null; 
 
   // Create a new instance of AnnDeserializeOptions and Hook to the 
   // DeserializeObject and DeserializeObjectError events 
   AnnDeserializeOptions deserializeOptions = new AnnDeserializeOptions(); 
   deserializeOptions.addDeserializeObjectListener(deserializeOptions_DeserializeObject); 
   deserializeOptions.addDeserializeObjectErrorListener(deserializeOptions_DeserializeObjectError); 
 
   // Set it as our deserialize options 
   codecs.setDeserializeOptions(deserializeOptions); 
 
   // Load the container we just saved 
   container = codecs.load(xmlData, 1); 
 
   // Show it 
   showContainer("After load", container); 
 
   for (int i = 0; i < container.getChildren().size(); i++) { 
      AnnObject annObj = container.getChildren().get(i); 
      AnnObject savedAnnObj = savedContainer.getChildren().get(i); 
      assertTrue("Check loaded and saved containers are equal", 
            annObj.getFriendlyName().equals(savedAnnObj.getFriendlyName())); 
 
      assertTrue("Image unsuccessfully saved", new File(destFileName).exists()); 
      System.out.printf("Command run, image saved to %s\n", destFileName); 
 
   } 
} 
 
AnnSerializeObjectListener deserializeOptions_DeserializeObject = new AnnSerializeObjectListener() { 
 
   @Override 
   public void serializeObject(AnnSerializeObjectEvent e) { 
      System.out.println("loading object of type: " + e.getTypeName()); 
   } 
 
}; 
 
AnnSerializeObjectListener deserializeOptions_DeserializeObjectError = new AnnSerializeObjectListener() { 
 
   @Override 
   public void serializeObject(AnnSerializeObjectEvent e) { 
      System.out.println(e.getError().getMessage()); 
   } 
};

Requirements

Target Platforms

Reference

AnnDeserializeOptions Members

Leadtools.Annotations.Engine Namespace

Annotation Files

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies