Atalasoft.Annotate.UI Namespace |
Classes| Class | Description | |
|---|---|---|
 | AnnotatePrintDocument | This control derives from DotImage ImagePrintDocument and is used to print images with
annotations. |
| AnnotateViewer | This control derives from DotImage WorkspaceViewer and contains a reference to an AnnotationController. Drop this control onto a form to start creating annotations. |
| AnnotateViewerParameters | This class is returned by GetViewerParameters to provide information about the
viewer the annotations are rendered on. |
| AnnotationController | The AnnotationController is the central hub for DotImage. It contains a LayerCollection for any number of LayerAnnotation objects, each containing any number of
annotations. |
| AnnotationCursors | AnnotationCursors is a used to hold all of the Cursor objects for the
annotations. This simplifies changing the appearance of the cursors. |
| AnnotationGrip | This class represents a single grip. To access these grip objects use the Grips property of the annotation. |
| AnnotationGripChangedEventArgs | This class is used to with the GripPositionChanged event. |
| AnnotationKey | This class is used with the AnnotationKeyBinder to define the action or handler to call when
a specific key is pressed. |
| AnnotationKeyBinder | The AnnotationKeyBinder class is used to bind key press events to annotation actions.
|
| AnnotationKeyEventArgs | This class is sent to the AnnotationKey handler during a key press event. |
| AnnotationMouseEventArgs | This class is passed to mouse event handlers. |
| AnnotationSaveOptions | This class provides options used when saving annotations with the DocumentAnnotationViewer.
|
| AnnotationUI | This abstract class represents the base annotation object. All annotations must derive from
AnnotationUI. |
| AnnotationUICollection | This class holds a collection of annotation objects. LayerAnnotations use this collection to
hold the AnnotationUI objects they contain. |
| AnnotationUIFactoryCollection | This class is a collection of IAnnotationUIFactory objects which are used to create new AnnotationUI objects from AnnotationData. |
| AnnotationUndo | This class is used to store an undo or redo change for an object. |
| AnnotationUndoManager | The AnnotationUndoManager keeps track of annotation changes and allows undo and redo
functionality. |
| CachedImageAnnotationEventArgs | This class is used with the UndoPerformed and RedoPerformed events of
CachedImageAnnotationUndoManager. |
| CachedImageAnnotationUndoManager | This class manages the undo and redo features of DocumentAnnotationViewer. |
| CalloutAnnotation | This annotation is designed to provide additional information on a specific area of the document. It contains an editable text area and a leader line used to point to the area of the document. When creating this annotation, the first click sets the target for the leader and a second click sets the annotation location. It can also be created by pressing down the mouse button to set the leader and dragging. Both annotation and leader point can be repositioned independently after the annotation has been created. |
| CalloutAnnotationFactory | This class generates a CalloutAnnotation object from a CalloutData class for
use with the AnnotationUIFactoryCollection. |
| CreatePdfAnnotationDataExporterEventArgs | This class provides information for events that create Pdf AnnotationData Exporters. |
| DocumentAnnotationViewer | The DocumentAnnotationViewer control simplifies the process of synchronizing a ThumbnailView with an AnnotateViewer. The control's ThumbnailView can be docked on any side using the ThumbnailDockStyle property. A Separator can be enabled, allowing the end user to resize the ThumbnailView and the AnnotateViewer will fill the rest of the control. |
| EllipseAnnotation | This class uses an EllipseData object to generate an ellipse annotation. |
| EllipseAnnotationFactory | This class generates an EllipseAnnotation object from an EllipseData class for
use with the AnnotationUIFactoryCollection. |
| EmbeddedAnnotationDataProvider | This class is used by the DocumentAnnotationViewer to extract annotation data from JPEG,
TIFF and PDF files. |
| EmbeddedImageAnnotation |
This is an image annotation that will embed the image into the serialized XMP or
WANG data.
|
| EmbeddedImageAnnotationFactory | This class generates an EmbeddedImageAnnotation object from an EmbeddedImageData class for use with the AnnotationUIFactoryCollection. |
| FreehandAnnotation | This class is used for a freehand drawing annotation. |
| FreehandAnnotationFactory | This class generates a FreehandAnnotation object from a FreehandData class for
use with the AnnotationUIFactoryCollection. |
| HotSpotAnnotation | This annotations can be used to add rectangular hot spots on a document. When the InteractMode is set to View the hot spot annotations will be invisible but the cursor will change when hovering over it to indicate that area can be clicked. For a non-rectangular area use the HotSpotFreehandAnnotation. |
| HotSpotAnnotationFactory | This class generates a HotSpotAnnotation object from a AnnotationData class
for use with the AnnotationUIFactoryCollection. |
| HotSpotFreehandAnnotation | This annotation can be used to create a freehand hot spot area on the document. When the InteractMode is set to View the hot spot annotations will be invisible but the cursor will change when hovering over it to indicate that area can be clicked. For a rectangular hot spot use the HotSpotAnnotation. |
| HotSpotFreehandAnnotationFactory | This class generates a HotSpotFreehandAnnotation object from a HotSpotFreehandData class for use with the AnnotationUIFactoryCollection. |
| LayerAnnotation | A LayerAnnotation is a collection of other annotations, including other
LayerAnnotation objects. |
| LayerAnnotationFactory | This class generates a LayerAnnotation object from a LayerData class for use
with the AnnotationUIFactoryCollection. |
| LayerCollection | This class is used to hold a collection of LayerAnnotation objects. |
| LineAnnotation | This is a single line annotation from StartPoint to EndPoint. |
| LineAnnotationFactory | This class generates a LineAnnotation object from a LineData class for use
with the AnnotationUIFactoryCollection. |
 | LinesAnnotation | The LinesAnnoation represents a series of points connected by straight lines. |
