Annotation Members

PDFTron SilverDox SDK

Collapse imageExpand ImageCopy imageCopyHover image

The Annotation type exposes the following members.

Constructors

  NameDescription
Protected methodAnnotation()()()()
Called by subclasses during construction to set properties common to all annotations.
Protected methodAnnotation(AnnotationManager)
Initializes a new instance of the Annotation class

Methods

  NameDescription
Public methodCreateAppearanceCanvas
Creates and returns the annotation's appearance canvas that will be displayed on screen.
Protected methodCreatePopupCanvas
Creates canvas used as the popup when an annotation is double clicked on. Override this method to provide a customized popup canvas.
Public methodOnAnnotationResizeEnded
Called by the annotation's AnnotationManager when the user has finished resizing the annotation
Public methodOnAnnotationResizeStarted
Called by the annotation's AnnotationManager when the user has began resizing this annotation
Public methodOnCreateMouseDown
Called by the annotation's AnnotationManager when a MouseDown event is received and the AnnotationManager is set to create this type of annotation.
Public methodOnCreateMouseMove
Called by the annotation's AnnotationManager when a MouseMove event is received and the AnnotationManager is set to create this type of annotation.
Public methodOnCreateMouseUp
Called by the annotation's AnnotationManager when a MouseUp event is received and the AnnotationManager is set to create this type of annotation.

Fields

  NameDescription
Protected fieldshouldBeCreated
Determines whether or not the annotation should be created in OnCreateMouseUp This is used for TextMarkups that do not select any text to prevent it from being created when the user releases the mouse

Properties

  NameDescription
Public propertyAnnotationManager
Gets or sets the annotation's AnnotationManager.
Public propertyAuthor
Represents the author of the annotation. Default is an empty string.
Public propertyBottom
Gets the y-axis value of the bottom of the annotation.
Public propertyDateModified
Gets or sets the last date and time that the annotation was modified.
Public propertyHeight
Gets or sets the annotation's height.
Public propertyId
A unique identifier that can be assigned to determine different annotations
Public propertyIsCopyable
Indicates whether or not the user should be able to copy this annotation
Public propertyIsCreated
Gets or sets if the annotation has finished being created by the user.
Public propertyIsSelectable
Indicates whether or not the user can select this annotation Default is true
Public propertyLeft
Gets the x-axis value of the left side of the annotation.
Public propertyMirroredHorizontally
True if the annotation has been mirrored horizontally.
Public propertyMirroredVertically
True if the annotation has been mirrored vertically.
Public propertyNoMove
Gets or sets if this annotation can be moved by the user.
Public propertyNoResize
Gets or sets if this annotation can be resized by the user.
Public propertyNoZoom
Gets or sets if this annotation scales with the page.
Public propertyPageNumber
Gets or sets the page number of a document that the annotation appears on.
Public propertyPopupContents
Gets or sets the contents of the annotation's popup.
Public propertyPopupHeight
Gets or sets the annotation's popup's height.
Public propertyPopupIsVisible
Gets or sets if the annotation's popup is visible.
Public propertyPopupWidth
Gets or sets the annotation's popup's width.
Public propertyPopupX
Gets or sets the annotation's popup's x-axis position.
Public propertyPopupY
Gets or sets the annotation's popup's y-axis position.
Public propertyRight
Gets the x-axis value of the right side of the annotation.
Public propertySubject
Represents the subject of the annotation. Default is the annotation's type.
Public propertyTop
Gets the y-axis position of the top of the annotation.
Public propertyWidth
Gets or sets the annotation's width;
Public propertyX
Gets or sets the annotation's x-axis position.
Public propertyY
Gets or sets the annotation's y-axis position.

Events

  NameDescription
Public eventPropertyChanged
Occurs when a property changes in the annotation

See Also