AnnotationUI Class |
This abstract class represents the base annotation object. All annotations must derive from
AnnotationUI.
Inheritance HierarchyNamespace: Atalasoft.Annotate.UI
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe AnnotationUI type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AnnotationUI(AnnotationData) |
A constructor for the AnnotationUI object specifying the releated
AnnotationData.
|
 | AnnotationUI(SerializationInfo, StreamingContext) |
A constructor for AnnotationUI specifying the serialization information for this
annotation.
|
Properties| Name | Description | |
|---|---|---|
 | Bounds | Gets the bounding rectangle for the annotation. |
| CanMirror |
Gets or sets a value indicating whether can mirror.
|
| CanMove |
Gets or sets a value indicating whether can move.
|
| CanResize |
Gets or sets a value indicating whether can resize.
|
| CanRotate |
Gets or sets a value indicating whether can rotate.
|
| CanSelect |
Gets or sets a value indicating whether can select.
|
| ContextMenu | Gets or sets a ContextMenu object that will be displayed when the user right-clicks on
the annotation. |
| ContextMenuStrip | Gets or sets a ContextMenuStrip object that will be displayed when the user right-clicks
on the annotation. |
| Controller | Gets the AnnotationController for this annotation. |
| CreationTime |
Gets or sets the creation time.
|
| Data | Gets the AnnotationData object associated with this annotation. |
| Grips | Gets the grips used for the annotation. |
| HitTestRectangle | Gets a rectangle used for hit testing or RectangleF.Empty to use the default hit testing
method. |
| Location | Gets or sets the location of the annotation in document space. |
| ModifiedTime |
Gets or sets the modification time.
|
| Name |
Gets or sets the name.
|
| ParentLayer | Gets or sets the LayerAnnotation that contains this annotation. |
| Rotation |
Gets or sets the rotation.
|
| Security |
Gets or sets the security.
|
| Selected | Gets or sets a value indicating whether this annotation the selected. |
| Size | Gets or sets the size of the annotation. |
| State | Gets or sets the current state of the annotation. |
| ToolTip |
Gets or sets the tool tip.
|
| Transform |
Gets or sets the transform.
|
| UserName |
Gets or sets the name of the user.
|
| Visible | Gets or sets a value indicating whether the annotation is visible. |
Methods| Name | Description | |
|---|---|---|
 | AddGripsToRegion |
Adds the annotation grips to a region. The grips are added in annotation space.
|
| ApplyRegionTransform |
Use this method to convert a region from annotation space to document or view
space.
|
| BeginCreate | This method is called by the AnnotationController when the user is beginning to create this
annotation using the mouse. |
| Clone | Creates a copy of this annotation. |
| CreateRenderTransform | Returns the Matrix used by the renderer to transform the annotation. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetConfinedGripPosition |
Gets the confined grip position.
|
| GetConfinedLocation(RectangleF, PointF) | Returns the new confined location of the annotation when a confinement bounds and new location offset are
provided. |
| GetConfinedLocation(RectangleF, RectangleF, PointF) | Returns the new confined location of the annotation when the annotation bounds, a confinement bounds and new location offset are provided. This overload is useful when only a portion of the annotation bounds should be taken into account for this calculation. |
| GetConfinedRotation |
Gets the confined rotation.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData | Fills a SerializationInfo object with information about this annotation. |
| GetOnePixel | Returns the equivalent of 1 pixel in resolution units. |
| GetRegion |
Returns a rectangular region for this annotation, including its grips if
selected.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetViewerParameters | This method is used to get information about the viewer where the annotations are rendered, including
resolution, zoom (scale) level and scrollbar position. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Mirror | Mirrors (flips) the annotation horizontally or vertically. |
| OnAnnotationControllerNotification | Called after a property of the annotation or related AnnotationData has been modified.
|
| OnClick | Called when the user has clicked on the annotation. |
| OnControllerChanged | Called when the Controller property has changed. |
| OnDoubleClick | Called when the annotation is double-clicked. |
| OnGripPositionChanged | Called when a grip of the annotation has been moved by the user using the mouse. |
| OnMirror | Called when the grips of an annotation have been dragged past the opposite grip. |
| OnMouseDown | Called when the user clicks down on the annotation. |
| OnMouseEnter | Called when the mouse is moved into the annotation region. |
| OnMouseExit | Called when the mouse is moved out of the annotation region. |
| OnMouseMove | Called when the user has moved the mouse over the annotation. |
| OnMouseUp | Called when the user has released the mouse over the annotation. |
| OnMoved | Called when a move to a new location has completed. |
| OnMoving | Called while an annotation is being moved by the user. |
| OnPropertyChanged | Called when a property value has changed and raises the PropertyChanged event.
|
| OnPropertyChanging | Called when a property of the annotation or AnnotationData is about to be changed.
|
| OnResized | Called when a resize on the annotation has completed. |
| OnResizing | Called while the annotation is being resized by the user. |
| OnRotate | Called when the Rotate(Single) method is called on the annotation. |
| OnRotated | Called when the annotation has been rotated by the user. |
| OnRotateDocument | Called when the RotateDocument(DocumentRotation, Int32) method is used. |
| OnRotating | Called while an annotation is being rotated by the user. |
| OnScrollPositionChanged | Called when the IAnnotate. Transform indicates a change in its
offset (scroll position). |
| OnSelectedChanged | Called when the Selected property of the annotation has changed. |
| OnSizeChanged | Called when the Size property of the annotation has changed. |
| RaiseClickEvent | Use this method to force a Click event on the annotation. |
| RaiseDoubleClickEvent | Use this method to force a DoubleClick event on the annotation. |
| RaiseGripPositionChangedEvent | Use this method to force a GripPositionChanged event on the annotation.
|
| RaiseMouseDownEvent | Use this method to force a MouseDown event on the annotation. |
| RaiseMouseEnterEvent | Use to force the MouseEnter event for the annotation. |
| RaiseMouseExitEvent | Use to force a MouseExit event on the annotation. |
| RaiseMouseMoveEvent | Use this method to force a MouseMove event on the annotation. |
| RaiseMouseUpEvent | Use this method to force a MouseUp event on the annotation. |
| RaiseMovedEvent | Use this method to force a Moved event on the annotation. |
| RaiseMovingEvent | Use this method to force a Moving event on the annotation. |
| RaiseOnRotateDocument | Use this method to force the OnRotateDocument(DocumentRotation) method to be called. |
| RaiseResizedEvent | Use this method to force a Resized event on the annotation. |
| RaiseRotatedEvent | This method invokes the Rotated event. |
| RaiseScrollPositionChangedEvent | Use this method to force the OnScrollPositionChanged(ScrollPositionChangedEventArgs) method to be called.
|
| Remove | Forces the annotation to remove itself from its parent layer. |
| Rotate | Rotates the annotation by the specified number of degrees. |
| SetGrips | Sets the grips used by the annotation. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TransformRectangle | Applies the render transformation matrix to a rectangle. |
Events| Name | Description | |
|---|---|---|
 | AnnotationControllerNotification | Raised after a property value has been changed. |
