(Leadtools.Annotations.Core)

AnnCodecs Class

Show in webframe
Example 





Members 
Leadtools.Annotations.Core Namespace : AnnCodecs Class
Provides support for loading and saving objects to annotation files.
Object Model
Syntax
public class AnnCodecs 
Public Class AnnCodecs 
public sealed class AnnCodecs 
@interface LTAnnCodecs : NSObject

public class AnnCodecs

function Leadtools.Annotations.Core.AnnCodecs()
Remarks

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 multi-page annotation data where each page contains a full Annotation Container.

Use the AnnCodecs.Save, AnnCodecs.SaveToString or SaveAsync methods to save an annotation container as XML 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, AnnCodecs.LoadFromString or AnnCodecs.LoadAsync methods to load an annotation container from XML 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 GetInfo, GetInfoFromString or GetInfoAsync 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 multi-page document in the same data.

Use AnnCodecs.Save(string fileName, AnnLayer layer, AnnFormat format, int savePageNumber), AnnCodecs.SaveLayer(Stream stream, AnnLayer layer, AnnFormat format, int savePageNumber) and AnnCodecs.SaveLayerToString to save individual annotation layers.

Example
Copy Code   
using Leadtools.Annotations.Automation;
using Leadtools.Annotations.Core;
using Leadtools.Codecs;
using Leadtools.WinForms;

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

   // 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] + " ";
      }
   }
   else
   {
      message = "Invalid annotations data";
   }

   Debug.WriteLine(message);

   // Load the container we just saved
   container = codecs.Load(destFileName, 1);

   // Show it
   ShowContainer("After load", container);
}

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

   Debug.WriteLine(str);
}
using Leadtools.Converters;
using Leadtools.Annotations.Automation;
using Leadtools.Controls;
using Leadtools.Annotations.Core;
using Leadtools.Codecs;

[TestMethod]
public async Task 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 = LeadSizeDHelper.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(LeadPointDHelper.Create(1 * inch, 1 * inch));
   lineObj.Points.Add(LeadPointDHelper.Create(2 * inch, 2 * inch));
   lineObj.Stroke = AnnStroke.Create(AnnSolidColorBrush.Create("Red"), LeadLengthDHelper.Create(1));
   container.Children.Add(lineObj);

   // Add a blue on yellow rectangle from 3in 3in to 4in 4in
   AnnRectangleObject rectObj = new AnnRectangleObject();
   rectObj.Rect = LeadRectDHelper.Create(3 * inch, 3 * inch, 1 * inch, 1 * inch);
   rectObj.Stroke = AnnStroke.Create(AnnSolidColorBrush.Create("Blue"), LeadLengthDHelper.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";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(saveFile, container, AnnFormat.Annotations, 1);

   // delete the container
   container = null;

   // Show information about the data we just saved
   AnnCodecsInfo info = await codecs.GetInfoAsync(saveFile);
   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] + " ";
      }
   }
   else
   {
      message = "Invalid annotations data";
   }

   Debug.WriteLine(message);

   // Load the container we just saved
   container = await codecs.LoadAsync(saveFile, 1);

   // Show it
   ShowContainer("After load", container);
}

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

   Debug.WriteLine(str);
}
Requirements

Target Platforms

See Also

Reference

AnnCodecs Members
Leadtools.Annotations.Core Namespace
Annotation Files

 

 

Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.