SaveLayer(string,AnnLayer,AnnFormat,int) Method

Summary

Saves an annotation layer to a file.

Syntax

Objective-C

C++

public void SaveLayer( 
   string fileName, 
   AnnLayer layer, 
   AnnFormat format, 
   int savePageNumber 
)

Public Overloads Sub SaveLayer( _ 
   ByVal fileName As String, _ 
   ByVal layer As AnnLayer, _ 
   ByVal format As AnnFormat, _ 
   ByVal savePageNumber As Integer _ 
)

-(void) saveLayer:(NSString*)fileName 
            layer:(LTAnnLayer*)layer 
           format:(LTAnnFormat)format 
   savePageNumber:(int)savePageNumber;

public:  
   void SaveLayer( 
      String^ fileName, 
      AnnLayer^ layer, 
      AnnFormat^ format, 
      Int32 savePageNumber 
   )

Parameters

fileName
Destination file name to save the data to.

layer
The AnnLayer to be saved. This value must not be null.

format
Must be AnnFormat.Annotations.

savePageNumber
Page number to put inside the data.

Remarks

This method works the same and produces the same annotation file format as AnnCodecs.Save(string fileName, AnnContainer container, AnnFormat format, int pageSaveNumber) does, except that it saves only the objects inside the individual layer specified instead of all the objects in the container.

Note that "load layer" functionality is not required by AnnCodecs. An AnnLayer cannot exist by itself without an annotation container, hence any of the load functions that accept a container parameter can be used to load the file saved by this function.

If the fileName is not a new file, then it must contain valid LEADTOOLS Annotations data previously saved. This method inserts or replaces the page specified in savePageNumber.

If fileName is a new file, then this method creates new LEADTOOLS Annotations data and saves it.

If the value of savePageNumber is 0, the default value of 1 is used. Otherwise, the page number used when saving is savePageNumber.

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

The SerializeOptions property can contain optional options and events that can be used when saving annotation data.

For more information, refer to Annotation Files.

Example

For an example, refer to AnnCodecs

Requirements

Target Platforms