annObject Property

Summary

Gets or sets the annotation object being loaded or saved.

Syntax
TypeScript
JavaScript
Object.defineProperty(AnnSerializeObjectEventArgs.prototype, 'annObject', 
	get: function(), 
	set: function(value) 
) 
annObject: AnnObject;

Property Value

The annotation object being loaded or saved.

Remarks

If this object is triggered with the AnnDeserializeOptions.DeserializeObject event, then the value of this property contains null and the object type name being saved is in TypeName. You have the following course of action:

  • Do nothing. Leave the value of AnnObject as null. This will instruct AnnCodecs to try and create the object from TypeName. If the codecs fails to do that for any reason, the DeserializeObjectError error will occur.

  • Create the object manually. Set the value of AnnObject to a new instance of the object type in TypeName. The AnnCodecs will use this object instance to load the rest of the properties and add it to the container. This is useful in situations when an object cannot be created by the framework.

  • Set the value of SkipObject to true. This will instruct AnnCodecs to skip this object and continue to the next. This is useful if in scenarios when you do not want to load certain object types or objects with certain properties.

  • In any of the scenarios above, you can set the Error property to an error object to stop loading the annotation objects and cause AnnCodecs to throw the error and returns.

If this object is triggered with the AnnDeserializeOptions.DeserializeObjectError event, then the value of this property is null and means AnnCodecs could not create the instance of an object of type TypeName. If it is possible to create AnnObject yourself in this situation, then set its instance to AnnObject to allow the codecs object to continue loading its properties. Another option is to set SkipObject to true to instruct AnnCodecs to ignore the error, skip loading this object and continue to the next.

If this object is triggered with the AnnSerializeOptions.SerializeObject event, then the value of this property is null and is not used.

Example
AnnSerializeOptions.ts
AnnSerializeOptions.js
AnnSerializeOptions.html 
import { EngineHelper } from "../utilities/EngineHelper"; 
 
export class AnnEngine_AnnSerializeOptionsExample { 
   constructor() { 
      const helper = new EngineHelper(); 
      helper.run(this.run); 
   } 
 
   run = () => { 
      // Create a new annotation container, 8.5 by 11 inches 
      let container: lt.Annotations.Engine.AnnContainer = new lt.Annotations.Engine.AnnContainer(); 
      // Size must be in annotation units (1/720 of an inch) 
      container.size = lt.LeadSizeD.create(8.5 * 720, 11 * 720); 
 
      const showContainer = (message, container) => { 
         let str: string = message + "\nContainer size: "; 
 
         // Add the size 
         const inch: number = 720; 
         const width: number = container.size.width / inch; 
         const height: number = container.size.height / inch; 
         str += width + " by " + height + " inches" + "\n"; 
 
         // Add the objects 
         str += "Contains " + container.children.count + " objects(s)\n"; 
         for (let i = 0; i < container.children.count; i++) { 
            const annObj: lt.Annotations.Engine.AnnObject = container.children.item(i); 
 
            str += "Object: " + annObj.friendlyName + " at "; 
            for (let j = 0; j < annObj.points.count; j++) { 
               const pt: lt.LeadPointD = annObj.points.item(j); 
               const x: number = pt.x / inch; 
               const y: number = pt.y / inch; 
               str += "(" + x + ", " + y + ") "; 
            } 
 
            str += "\n"; 
         } 
 
         alert(str); 
      } 
 
      const inch: number = 720.0; 
      // Add a red line object, from 1in 1in to 2in 2in 
      const lineObj: lt.Annotations.Engine.AnnPolylineObject = new lt.Annotations.Engine.AnnPolylineObject(); 
      lineObj.points.add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
      lineObj.points.add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
      lineObj.stroke = lt.Annotations.Engine.AnnStroke.create(lt.Annotations.Engine.AnnSolidColorBrush.create("red"), lt.LeadLengthD.create(1)); 
      container.children.add(lineObj); 
 
      // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
      const rectObj: lt.Annotations.Engine.AnnRectangleObject = new lt.Annotations.Engine.AnnRectangleObject(); 
      rectObj.rect = lt.LeadRectD.create(3 * inch, 3 * inch, 1 * inch, 1 * inch); 
      rectObj.stroke = lt.Annotations.Engine.AnnStroke.create(lt.Annotations.Engine.AnnSolidColorBrush.create("blue"), lt.LeadLengthD.create(1)); 
      rectObj.fill = lt.Annotations.Engine.AnnSolidColorBrush.create("yellow"); 
      container.children.add(rectObj); 
 
      // Show the container 
      showContainer("Before save", container); 
 
      // Create the codecs object to save and load annotations 
      const codecs: lt.Annotations.Engine.AnnCodecs = new lt.Annotations.Engine.AnnCodecs(); 
 
      // Create a new instance of AnnSrializeOptions and Hook to the SerializeObject event 
      const serializeOptions: lt.Annotations.Engine.AnnSerializeOptions = new lt.Annotations.Engine.AnnSerializeOptions(); 
      serializeOptions.add_serializeObject((sender, e) => { 
         // e is of type AnnSerializeObjectEventArgs 
         const annObj: lt.Annotations.Engine.AnnObject = e.annObject; 
         if (annObj.id == lt.Annotations.Engine.AnnObject.polylineObjectId) { 
            alert("skipping a polyline during save"); 
            e.skipObject = true; 
         } 
      }); 
 
      // Set it as our deserialize options 
      codecs.serializeOptions = serializeOptions; 
 
      // Save the container 
      const xmlData: string = codecs.save(container, lt.Annotations.Engine.AnnFormat.annotations, null, 1); 
 
      // delete the container 
      container = null; 
 
      // Load the container we just saved 
      container = codecs.load(xmlData, 1); 
 
      // Show it 
      showContainer("After load", container); 
   } 
} 
import { EngineHelper } from "../utilities/EngineHelper"; 
 
