annotationsUri Property

Summary

The location to the external annotation file associated with the document.

Syntax

JavaScript Syntax

Object.defineProperty(LoadDocumentOptions.prototype, 'annotationsUri', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

annotationsUri: string;

Property Value

The location to the external annotation file associated with the document. Default value is null.

Remarks

Documents can have annotations stored in an external file. To read these annotations when the document is loaded, set the value of AnnotationsUri to the file or remote URL location. The framework will load the annotation from this location and download it in the cache if needed.

If the value of AnnotationsUri is set (not null), then LoadEmbeddedAnnotations is ignored and the framework will not try to load any embedded annotations even if they exist.

Use DocumentPage.GetAnnotations to access the annotations after the document is loaded.

Refer to Loading Documents using Leadtools.Documents for detailed information.

Example

For an example, refer to DocumentFactory.LoadFromUri.

Requirements

Target Platforms