loadEmbeddedAnnotations Property

Summary

Indicates whether to try to load the annotations embedded in the document itself.

Syntax

JavaScript Syntax

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

TypeScript Syntax

loadEmbeddedAnnotations: boolean;

Property Value

true to try to load the annotations embedded in the document; otherwise, false. Default value is false.

Remarks

Some document formats such as PDF and TIF supports embedded annotations inside the document file itself. Set the value of LoadEmbeddedAnnotations to true to try and read these annotations when loading a document. This will not cause an error if the format does not support embedded annotations or if the file does not contain any.

If the annotations are stored in an external file, then use AnnotationsUri instead. Note that if you set AnnotationsUri to a value (not null) then LoadEmbeddedAnnotations will be 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

Reference

LoadDocumentOptions Class

LoadDocumentOptions Members

Leadtools.Documents Namespace

Help Version 19.0.2017.10.27