Save(AnnContainer,AnnFormat,String,Int32) Method (original) (raw)

Summary

Saves an annotation container to XML data.

Syntax

Parameters

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

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 to place the data.

Return Value

An XML string of annotations that were saved.

Remarks

If xmlData is not null, then it must contain valid LEADTOOLS annotation data previously saved with Save(String,AnnContainer,AnnFormat,Int32). This method will insert or replace the page specified in savePageNumber and return the updated data.

If xmlData is null, then this method will create the 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 savePageNumber page number is used when saving.

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