SaveLayerToString Method

Summary

Saves an annotation layer to a string.

Syntax

Objective-C

C++

public string SaveLayerToString( 
   AnnLayer layer, 
   AnnFormat format 
)

Public Function SaveLayerToString( _ 
   ByVal layer As AnnLayer, _ 
   ByVal format As AnnFormat _ 
) As String

-(NSString*) saveToLayerString:(LTAnnLayer*)layer 
                        format:(LTAnnFormat)format 
                savePageNumber:(int)savePageNumber;

public:  
   String^ SaveLayerToString( 
      AnnLayer^ layer, 
      AnnFormat^ format 
   )

Parameters

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

format
Must be AnnFormat.Annotations.

Remarks

This method works the same way and produces the same annotation file format that AnnCodecs.SaveToString does, except 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.

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