| LinesAnnotationFactory | This class generates a LinesAnnotation object from a LinesData class for use
with the AnnotationUIFactoryCollection. |
| OcrRegionAnnotation | This annotation is used to select an area of the image to OCR is a separate process. |
| OcrRegionAnnotationFactory | This class generates a OcrRegionAnnotation object from a OcrRegionData class
for use with the AnnotationUIFactoryCollection. |
| PdfAnnotationUIFactory |
A class for initializing an AnnotationUIFactoryCollection with PDF annotation UI factories.
|
| PdfLineAnnotationFactory | This class is used to generate a PdfLineAnnotation from a PdfLineData object.
|
| PdfMarkupAnnotationFactory | This class is used to generate a PdfMarkupAnnotation from a PdfMarkupData
object. |
| PointBaseAnnotation |
This abstract class is used to simplify creating annotations that are defined
with multiple points instead of a rectangular structure.
|
| PointGrips | PointGrips is the base class implementation used for annotation grips. All annotations in DotImage use PointGrips or RectangleGrips, which derives from PointGrips. In essence, PointGrips is a collection of AnnotationGrip objects. |
| PolygonAnnotation | A PolygonAnnotation is a series of points used to draw a polygon with an optional fill.
|
| PolygonAnnotationFactory | This class generates a PolygonAnnotation object from a PolygonData class for
use with the AnnotationUIFactoryCollection. |
| RectangleAnnotation | This is a rectangular annotation with an optional shadow brush. |
| RectangleAnnotationFactory | This class generates a RectangleAnnotation object from a RectangleData class
for use with the AnnotationUIFactoryCollection. |
| RectangleGrips |
This class represents a group of AnnotationGrip objects for rectangular shaped
annotations.
|
| ReferencedImageAnnotation | This annotation references a local image by filename. When viewing this annotation on multiple systems,
the image file must be provided at the same location of each system. |
| ReferencedImageAnnotationFactory | This class generates a ReferencedImageAnnotation object from a ReferencedImageData class for use with the AnnotationUIFactoryCollection. |
| RubberStampAnnotation | This annotation provides a text message with a rounded rectangle outline similar to a rubber stamp.
|
| RubberStampAnnotationFactory | This class generates a RubberStampAnnotation object from a RubberStampData
class for use with the AnnotationUIFactoryCollection. |
| ScrollPositionChangedEventArgs | This class is used with the OnScrollPositionChanged(ScrollPositionChangedEventArgs) method. |
| TextAnnotation | This annotation displays text which can be edited by the user. |
| TextAnnotationFactory | This class generates a TextAnnotation object from a TextData class for use
with the AnnotationUIFactoryCollection. |
| TransparentRichTextBox | This class is used by the TextAnnotation and CalloutAnnotation for editing
text. |
| UndoEventArgs | This class contains information for the UndoRequest and RedoRequest events. |
Interfaces| Interface | Description | |
|---|---|---|
 | IAnnotate |
This interface must be implemented by any control hosting annotations. The
AnnotationController
requires the properties of this interface for rendering and user interaction.
|
| IAnnotationDataProvider | This interface is used to provide LayerData objects for images. |
| IAnnotationGrips | This interface must be implemented by any class acting as annotation grips. |
| IAnnotationUIFactory | This interface must be implemented by any class used as an annotation UI factory. |
Delegates| Delegate | Description | |
|---|---|---|
 | AnnotationKeyEventHandler | This event handler is used with the AnnotationKey class to process key actions. |
| AnnotationMouseEventHandler | This event handler is used with several mouse events. |
| AnnotationSaveOptionsHandler | This delegate is used to provide annotation save options to the DocumentAnnotationViewer.
|
| CreatePdfAnnotationDataExporterHandler | This delegate is used when viewers need to create a PdfAnnotationDataExporter. |
| GripPositionChangedEventHandler | This event handler is used with the GripPositionChanged event. |
| UndoEventHandler |
Enumerations| Enumeration | Description | |
|---|---|---|
 | AnnotationKeyAction | This enumeration is used to define the actions used with AnnotationKeyBinder. |