export class AnnEngine_AnnSerializeOptionsExample { 
   constructor() { 
      const helper = new EngineHelper(); 
      helper.run(this.run); 
   } 
 
   run = () => { 
      // Create a new annotation container, 8.5 by 11 inches 
      let container = new lt.Annotations.Engine.AnnContainer(); 
      // Size must be in annotation units (1/720 of an inch) 
      container.size = lt.LeadSizeD.create(8.5 * 720, 11 * 720); 
 
      const showContainer = (message, container) => { 
         let str = message + "\nContainer size: "; 
 
         // Add the size 
         const inch = 720; 
         const width = container.size.width / inch; 
         const height = container.size.height / inch; 
         str += width + " by " + height + " inches" + "\n"; 
 
         // Add the objects 
         str += "Contains " + container.children.count + " objects(s)\n"; 
         for (let i = 0; i < container.children.count; i++) { 
            const annObj = container.children.item(i); 
 
            str += "Object: " + annObj.friendlyName + " at "; 
            for (let j = 0; j < annObj.points.count; j++) { 
               const pt = annObj.points.item(j); 
               const x = pt.x / inch; 
               const y = pt.y / inch; 
               str += "(" + x + ", " + y + ") "; 
            } 
 
            str += "\n"; 
         } 
 
         alert(str); 
      } 
 
      const inch = 720.0; 
      // Add a red line object, from 1in 1in to 2in 2in 
      const lineObj = new lt.Annotations.Engine.AnnPolylineObject(); 
      lineObj.points.add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
      lineObj.points.add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
      lineObj.stroke = lt.Annotations.Engine.AnnStroke.create(lt.Annotations.Engine.AnnSolidColorBrush.create("red"), lt.LeadLengthD.create(1)); 
      container.children.add(lineObj); 
 
      // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
      const rectObj = new lt.Annotations.Engine.AnnRectangleObject(); 
      rectObj.rect = lt.LeadRectD.create(3 * inch, 3 * inch, 1 * inch, 1 * inch); 
      rectObj.stroke = lt.Annotations.Engine.AnnStroke.create(lt.Annotations.Engine.AnnSolidColorBrush.create("blue"), lt.LeadLengthD.create(1)); 
      rectObj.fill = lt.Annotations.Engine.AnnSolidColorBrush.create("yellow"); 
      container.children.add(rectObj); 
 
      // Show the container 
      showContainer("Before save", container); 
 
      // Create the codecs object to save and load annotations 
      const codecs = new lt.Annotations.Engine.AnnCodecs(); 
 
      // Create a new instance of AnnSrializeOptions and Hook to the SerializeObject event 
      const serializeOptions = new lt.Annotations.Engine.AnnSerializeOptions(); 
      serializeOptions.add_serializeObject((sender, e) => { 
         // e is of type AnnSerializeObjectEventArgs 
         const annObj = e.annObject; 
         if (annObj.id == lt.Annotations.Engine.AnnObject.polylineObjectId) { 
            alert("skipping a polyline during save"); 
            e.skipObject = true; 
         } 
      }); 
 
      // Set it as our deserialize options 
      codecs.serializeOptions = serializeOptions; 
 
      // Save the container 
      const xmlData = codecs.save(container, lt.Annotations.Engine.AnnFormat.annotations, null, 1); 
 
      // delete the container 
      container = null; 
 
      // Load the container we just saved 
      container = codecs.load(xmlData, 1); 
 
      // Show it 
      showContainer("After load", container); 
   } 
} 
<!doctype html> 
<html lang="en"> 
<title>AnnEngine Example | AnnSerializeOptions</title> 
 
<head> 
   <script src="https://code.jquery.com/jquery-2.2.4.min.js" 
      integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script> 
 
   <script src="../LT/Leadtools.js"></script> 
   <script src="../LT/Leadtools.Controls.js"></script> 
   <script src="../LT/Leadtools.Annotations.Engine.js"></script> 
   <script src="../LT/Leadtools.Annotations.Designers.js"></script> 
   <script src="../LT/Leadtools.Annotations.Rendering.Javascript.js"></script> 
   <script src="../LT/Leadtools.Annotations.Automation.js"></script> 
   <script src="../LT/Leadtools.Annotations.BatesStamp.js"></script> 
   <script src="../LT/Leadtools.Demos.js"></script> 
   <script src="../LT/Leadtools.Demos.Annotations.js"></script> 
   <style> 
      #imageViewerDiv { 
         border: 1px solid #000000; 
         width: 800px; 
         height: 800px; 
         background-color: #7F7F7F; 
      } 
   </style> 
   <!-- All demo files are bundled and appended to the window --> 
   <script src="../../bundle.js" type="text/javascript"></script> 
</head> 
 
<body> 
   <p>Either Pan/Zoom or Annotations mode. In annotations mode, draw new objects or edit them.</p> 
   <div> 
      <select id="currentObjectIdSelect"></select> 
   </div> 
   <div> 
      <input type="button" id="exampleButton" value="Example" /> 
      <label id="exampleLabel" /> 
   </div> 
   <div id="imageViewerDiv" /> 
</body> 
 
<script> 
   window.onload = () => new window.examples.AnnEngine.AnnSerializeOptions(); 
</script> 
</html>
Requirements

Target Platforms

Help Version 22.0.2023.1.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly
Introduction
Getting Started
Namespaces
Leadtools.Annotations.Engine Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.