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.
Namespace: Atalasoft.Annotate.UI
The CalloutAnnotation type exposes the following members.
Name | Description | |
---|---|---|
CalloutAnnotation | Creates a new instance of CalloutAnnotation. | |
CalloutAnnotation(String) | Creates a new instance of CalloutAnnotation specifying the text for the annotation.
| |
CalloutAnnotation(CalloutData) | Creates a new instance of CalloutAnnotation specifying the CalloutData
object used by the annotation. | |
CalloutAnnotation(SerializationInfo, StreamingContext) | Creates a new instance of CalloutAnnotation from serialized information. | |
CalloutAnnotation(String, AnnotationFont, AnnotationBrush, Single) | Creates a new instance of CalloutAnnotation specifying the text, font and font brush for
the annotation. | |
CalloutAnnotation(String, AnnotationFont, AnnotationBrush, Single, AnnotationBrush, AnnotationPen, AnnotationPen, Single) | Creates a new instance of CalloutAnnotation specifying the text, font, font brush,
outline and line pen. | |
CalloutAnnotation(String, AnnotationFont, AnnotationBrush, Single, AnnotationBrush, AnnotationPen, AnnotationPen, Single, PointF, Boolean) | Creates a new instance of CalloutAnnotation specifying its parameters. |
Name | Description | |
---|---|---|
AllowEditing |
Gets or sets a value indicating whether [allow editing].
| |
AutoSize | Gets or sets a value indicating whether the annotation will automatically resize to fit the text.
| |
Bounds | Gets the bounding rectangle for the annotation. (Inherited from AnnotationUI.) | |
CanMirror |
Gets or sets a value indicating whether can mirror.
(Inherited from AnnotationUI.) | |
CanMove |
Gets or sets a value indicating whether can move.
(Inherited from AnnotationUI.) | |
CanResize |
Gets or sets a value indicating whether can resize.
(Inherited from AnnotationUI.) | |
CanRotate |
Gets or sets a value indicating whether can rotate.
(Inherited from AnnotationUI.) | |
CanSelect |
Gets or sets a value indicating whether can select.
(Inherited from AnnotationUI.) | |
ContextMenu | Gets or sets a ContextMenu object that will be displayed when the user right-clicks on
the annotation. (Inherited from AnnotationUI.) | |
ContextMenuStrip | Gets or sets a ContextMenuStrip object that will be displayed when the user right-clicks
on the annotation. (Inherited from AnnotationUI.) | |
Controller | Gets the AnnotationController for this annotation. (Inherited from AnnotationUI.) | |
CreationTime |
Gets or sets the creation time.
(Inherited from AnnotationUI.) | |
Data | Gets the AnnotationData object associated with this annotation. (Inherited from AnnotationUI.) | |
EditMode | Gets or sets a value indicating whether the annotation text is currently in edit mode. | |
Fill | Gets or sets the brush used to fill the text area of the annotation. | |
Font | Gets or sets the font used to render the text. | |
FontBrush | Gets or sets the brush used to render the text. | |
Grips | Gets the grips used for the annotation. (Inherited from AnnotationUI.) | |
HitTestRectangle | Gets a rectangle used for hit testing or RectangleF.Empty to use the default hit testing
method. (Inherited from AnnotationUI.) | |
Leader | Gets or sets the pen used for the line of the annotation. | |
LeaderFlatLength | Gets or sets the length of the leader line to the bend. | |
Location | Gets or sets the location of the annotation in document space. (Inherited from AnnotationUI.) | |
ModifiedTime |
Gets or sets the modification time.
(Inherited from AnnotationUI.) | |
Name |
Gets or sets the name.
(Inherited from AnnotationUI.) | |
Outline | Gets or sets the pen used to outline the text area of the annotation. | |
ParentLayer | Gets or sets the LayerAnnotation that contains this annotation. (Inherited from AnnotationUI.) | |
Rotation |
Gets or sets the rotation.
(Inherited from AnnotationUI.) | |
Security |
Gets or sets the security.
(Inherited from AnnotationUI.) | |
Selected | Gets or sets a value indicating whether this annotation the selected. (Inherited from AnnotationUI.) | |
Size | Gets or sets the size of the annotation. (Inherited from AnnotationUI.) | |
State | Gets or sets the current state of the annotation. (Inherited from AnnotationUI.) | |
TargetPosition | Gets or sets the position on the document the line will point to. | |
Text | Gets or sets the text of the annotation. | |
ToolTip |
Gets or sets the tool tip.
(Inherited from AnnotationUI.) | |
Transform |
Gets or sets the transform.
(Inherited from AnnotationUI.) | |
UserName |
Gets or sets the name of the user.
(Inherited from AnnotationUI.) | |
Visible | Gets or sets a value indicating whether the annotation is visible. (Inherited from AnnotationUI.) |
Name | Description | |
---|---|---|
AddGripsToRegion |
Adds the annotation grips to a region. The grips are added in annotation space.
(Inherited from AnnotationUI.) | |
ApplyRegionTransform |
Use this method to convert a region from annotation space to document or view
space.
(Inherited from AnnotationUI.) | |
BeginCreate | (Overrides AnnotationUIBeginCreate.) | |
Clone |
Creates a copy of this annotation.
(Overrides AnnotationUIClone.) | |
CreateRenderTransform | Returns the Matrix used by the renderer to transform the annotation. (Inherited from AnnotationUI.) | |
Dispose | Releases resources used by the annotation. | |
Dispose(Boolean) | Releases resources used by the annotation. | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
Finalizes an instance of the CalloutAnnotation class.
(Overrides ObjectFinalize.) | |
GetConfinedGripPosition |
Gets the confined grip position.
(Inherited from AnnotationUI.) | |
GetConfinedLocation(RectangleF, PointF) |
Returns the new confined location of the annotation when a confinement bounds and new location offset are
provided.
(Overrides AnnotationUIGetConfinedLocation(RectangleF, PointF).) | |
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.
(Inherited from AnnotationUI.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetObjectData | Fills a SerializationInfo object with information about this annotation. (Inherited from AnnotationUI.) | |
GetOnePixel | Returns the equivalent of 1 pixel in resolution units. (Inherited from AnnotationUI.) | |
GetRegion | (Overrides AnnotationUIGetRegion(AnnotateSpace).) | |
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. (Inherited from AnnotationUI.) | |
HideEditDialog | Removes the edit control from the viewer. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Mirror | Mirrors (flips) the annotation horizontally or vertically. (Inherited from AnnotationUI.) | |
OnAnnotationControllerNotification | Called after a property of the annotation or related AnnotationData has been modified.
(Inherited from AnnotationUI.) | |
OnClick | Called when the user has clicked on the annotation. (Inherited from AnnotationUI.) | |
OnControllerChanged | Called when the Controller property has changed. (Inherited from AnnotationUI.) | |
OnDoubleClick | (Overrides AnnotationUIOnDoubleClick(EventArgs).) | |
OnGripPositionChanged | (Overrides AnnotationUIOnGripPositionChanged(AnnotationGripChangedEventArgs).) | |
OnMirror | Called when the grips of an annotation have been dragged past the opposite grip. (Inherited from AnnotationUI.) | |
OnMouseDown | (Overrides AnnotationUIOnMouseDown(AnnotationMouseEventArgs).) | |
OnMouseEnter | Called when the mouse is moved into the annotation region. (Inherited from AnnotationUI.) | |
OnMouseExit | Called when the mouse is moved out of the annotation region. (Inherited from AnnotationUI.) | |
OnMouseMove | (Overrides AnnotationUIOnMouseMove(AnnotationMouseEventArgs).) | |
OnMouseUp | (Overrides AnnotationUIOnMouseUp(AnnotationMouseEventArgs).) | |
OnMoved | Called when a move to a new location has completed. (Inherited from AnnotationUI.) | |
OnMoving | (Overrides AnnotationUIOnMoving(AnnotationLocationChangedEventArgs).) | |
OnPropertyChanged | Called when a property value has changed and raises the PropertyChanged event.
(Inherited from AnnotationUI.) | |
OnPropertyChanging | (Overrides AnnotationUIOnPropertyChanging(AnnotationPropertyChangingEventArgs).) | |
OnResized | Called when a resize on the annotation has completed. (Inherited from AnnotationUI.) | |
OnResizing | (Overrides AnnotationUIOnResizing(EventArgs).) | |
OnRotate | Called when the Rotate(Single) method is called on the annotation. (Inherited from AnnotationUI.) | |
OnRotated | Called when the annotation has been rotated by the user. (Inherited from AnnotationUI.) | |
OnRotateDocument |
Called when the RotateDocument(DocumentRotation, Int32) method is used.
(Overrides AnnotationUIOnRotateDocument(DocumentRotation).) | |
OnRotating |
Called while an annotation is being rotated by the user.
(Overrides AnnotationUIOnRotating(EventArgs).) | |
OnScrollPositionChanged | (Overrides AnnotationUIOnScrollPositionChanged(ScrollPositionChangedEventArgs).) | |
OnSelectedChanged | (Overrides AnnotationUIOnSelectedChanged(EventArgs).) | |
OnSizeChanged | Called when the Size property of the annotation has changed. (Inherited from AnnotationUI.) | |
RaiseClickEvent | Use this method to force a Click event on the annotation. (Inherited from AnnotationUI.) | |
RaiseDoubleClickEvent | Use this method to force a DoubleClick event on the annotation. (Inherited from AnnotationUI.) | |
RaiseGripPositionChangedEvent | Use this method to force a GripPositionChanged event on the annotation.
(Inherited from AnnotationUI.) | |
RaiseMouseDownEvent | Use this method to force a MouseDown event on the annotation. (Inherited from AnnotationUI.) | |
RaiseMouseEnterEvent | Use to force the MouseEnter event for the annotation. (Inherited from AnnotationUI.) | |
RaiseMouseExitEvent | Use to force a MouseExit event on the annotation. (Inherited from AnnotationUI.) | |
RaiseMouseMoveEvent | Use this method to force a MouseMove event on the annotation. (Inherited from AnnotationUI.) | |
RaiseMouseUpEvent | Use this method to force a MouseUp event on the annotation. (Inherited from AnnotationUI.) | |
RaiseMovedEvent | Use this method to force a Moved event on the annotation. (Inherited from AnnotationUI.) | |
RaiseMovingEvent | Use this method to force a Moving event on the annotation. (Inherited from AnnotationUI.) | |
RaiseOnRotateDocument | Use this method to force the OnRotateDocument(DocumentRotation) method to be called. (Inherited from AnnotationUI.) | |
RaiseResizedEvent | Use this method to force a Resized event on the annotation. (Inherited from AnnotationUI.) | |
RaiseRotatedEvent | This method invokes the Rotated event. (Inherited from AnnotationUI.) | |
RaiseScrollPositionChangedEvent | Use this method to force the OnScrollPositionChanged(ScrollPositionChangedEventArgs) method to be called.
(Inherited from AnnotationUI.) | |
Remove | Forces the annotation to remove itself from its parent layer. (Inherited from AnnotationUI.) | |
Rotate | Rotates the annotation by the specified number of degrees. (Inherited from AnnotationUI.) | |
SetGrips | Sets the grips used by the annotation. (Inherited from AnnotationUI.) | |
ShowEditDialog | Adds an edit control to the viewer to allow the user to change the text. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TransformRectangle | Applies the render transformation matrix to a rectangle. (Inherited from AnnotationUI.) |
Name | Description | |
---|---|---|
AnnotationControllerNotification | Raised after a property value has been changed. (Inherited from AnnotationUI.) | |
Click | Raised when the annotation has been clicked with the mouse. (Inherited from AnnotationUI.) | |
DoubleClick | Raised when the annotation has been double-clicked with the mouse. (Inherited from AnnotationUI.) | |
GripPositionChanged | Raised when a grip for the annotation has been moved. (Inherited from AnnotationUI.) | |
MouseDown | Raised when a mouse button is pressed while on top of the annotation. (Inherited from AnnotationUI.) | |
MouseEnter | Raised when the mouse enters the annotation region. (Inherited from AnnotationUI.) | |
MouseExit | Raised when the mouse exists the annotation region. (Inherited from AnnotationUI.) | |
MouseMove | Raised when the mouse is moved over the annotation. (Inherited from AnnotationUI.) | |
MouseUp | Raised when the mouse button is released from an annotation. (Inherited from AnnotationUI.) | |
Moved | Raised when the annotation has been moved. (Inherited from AnnotationUI.) | |
Moving | Raised while the annotation is being moved. (Inherited from AnnotationUI.) | |
PropertyChanged | Raised when a property value has changed. (Inherited from AnnotationUI.) | |
PropertyChanging | Raised when a property of the annotation or AnnotationData is going to be changed.
(Inherited from AnnotationUI.) | |
Resized | Raised when the annotation has been resized. (Inherited from AnnotationUI.) | |
Resizing | Raised while the annotation is being resized. (Inherited from AnnotationUI.) | |
Rotated |
Raised after the annotation has been rotated by the user.
(Inherited from AnnotationUI.) | |
Rotating | Raise while an annotation is being rotated. (Inherited from AnnotationUI.) | |
SelectedChanged | Raised when the Selected property changes. (Inherited from AnnotationUI.) |