←Select platform

IsContainerModified Method (DocumentViewerAnnotations)

Summary

Indicates whether the specified page's annotation container has been modified

Syntax

C++

public bool IsContainerModified( 
   int pageNumber 
)

Public Function IsContainerModified( 
   ByVal pageNumber As Integer 
) As Boolean

public:  
   bool IsContainerModified( 
      int pageNumber 
   )

Parameters

pageNumber

1-based page number in the document

Return Value

true if the specified page's annotation container has been modified; otherwise, false.

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

See Also