SaveAllToString Method

Summary

Saves an array of annotation containers to a string.

Syntax

Objective-C

C++

Java

public string SaveAllToString( 
   AnnContainer[] containers, 
   AnnFormat format 
)

Public Function SaveAllToString( _ 
   ByVal containers() As AnnContainer, _ 
   ByVal format As AnnFormat _ 
) As String

-(NSString*) saveAllToString:(NSArray*)containers 
                 format:(LTAnnFormat)format;

public String saveAllToString(AnnContainer[] containers, AnnFormat format)

public:  
   String^ SaveAllToString( 
      array<AnnContainer^>^ containers, 
      AnnFormat^ format 
   )

Parameters

containers
An array of AnnContainer's to be saved. This value must not be null.

format
Must be AnnFormat.Annotations.

Remarks

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

This method uses the values of AnnContainer.PageNumber during its operation. The page numbers will be saved along with each container.

The AnnContainer.PageNumber value of each container will be used to indicate the output page number. If more than one container has the same value for PageNumber, then only the last container is used. Any AnnContainer object that is null in the array will be ignored.

For more information, refer to Annotation Files.

Requirements

Target Platforms

Reference

AnnCodecs Class

AnnCodecs Members

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies