save Method

Summary

Saves an annotation container to xml data.

Syntax
TypeScript
JavaScript
AnnCodecs.prototype.save = function( 
   container, 
   format, 
   xmlData, 
   savePageNumber 
) 
save( 
   container: AnnContainer, 
   format: AnnFormat, 
   xmlData: string, 
   savePageNumber: number 
): string; 

Parameters

container

The AnnContainer to be saved. Must not be null.

format

Must be AnnFormat.Annotations.

xmlData

Optional existing data. Can be null to create new annotations data; otherwise, must contain valid

data previously saved with this method.

savePageNumber

Page number on which to place the data.

Return Value

The xml string of the annotations that were saved.

Remarks

If xmlData is not null, then it must contain valid LEADTOOLS Annotations data previously saved with Save and this method will insert or replace the page specified in savePageNumber and returns the updated data.

If xmlData is null, then this method creates the new LEADTOOLS Annotations data and returns 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 to use when saving is savePageNumber.

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

The SerializeOptions property can contain optional options and events to use during saving of annotations data.

For more information, refer to Annotation Files.

Example

For an example, refer to AnnCodecs

Requirements

Target Platforms

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

Leadtools.Annotations.Engine Assembly