←Select platform

LoadFromString Method

Summary

Loads an annotation container from the specified xml data.

Syntax
C#
VB
Java
Objective-C
C++
public AnnContainer LoadFromString( 
   string xmlData, 
   int pageNumber 
) 
Public Function LoadFromString( _ 
   ByVal xmlData As String, _ 
   ByVal pageNumber As Integer _ 
) As AnnContainer 
-(LTAnnContainer*) loadFromString:(NSString*)xmlData 
                 pageNumber:(int)pageNumber; 
public AnnContainer loadFromString(string xmlData) 
public:  
   AnnContainer^ LoadFromString( 
      String^ xmlData, 
      Int32 pageNumber 
   ) 

Parameters

xmlData
String containing the XML data of the annotations to be loaded. This value must not be null.

pageNumber
1-based page number to load.

Return Value

A new AnnContainer object containing all the objects loaded from xmlData.

Remarks

This method can only load annotations previously saved with the AnnFormat.Annotations format.

If xmlData contains a container with the same page as pageNumber, then this page will be loaded. If the value of pageNumber is 0, the first page is loaded. Otherwise, this method will return null.

The DeserializeOptions property can contain optional options and events to use during loading of annotations data.

For more information, refer to Annotation Files.

Example

For an example, refer to AnnCodecs

Requirements

Target Platforms

See Also

Reference

AnnCodecs Class

AnnCodecs Members

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly