Click or drag to resize

CalloutAnnotation Class

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.

Inheritance Hierarchy

Namespace:  Atalasoft.Annotate.UI
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class CalloutAnnotation : AnnotationUI, 
	IDisposable

The CalloutAnnotation type exposes the following members.

Constructors
  NameDescription
Public methodCalloutAnnotation
Creates a new instance of CalloutAnnotation.
Public methodCalloutAnnotation(String)
Creates a new instance of CalloutAnnotation specifying the text for the annotation.
Public methodCalloutAnnotation(CalloutData)
Creates a new instance of CalloutAnnotation specifying the CalloutData object used by the annotation.
Public methodCalloutAnnotation(SerializationInfo, StreamingContext)
Creates a new instance of CalloutAnnotation from serialized information.
Public methodCalloutAnnotation(String, AnnotationFont, AnnotationBrush, Single)
Creates a new instance of CalloutAnnotation specifying the text, font and font brush for the annotation.
Public methodCalloutAnnotation(String, AnnotationFont, AnnotationBrush, Single, AnnotationBrush, AnnotationPen, AnnotationPen, Single)
Creates a new instance of CalloutAnnotation specifying the text, font, font brush, outline and line pen.
Public methodCalloutAnnotation(String, AnnotationFont, AnnotationBrush, Single, AnnotationBrush, AnnotationPen, AnnotationPen, Single, PointF, Boolean)
Creates a new instance of CalloutAnnotation specifying its parameters.
Top
Properties
  NameDescription
Public propertyAllowEditing
Gets or sets a value indicating whether [allow editing].
Public propertyAutoSize
Gets or sets a value indicating whether the annotation will automatically resize to fit the text.
Public propertyBounds
Gets the bounding rectangle for the annotation.
(Inherited from AnnotationUI.)
Public propertyCanMirror
Gets or sets a value indicating whether can mirror.
(Inherited from AnnotationUI.)
Public propertyCanMove
Gets or sets a value indicating whether can move.
(Inherited from AnnotationUI.)
Public propertyCanResize
Gets or sets a value indicating whether can resize.
(Inherited from AnnotationUI.)
Public propertyCanRotate
Gets or sets a value indicating whether can rotate.
(Inherited from AnnotationUI.)
Public propertyCanSelect
Gets or sets a value indicating whether can select.
(Inherited from AnnotationUI.)
Public propertyContextMenu
Gets or sets a ContextMenu object that will be displayed when the user right-clicks on the annotation.
(Inherited from AnnotationUI.)
Public propertyContextMenuStrip
Gets or sets a ContextMenuStrip object that will be displayed when the user right-clicks on the annotation.
(Inherited from AnnotationUI.)
Public propertyController
Gets the AnnotationController for this annotation.
(Inherited from AnnotationUI.)
Public propertyCreationTime
Gets or sets the creation time.
(Inherited from AnnotationUI.)
Public propertyData
Gets the AnnotationData object associated with this annotation.
(Inherited from AnnotationUI.)
Public propertyEditMode
Gets or sets a value indicating whether the annotation text is currently in edit mode.
Public propertyFill
Gets or sets the brush used to fill the text area of the annotation.
Public propertyFont
Gets or sets the font used to render the text.
Public propertyFontBrush
Gets or sets the brush used to render the text.
Public propertyGrips
Gets the grips used for the annotation.
(Inherited from AnnotationUI.)
Public propertyHitTestRectangle
Gets a rectangle used for hit testing or RectangleF.Empty to use the default hit testing method.
(Inherited from AnnotationUI.)
Public propertyLeader
Gets or sets the pen used for the line of the annotation.
Public propertyLeaderFlatLength
Gets or sets the length of the leader line to the bend.
Public propertyLocation
Gets or sets the location of the annotation in document space.
(Inherited from AnnotationUI.)
Public propertyModifiedTime
Gets or sets the modification time.
(Inherited from AnnotationUI.)
Public propertyName
Gets or sets the name.
(Inherited from AnnotationUI.)
Public propertyOutline
Gets or sets the pen used to outline the text area of the annotation.
Public propertyParentLayer
Gets or sets the LayerAnnotation that contains this annotation.
(Inherited from AnnotationUI.)
Public propertyRotation
Gets or sets the rotation.
(Inherited from AnnotationUI.)
Public propertySecurity
Gets or sets the security.
(Inherited from AnnotationUI.)
Public propertySelected
Gets or sets a value indicating whether this annotation the selected.
(Inherited from AnnotationUI.)
Public propertySize
Gets or sets the size of the annotation.
(Inherited from AnnotationUI.)
Public propertyState
Gets or sets the current state of the annotation.
(Inherited from AnnotationUI.)
Public propertyTargetPosition
Gets or sets the position on the document the line will point to.
Public propertyText
Gets or sets the text of the annotation.
Public propertyToolTip
Gets or sets the tool tip.
(Inherited from AnnotationUI.)
Public propertyTransform
Gets or sets the transform.
(Inherited from AnnotationUI.)
Public propertyUserName
Gets or sets the name of the user.
(Inherited from AnnotationUI.)
Public propertyVisible
Gets or sets a value indicating whether the annotation is visible.
(Inherited from AnnotationUI.)
Top
Methods
  NameDescription
Protected methodCode exampleAddGripsToRegion
Adds the annotation grips to a region. The grips are added in annotation space.
(Inherited from AnnotationUI.)
Protected methodCode exampleApplyRegionTransform
Use this method to convert a region from annotation space to document or view space.
(Inherited from AnnotationUI.)
Public methodBeginCreate (Overrides AnnotationUIBeginCreate.)
Public methodClone
Creates a copy of this annotation.
(Overrides AnnotationUIClone.)
Protected methodCreateRenderTransform
Returns the Matrix used by the renderer to transform the annotation.
(Inherited from AnnotationUI.)
Public methodDispose
Releases resources used by the annotation.
Protected methodDispose(Boolean)
Releases resources used by the annotation.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Finalizes an instance of the CalloutAnnotation class.
(Overrides ObjectFinalize.)
Public methodGetConfinedGripPosition
Gets the confined grip position.
(Inherited from AnnotationUI.)
Public methodGetConfinedLocation(RectangleF, PointF)
Returns the new confined location of the annotation when a confinement bounds and new location offset are provided.
(Overrides AnnotationUIGetConfinedLocation(RectangleF, PointF).)
Protected methodGetConfinedLocation(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.

(Inherited from AnnotationUI.)
Public methodGetConfinedRotation
Gets the confined rotation.
(Inherited from AnnotationUI.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Fills a SerializationInfo object with information about this annotation.
(Inherited from AnnotationUI.)
Protected methodGetOnePixel
Returns the equivalent of 1 pixel in resolution units.
(Inherited from AnnotationUI.)
Public methodGetRegion (Overrides AnnotationUIGetRegion(AnnotateSpace).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodGetViewerParameters
This method is used to get information about the viewer where the annotations are rendered, including resolution, zoom (scale) level and scrollbar position.
(Inherited from AnnotationUI.)
Protected methodCode exampleHideEditDialog
Removes the edit control from the viewer.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMirror
Mirrors (flips) the annotation horizontally or vertically.
(Inherited from AnnotationUI.)
Protected methodOnAnnotationControllerNotification
Called after a property of the annotation or related AnnotationData has been modified.
(Inherited from AnnotationUI.)
Protected methodOnClick
Called when the user has clicked on the annotation.
(Inherited from AnnotationUI.)
Protected methodOnControllerChanged
Called when the Controller property has changed.
(Inherited from AnnotationUI.)
Protected methodOnDoubleClick (Overrides AnnotationUIOnDoubleClick(EventArgs).)
Protected methodOnGripPositionChanged (Overrides AnnotationUIOnGripPositionChanged(AnnotationGripChangedEventArgs).)
Protected methodOnMirror
Called when the grips of an annotation have been dragged past the opposite grip.
(Inherited from AnnotationUI.)
Protected methodOnMouseDown (Overrides AnnotationUIOnMouseDown(AnnotationMouseEventArgs).)
Protected methodOnMouseEnter
Called when the mouse is moved into the annotation region.
(Inherited from AnnotationUI.)
Protected methodOnMouseExit
Called when the mouse is moved out of the annotation region.
(Inherited from AnnotationUI.)
Protected methodOnMouseMove (Overrides AnnotationUIOnMouseMove(AnnotationMouseEventArgs).)
Protected methodOnMouseUp (Overrides AnnotationUIOnMouseUp(AnnotationMouseEventArgs).)
Protected methodOnMoved
Called when a move to a new location has completed.
(Inherited from AnnotationUI.)
Protected methodOnMoving (Overrides AnnotationUIOnMoving(AnnotationLocationChangedEventArgs).)
Protected methodOnPropertyChanged
Called when a property value has changed and raises the PropertyChanged event.
(Inherited from AnnotationUI.)
Protected methodOnPropertyChanging (Overrides AnnotationUIOnPropertyChanging(AnnotationPropertyChangingEventArgs).)
Protected methodOnResized
Called when a resize on the annotation has completed.
(Inherited from AnnotationUI.)
Protected methodOnResizing (Overrides AnnotationUIOnResizing(EventArgs).)
Protected methodOnRotate
Called when the Rotate(Single) method is called on the annotation.
(Inherited from AnnotationUI.)
Protected methodOnRotated
Called when the annotation has been rotated by the user.
(Inherited from AnnotationUI.)
Protected methodOnRotateDocument
Called when the RotateDocument(DocumentRotation, Int32) method is used.
(Overrides AnnotationUIOnRotateDocument(DocumentRotation).)
Protected methodOnRotating
Called while an annotation is being rotated by the user.
(Overrides AnnotationUIOnRotating(EventArgs).)
Protected methodOnScrollPositionChanged (Overrides AnnotationUIOnScrollPositionChanged(ScrollPositionChangedEventArgs).)
Protected methodOnSelectedChanged (Overrides AnnotationUIOnSelectedChanged(EventArgs).)
Protected methodOnSizeChanged
Called when the Size property of the annotation has changed.
(Inherited from AnnotationUI.)
Public methodRaiseClickEvent
Use this method to force a Click event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseDoubleClickEvent
Use this method to force a DoubleClick event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseGripPositionChangedEvent
Use this method to force a GripPositionChanged event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseMouseDownEvent
Use this method to force a MouseDown event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseMouseEnterEvent
Use to force the MouseEnter event for the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseMouseExitEvent
Use to force a MouseExit event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseMouseMoveEvent
Use this method to force a MouseMove event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseMouseUpEvent
Use this method to force a MouseUp event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseMovedEvent
Use this method to force a Moved event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseMovingEvent
Use this method to force a Moving event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseOnRotateDocument
Use this method to force the OnRotateDocument(DocumentRotation) method to be called.
(Inherited from AnnotationUI.)
Public methodRaiseResizedEvent
Use this method to force a Resized event on the annotation.
(Inherited from AnnotationUI.)
Public methodRaiseRotatedEvent
This method invokes the Rotated event.
(Inherited from AnnotationUI.)
Public methodRaiseScrollPositionChangedEvent
Use this method to force the OnScrollPositionChanged(ScrollPositionChangedEventArgs) method to be called.
(Inherited from AnnotationUI.)
Public methodRemove
Forces the annotation to remove itself from its parent layer.
(Inherited from AnnotationUI.)
Public methodRotate
Rotates the annotation by the specified number of degrees.
(Inherited from AnnotationUI.)
Protected methodSetGrips
Sets the grips used by the annotation.
(Inherited from AnnotationUI.)
Protected methodShowEditDialog
Adds an edit control to the viewer to allow the user to change the text.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodTransformRectangle
Applies the render transformation matrix to a rectangle.
(Inherited from AnnotationUI.)
Top
Events
  NameDescription
Public eventAnnotationControllerNotification
Raised after a property value has been changed.
(Inherited from AnnotationUI.)
Public eventClick
Raised when the annotation has been clicked with the mouse.
(Inherited from AnnotationUI.)
Public eventDoubleClick
Raised when the annotation has been double-clicked with the mouse.
(Inherited from AnnotationUI.)
Public eventGripPositionChanged
Raised when a grip for the annotation has been moved.
(Inherited from AnnotationUI.)
Public eventMouseDown
Raised when a mouse button is pressed while on top of the annotation.
(Inherited from AnnotationUI.)
Public eventMouseEnter
Raised when the mouse enters the annotation region.
(Inherited from AnnotationUI.)
Public eventMouseExit
Raised when the mouse exists the annotation region.
(Inherited from AnnotationUI.)
Public eventMouseMove
Raised when the mouse is moved over the annotation.
(Inherited from AnnotationUI.)
Public eventMouseUp
Raised when the mouse button is released from an annotation.
(Inherited from AnnotationUI.)
Public eventMoved
Raised when the annotation has been moved.
(Inherited from AnnotationUI.)
Public eventMoving
Raised while the annotation is being moved.
(Inherited from AnnotationUI.)
Public eventPropertyChanged
Raised when a property value has changed.
(Inherited from AnnotationUI.)
Public eventPropertyChanging
Raised when a property of the annotation or AnnotationData is going to be changed.
(Inherited from AnnotationUI.)
Public eventResized
Raised when the annotation has been resized.
(Inherited from AnnotationUI.)
Public eventResizing
Raised while the annotation is being resized.
(Inherited from AnnotationUI.)
Public eventRotated
Raised after the annotation has been rotated by the user.
(Inherited from AnnotationUI.)
Public eventRotating
Raise while an annotation is being rotated.
(Inherited from AnnotationUI.)
Public eventSelectedChanged
Raised when the Selected property changes.
(Inherited from AnnotationUI.)
Top
See Also