| Click | Raised when the annotation has been clicked with the mouse. |
| DoubleClick | Raised when the annotation has been double-clicked with the mouse. |
| GripPositionChanged | Raised when a grip for the annotation has been moved. |
| MouseDown | Raised when a mouse button is pressed while on top of the annotation. |
| MouseEnter | Raised when the mouse enters the annotation region. |
| MouseExit | Raised when the mouse exists the annotation region. |
| MouseMove | Raised when the mouse is moved over the annotation. |
| MouseUp | Raised when the mouse button is released from an annotation. |
| Moved | Raised when the annotation has been moved. |
| Moving | Raised while the annotation is being moved. |
| PropertyChanged | Raised when a property value has changed. |
| PropertyChanging | Raised when a property of the annotation or AnnotationData is going to be changed.
|
| Resized | Raised when the annotation has been resized. |
| Resizing | Raised while the annotation is being resized. |
| Rotated |
Raised after the annotation has been rotated by the user.
|
| Rotating | Raise while an annotation is being rotated. |
| SelectedChanged | Raised when the Selected property changes. |
See AlsoReference
Inheritance HierarchySystemObject
Atalasoft.Annotate.UIAnnotationUI
Atalasoft.Annotate.InkInkAnnotation
Atalasoft.Annotate.PdfPdfAnnotation
Atalasoft.Annotate.UICalloutAnnotation
Atalasoft.Annotate.UIEllipseAnnotation
Atalasoft.Annotate.UIEmbeddedImageAnnotation
Atalasoft.Annotate.UIHotSpotAnnotation
Atalasoft.Annotate.UILayerAnnotation
Atalasoft.Annotate.UILineAnnotation
Atalasoft.Annotate.UIOcrRegionAnnotation
Atalasoft.Annotate.UIPointBaseAnnotation
Atalasoft.Annotate.UIRectangleAnnotation
Atalasoft.Annotate.UIReferencedImageAnnotation
Atalasoft.Annotate.UIRubberStampAnnotation
Atalasoft.Annotate.UITextAnnotation
Atalasoft.Annotate.UIAnnotationUI
Atalasoft.Annotate.InkInkAnnotation
Atalasoft.Annotate.PdfPdfAnnotation
Atalasoft.Annotate.UICalloutAnnotation
Atalasoft.Annotate.UIEllipseAnnotation
Atalasoft.Annotate.UIEmbeddedImageAnnotation
Atalasoft.Annotate.UIHotSpotAnnotation
Atalasoft.Annotate.UILayerAnnotation
Atalasoft.Annotate.UILineAnnotation
Atalasoft.Annotate.UIOcrRegionAnnotation
Atalasoft.Annotate.UIPointBaseAnnotation
Atalasoft.Annotate.UIRectangleAnnotation
Atalasoft.Annotate.UIReferencedImageAnnotation
Atalasoft.Annotate.UIRubberStampAnnotation
Atalasoft.Annotate.UITextAnnotation