Error Property

Summary

Gets the error that has occurred during loading or saving annotation objects.

Syntax

Objective-C

C++/CLI

Java

Python

public Exception Error { get; }

@property (nonatomic, strong, readonly, nullable) NSError *error;

public RuntimeException getError()

public:  
   property Exception^ Error 
   { 
      Exception^ get() 
   }

Error # get  (AnnSerializeObjectEventArgs)

Property Value

The error that has occurred during loading or saving annotation objects.

Remarks

The AnnDeserializeOptions.DeserializeObjectError event will fire if an error occurs during loading of annotation objects. The error itself will be set in the Error property. And you will get a chance to ignore this error if needed.

This value is not used during save (with AnnSerializeOptions).

Example

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); 
}

Requirements

Target Platforms

Reference

AnnSerializeObjectEventArgs Class

AnnSerializeObjectEventArgs Members

Download our FREE evaluation

Help Version 22.0.2023.7.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies