Save(string,AnnContainer,AnnFormat,int) Method

Summary

Saves an annotation container to a file.

Syntax

Objective-C

C++

public void Save( 
   string fileName, 
   AnnContainer container, 
   AnnFormat format, 
   int savePageNumber 
)

Public Overloads Sub Save( _ 
   ByVal fileName As String, _ 
   ByVal container As AnnContainer, _ 
   ByVal format As AnnFormat, _ 
   ByVal savePageNumber As Integer _ 
)

-(void) save:(NSString*)fileName 
   container:(LTAnnContainer*)container 
      format:(LTAnnFormat)format 
 savePageNumber:(int)savePageNumber;

public:  
   void Save( 
      String^ fileName, 
      AnnContainer^ container, 
      AnnFormat^ format, 
      Int32 savePageNumber 
   )

Parameters

fileName
Destination file name to save the data to.

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

format
Must be AnnFormat.Annotations.

savePageNumber
Page number to put inside the data.

Remarks

If fileName is not a new file, then it must contain valid LEADTOOLS Annotations data previously saved and this method will insert or replace the page specified in savePageNumber.

If fileName is a new file, then this method will create the new LEADTOOLS Annotations data and saves 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 supported saving multiple contains in the same file each with a unique page number. You can 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