annotationsMode Property


Controls how annotations are saved in the output document.


JavaScript Syntax
Object.defineProperty(DocumentConverterJobData.prototype, 'annotationsMode', 
	get: function(), 
	set: function(value) 
TypeScript Syntax
annotationsMode: DocumentConverterAnnotationsMode; 

Property Value

A DocumentConverterAnnotationsMode enumeration value that controls how annotations are saved in the output document. Default value is DocumentConverterAnnotationsMode.None.


This value is only used if the input document contains annotations or if Annotations was set to a value, otherwise it is ignored.

If AnnotationsMode is not set to DocumentConverterAnnotationsMode.None, then the converter will obtain the source annotations for each page in the document follows:

  1. An empty AnnContainer is created for the page.

  2. If the original document contains annotations, then these are obtained using DocumentPage.GetAnnotations and the annotations objects are added to the empty container created in the first step.

  3. If the value of DocumentConverterJobData.Annotations is not null, then this value must contain one or more AnnContainer objects serialized as strings. Each container has a AnnContainer.PageNumber property that is used to detect if extra annotation objects are present for this page, and if so, they are merged into the containers created in the first step.

  4. Finally, this container is used in generating the final document.

Refer to DocumentConverterAnnotationsMode for more information.


For an example, refer to Convert.


Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Documents Assembly