AnnotationContainer Property

Summary

LEADTOOLS Annotation container that contains the objects to use when annotating a page in PDF documents.

Syntax

C++/CLI

Java

Python

public object AnnotationContainer { get; set; }

public Object getAnnotationContainer() 
public void setAnnotationContainer(Object annContainer)

public: 
property Object^ AnnotationContainer { 
   Object^ get(); 
   void set (    Object^ ); 
}

AnnotationContainer # get and set (DocumentWriterSvgPage)

Property Value

An optional Object that must point to a valid instance of AnnContainer class containing the objects to use when annotating a page in PDF documents. Default value is null (Nothing in VB).

Remarks

The AnnotationContainer property is optional and is used only when the document being created is PDF. To create a PDF document with annotations, perform the following steps:

You can use the DocumentWriter.GetOptions and DocumentWriter.SetOptions methods to the get the options used when saving a PDF document.
Call DocumentWriter.BeginDocument with DocumentFormat.Pdf as the format to use.
Add the document pages. The DocumentWriterSvgPage.SvgDocument property must point to the SVG representation of the page and the DocumentWriterSvgPage.AnnotationContainer property must contain a valid AnnContainer object holding the annotation objects to be saved for this page.
Repeat for each page in the document.
Call DocumentWriter.EndDocument to finish creating the document file on disk.

For more information, refer to PdfDocumentOptions.

Note that AnnContainer is used only when the document being created is PDF.also saving annotated document is not supported when DocumentType is PdfDocumentType.PdfA.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Ocr; 
 
 
public void DocumentWriterExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "test.docx"); 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.pdf"); 
 
   // Setup a new RasterCodecs object 
   var codecs = new RasterCodecs(); 
   codecs.Options.RasterizeDocument.Load.Resolution = 300; 
 
   // Get the number of pages in the input document 
   var pageCount = codecs.GetTotalPages(inputFileName); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   var docWriter = new DocumentWriter(); 
 
   // Change the PDF options 
   var pdfOptions = docWriter.GetOptions(DocumentFormat.Pdf) as PdfDocumentOptions; 
   pdfOptions.DocumentType = PdfDocumentType.PdfA; 
   docWriter.SetOptions(DocumentFormat.Pdf, pdfOptions); 
 
   // Create a new PDF document 
   Debug.WriteLine("Creating new PDF document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Pdf); 
 
   // Loop through all the pages 
   for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++) 
   { 
      // Get the page as SVG 
      Debug.WriteLine("Loading page {0}", pageNumber); 
      var page = new DocumentWriterSvgPage(); 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
      // Add the page 
      Debug.WriteLine("Adding page {0}", pageNumber); 
      docWriter.AddPage(page); 
 
      page.SvgDocument.Dispose(); 
   } 
 
   // Finally finish writing the PDF file on disk 
   docWriter.EndDocument(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}