Save Method

Summary

Saves an annotation container to XML data.

Syntax

Objective-C

-(NSString*) saveContainer:(LTAnnContainer*)container 
format:(LTAnnFormat) format 
  data:(NSString*) xmlData 
Number:(NSUInteger) savePageNumber;

Parameters

container
The AnnContainer to be saved. This value must not be null.

format
This must be AnnFormat.Annotations.

xmlData
Optional existing data. Can be null to create new annotation data; otherwise, it must contain valid data previously saved using this method.

savePageNumber
The page number on which the data is placed.

Return Value

The XML string of the annotations that were saved.

Remarks

If _xmlData_ is not null, then it must contain valid LEADTOOLS annotation data previously saved using Save(String,AnnContainer,AnnFormat,Int32). This method inserts or replaces the page specified in _savePageNumber_ and returns the updated data.

If _xmlData_ is null, then this method will create a new LEADTOOLS annotation data and return it.

If the value of _savePageNumber_ is 0, the page number to use when saving is obtained from the PageNumber property of _container_; otherwise, the page number in the _savePageNumber_ parameter will be used when saving.

LEADTOOLS supports saving multiple containers in the same file, each with a unique page number. Use Load with the page number to load the desired page.

Requirements

Target Platforms

Reference

AnnCodecs Class

AnnCodecs Members

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies