SaveToString Method

Summary

Saves an annotation container to a string.

Syntax

Objective-C

C++

public string SaveToString( 
   AnnContainer container, 
   AnnFormat format, 
   int savePageNumber 
)

Public Function SaveToString( _ 
   ByVal container As AnnContainer, _ 
   ByVal format As AnnFormat, _ 
   ByVal savePageNumber As Integer _ 
) As String

-(NSString*) saveToString:(LTAnnContainer*)container 
                 format:(LTAnnFormat)format 
                 savePageNumber:(int)savePageNumber;

public:  
   String^ SaveToString( 
      AnnContainer^ container, 
      AnnFormat^ format, 
      Int32 savePageNumber 
   )

Parameters

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 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.

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