renderAnnotations Property (original) (raw)

Summary

Renders annotations embedded in the document.

Syntax

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

renderAnnotations: boolean; 

Property Value

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

Remarks

Some document formats such as PDF and TIF support embedded annotations inside the document file itself. Set the value of LoadEmbeddedAnnotations to true to try to 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.

The value of RenderAnnotations controls what happens to the annotations:

• RenderAnnotations is false (the default value): The annotations are loaded and stored inside the document and DocumentPage.GetAnnotations can be used to access the annotations after loading. DocumentViewer will then allow the user to interact with these annotation objects by moving them, deleting them or changing their properties.
• RenderAnnotations is true: The annotations are rendered on top of each page (raster and SVG). DocumentViewer will then show the annotations as part or image of each page and will not allow the user to interact with these annotation objects. This feature is currently available only for annotations extracted from an embedded PDF file.

RenderAnnotations is not used if LoadEmbeddedAnnotations is false.

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