AnnotationManager Members

PDFTron SilverDox SDK

Collapse imageExpand ImageCopy imageCopyHover image

The AnnotationManager type exposes the following members.

Methods

  NameDescription
Public methodAddAnnotation
Adds and displays a new annotation.
Public methodAddCustomAnnotationTypes
This method must be used to register custom annotation types before they can be saved or loaded using SaveAnnotations()()()() and LoadAnnotations(Stream, Predicate<(Of <<'(Annotation>)>>)). Built-in types do not need to be added.
Public methodAddUndoAnnotationState
Allows users to manually define an undo command on a specified annotation.
Public methodClearAnnotations
Removes all of the annotations.
Public methodClearUndoRedoHistory
Clears the stored history for the Undo() and Redo() methods.
Public methodCopySelectedAnnotations
Copies the selected annotations to a temporary buffer. Use the PasteCopiedAnnotations(Nullable<(Of <<'(Int32>)>>)) method to create a duplicate of the copied annotations to the document
Public methodCutSelectedAnnotations
Copies the selected annotations to a temporary buffer and then deletes them. Use the PasteCopiedAnnotations(Nullable<(Of <<'(Int32>)>>)) method to create a duplicate of the copied annotations to the document
Public methodDeselectAllAnnotations
Deselects all currently selected annotations
Public methodGetAllChangedAnnotations
Gets a Dictionary of changed annotations and how they were changed
Public methodGetAnnotationByPoint
Gets the annotation at a specified point in the DocumentViewer
Public methodGetNewAnnotationCanvases
Creates and returns a set of new annotation-containing canvases. Useful for printing.
Public methodLoadAnnotations
Creates annotations that were previously serialized using SaveAnnotations()()()().
Public methodPasteCopiedAnnotations
Creates copies of the annotations copied using the CutSelectedAnnotations()()()() or CopySelectedAnnotations()()()() methods onto the document
Public methodRedo
If the Undo()()()() method is called, Redo() reapplies its effects
Public methodRedrawAnnotation
Causes the specified annotation to be redrawn. Typically called after the annotation's properties have been changed.
Public methodRemoveAnnotation
Removes the specified annotation.
Public methodRemoveAnnotations
Removes the specified list of annotations.
Public methodSaveAnnotations
Serializes the annotations into a byte array containing XML (UTF-8 encoded). This data can be saved and then loaded using LoadAnnotations(Stream, Predicate<(Of <<'(Annotation>)>>)) to re-create the annotations.
Public methodSelectAnnotation
Adds the specified annotation to the list of selected annotations. If the annotation cannot be selected, this method returns false.
Public methodUndo
Reverts the effects of the previous action preformed by the DocumentViewer on the annotations

Properties

  NameDescription
Public propertyAnnotationCreator
References a static method, defined by an annotation, that takes an AnnotationManager as a parameter and returns a new annotation. The method that is referenced is called when a MouseDown event is occurs and the ToolMode is set to a mode which creates an annotation.
Public propertyAnnotationsList
Returns a list of all the annotations under the control of AnnotationManager
Public propertyAnnotationsModified
Gets whether or not any changes has been made since the last time annotations were loaded
Public propertyCanPaste
Gets whether or not annotations has been copied for PasteCopiedAnnotations(Nullable<(Of <<'(Int32>)>>))
Public propertyCanRedo
Gets whether or not there is a command to redo
Public propertyCanUndo
Gets whether or not there is a command to undo
Public propertyCurrentAnnotationPage
The canvas that hosts annotations (displayed on top of the document) that last received and handled a MouseDown event.
Public propertyDefaultAnnotation
The DefaultAnnotation is of the same type of annotation as that created by AnnotationCreator, and can be used as a reference when setting the initial property values of the new annotation.
Public propertyDocument
The document that this AnnotationManager is being used with. Needed for annotations that require information about text.
Public propertySelectedAnnotations
A list of the currently selected annotations.

See Also