In This Topic ▼

setContainerModified Method

Summary

Mark the specified page's annotation container as being modified.

Syntax

TypeScript

JavaScript

DocumentViewerAnnotations.prototype.setContainerModified = function( 
   pageNumber, 
   isModified 
)

setContainerModified( 
   pageNumber: number, 
   isModified: boolean 
): void;

Parameters

pageNumber

1-based page number in the document

isModified

true to make container as modified, false to make it as up to date.

Remarks

DocumentViewerAnnotations keeps track of all the modifications that occur to the annotation container of the pages after load. For example, when the user edit, adds or deletes or change the properties of the annotation objects.

This state can be used by the application to track when the document becomes "dirty" and save is required.

The state is tracked internally by DocumentViewerAnnotations when the objects are modified using the built-in automation. If the application changes an annotation container directly without using automation, then it is not recorded by the automation and this DocumentViewerAnnotations does not update the internal state.

Use SetContainerModified to mark a container as modified (or clear the state) and IsContainerModified to obtain the current modification state of a container.

Requirements

Target Platforms

Reference

DocumentViewerAnnotations Class

DocumentViewerAnnotations Members

Leadtools.Document.Viewer Namespace

Download our FREE evaluation

Help Version 22.0.2023.4.18