AnnotationManager Members

PDFTron SilverDox SDK

previous page next page

The AnnotationManager type exposes the following members.

Methods

	Name	Description
	AddAnnotation	Adds and displays a new annotation.
	AddCustomAnnotationTypes	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.
	AddUndoAnnotationState	Allows users to manually define an undo command on a specified annotation.
	ClearAnnotations	Removes all of the annotations.
	ClearUndoRedoHistory	Clears the stored history for the Undo() and Redo() methods.
	CopySelectedAnnotations	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
	CutSelectedAnnotations	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
	DeselectAllAnnotations	Deselects all currently selected annotations
	GetAllChangedAnnotations	Gets a Dictionary of changed annotations and how they were changed
	GetAnnotationByPoint	Gets the annotation at a specified point in the DocumentViewer
	GetNewAnnotationCanvases	Creates and returns a set of new annotation-containing canvases. Useful for printing.
	LoadAnnotations	Creates annotations that were previously serialized using SaveAnnotations()()()().
	PasteCopiedAnnotations	Creates copies of the annotations copied using the CutSelectedAnnotations()()()() or CopySelectedAnnotations()()()() methods onto the document
	Redo	If the Undo()()()() method is called, Redo() reapplies its effects
	RedrawAnnotation	Causes the specified annotation to be redrawn. Typically called after the annotation's properties have been changed.
	RemoveAnnotation	Removes the specified annotation.
	RemoveAnnotations	Removes the specified list of annotations.
	SaveAnnotations	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.
	SelectAnnotation	Adds the specified annotation to the list of selected annotations. If the annotation cannot be selected, this method returns false.
	Undo	Reverts the effects of the previous action preformed by the DocumentViewer on the annotations

Properties

	Name	Description
	AnnotationCreator	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.
	AnnotationsList	Returns a list of all the annotations under the control of AnnotationManager
	AnnotationsModified	Gets whether or not any changes has been made since the last time annotations were loaded
	CanPaste	Gets whether or not annotations has been copied for PasteCopiedAnnotations(Nullable<(Of <<'(Int32>)>>))
	CanRedo	Gets whether or not there is a command to redo
	CanUndo	Gets whether or not there is a command to undo
	CurrentAnnotationPage	The canvas that hosts annotations (displayed on top of the document) that last received and handled a MouseDown event.
	DefaultAnnotation	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.
	Document	The document that this AnnotationManager is being used with. Needed for annotations that require information about text.
	SelectedAnnotations	A list of the currently selected annotations.

AnnotationManager Members

PDFTron SilverDox SDK

Methods

Properties

See Also

Get in touch