GetAnnotationsFileName Method

public string GetAnnotationsFileName()

'Declaration
 

Public Function GetAnnotationsFileName() As String

'Usage
 

Dim instance As Document
Dim value As String
 
value = instance.GetAnnotationsFileName()

public String getAnnotationsFileName()
            

public:
String^ GetAnnotationsFileName(); 

Return Value

The document can be loaded with the annotations stored into an external file. This is done through passing the URL to the location of the annotations in the LoadDocumentOptions.AnnotationsUri.

When the DocumentFactory is loading the documents and this value is not null, then depending on the type of the URI, it can be used as is (if the URL has a file scheme) or downloaded to the cache or a temp file (if the URL has any other scheme). and GetAnnotationsFileName can be used to get the path to this file.

For more information, refer to Loading Using LEADTOOLS Documents Library.

Target Platforms

Reference

Document Class
Document Members