←Select platform

AnnCodecs Class

Provides support for loading and saving objects to annotation files.
public class AnnCodecs 
@interface LTAnnCodecs : NSObject 
public class AnnCodecs 
   ref class AnnCodecs 
class AnnCodecs: 

This class supports loading and saving annotation objects from/to XML strings as well as getting information about previously saved annotations data.

This class also supports saving and loading multipage annotation data where each page contains a full Annotation Container.

Use the AnnCodecs.Save or AnnCodecs.SaveToString methods to save an annotation container as XML file or data. You can then use the browser capabilities to save this XML data to disk or use a Web Service to store it on a server. The SerializeOptions property can be used to set saving options and monitor the objects being saved.

Use the AnnCodecs.Load or AnnCodecs.LoadFromString methods to load an annotation container from XML file or data. The XML data must be previously loaded from disk using the browser capabilities or obtained from a server using a Web Service. The DeserializeOptions property can be used to set loading options, monitor the objects being loaded and handle errors.

Use the AnnCodecs.LoadAll or LoadAllFromString methods to load all the annotation containers from a multipage XML file or data.

Use the AnnCodecs.SaveAll or SaveAllToString methods to save an array of annotation container as multipage XML file or data.

Use GetInfo, GetInfoFromString to check if an XML data contains valid annotations data such as the format and number of pages.

LEADTOOLS supports saving multiple annotations into the same data. This can be used to save the annotations of a multipage document in the same data.

Use SaveLayer(String,AnnLayer,AnnFormat,Int32), SaveLayer(Stream,AnnLayer,AnnFormat,Int32) and AnnCodecs.SaveLayerToString to save individual annotation layers.


This example will create a container, adds a line and rectangle objects to it. Then it will save it, obtain its information and load it back.

using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Annotations.Rendering; 
public void AnnCodecs_AnnCodecs() 
   // 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)); 
   // 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"); 
   // 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; 
   // Show information about the data we just saved 
   AnnCodecsInfo info = codecs.GetInfo(destFileName); 
   string message; 
   if (info.Format == AnnFormat.Annotations) 
      message = "Version: "; 
      message += info.Version; 
      message += " No. of pages: "; 
      message += info.Pages.Length; 
      message += " page nos: "; 
      for (int i = 0; i < info.Pages.Length; i++) 
         message += info.Pages[i] + " "; 
      message = "Invalid annotations data"; 
   // Show information about the XML data we just saved 
   XmlDocument xmlDoc = new XmlDocument(); 
   AnnCodecsInfo infoFromString =  codecs.GetInfoFromString(xmlDoc.OuterXml); 
   Debug.WriteLine($"Get Info From String"); 
   Debug.WriteLine($"Format:  {infoFromString.Format}"); 
   Debug.WriteLine($"Version: {infoFromString.Version}"); 
   Debug.WriteLine($"Pages:   {infoFromString.Pages.Length}"); 
   // Load the container we just saved 
   container = codecs.Load(destFileName, 1); 
   // Show it 
   ShowContainer("After load", container); 
   // delete the container 
   container = null; 
   // Load the XML container just saved  
   container = codecs.LoadFromString(xmlDoc.OuterXml, 1); 
   // Show it 
   ShowContainer("After load from string", container); 
   // Save Active Layer using a Stream output 
   AnnLayer layer = AnnLayer.Create("MyLayer"); 
   container.ActiveLayer = layer; 
   Stream stream = File.Create("StreamActiveLayer.xml"); 
   codecs.SaveLayer(stream, container.ActiveLayer, AnnFormat.Annotations, 1); 
   // Save Active Layer using a File output 
   AnnLayer layer2 = AnnLayer.Create("MyLayer2"); 
   container.ActiveLayer = layer2; 
   codecs.SaveLayer("StringActiveLayer.xml", layer2, AnnFormat.Annotations, 1); 
   // Save Layer to string 
   AnnLayer layer4 = AnnLayer.Create("MyLayer4"); 
   string stringLayer = codecs.SaveLayerToString(layer4, AnnFormat.Annotations); 
   // Use SelectionObject, set ActiveLayer, Change Offset, Change PageNumber, and Save to string 
   AnnLayer layer5 = AnnLayer.Create("MyLayer5"); 
   AnnSelectionObject annSelectionObject = container.SelectionObject; 
   annSelectionObject.IsSelected = true; 
   container.ActiveLayer = layer5; 
   container.Offset = new LeadPointD(10, 10); 
   container.PageNumber = 3; 
   string saveToString = codecs.SaveToString(container, AnnFormat.Annotations, 1); 
   //Load from String 
   AnnContainer annContainer = codecs.LoadFromString(saveToString, 1); 
private void ShowContainer(String message, AnnContainer container) 
   string str = message + "\nContainer size: "; 
   // Add the size 
   double inch = 720; 
   double width = container.Size.Width / inch; 
   double height = container.Size.Height / inch; 
   str += width + " by " + height + " inches" + "\n"; 
   // Add the objects 
   str += "Contains " + container.Children.Count + " objects(s)\n"; 
   for (int i = 0; i < container.Children.Count; i++) 
      AnnObject annObj = container.Children[i]; 
      str += "Object: " + annObj.FriendlyName + " at "; 
      for (int j = 0; j < annObj.Points.Count; j++) 
         LeadPointD pt = annObj.Points[j]; 
         double x = pt.X / inch; 
         double y = pt.Y / inch; 
         str += "(" + x + ", " + y + ") "; 
      str += "\n"; 

Target Platforms

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

Leadtools.Annotations.Engine Assembly

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