Click or drag to resize

WpfCalloutAnnotation 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 centers the annotation over the target. With the mouse still pressed, drag the annotation to the desired location. Both annotation and leader point can be repositioned independently after the annotation has been created.
Inheritance Hierarchy

Namespace:  Atalasoft.Annotate.Wpf
Assembly:  Atalasoft.dotImage.Wpf (in Atalasoft.dotImage.Wpf.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class WpfCalloutAnnotation : WpfAnnotationUI

The WpfCalloutAnnotation type exposes the following members.

Constructors
  NameDescription
Public methodWpfCalloutAnnotation
Creates a new instance WpfCalloutAnnotation using default values.
Public methodWpfCalloutAnnotation(CalloutData)
Creates a new instance of WpfCalloutAnnotation from a CalloutData object.
Public methodWpfCalloutAnnotation(String, AnnotationFont, AnnotationBrush, AnnotationPen, Double, AnnotationBrush, AnnotationPen)
Creates a new instance of WpfCalloutAnnotation specifying its more common properties.
Public methodWpfCalloutAnnotation(Rect, Point, String, AnnotationFont, AnnotationBrush, AnnotationPen, Double, AnnotationBrush, AnnotationPen, AnnotationBrush, Point, Double, StringAlignment, StringAlignment)
Creates a new instance of WpfCalloutAnnotation specifying its properties.
Top
Properties
  NameDescription
Public propertyAlignment
Gets or sets the horizontal text alignment.
Public propertyAllowEditing
Gets or sets a value indicating whether the annotation text can be edited by double-clicking on the annotation.
Public propertyBounds
Gets the bounding rectangle of this annotation.
(Inherited from WpfAnnotationUI.)
Public propertyCanEditMirrored
Gets or sets a value indicating whether the text can be edited mirrored.
Public propertyCanEditRotated
Gets or sets a value indicating whether the text can be edited rotated.
Public propertyCanMirror
Gets or sets a value indicating whether the annotation can be mirrored by the end-user.
(Inherited from WpfAnnotationUI.)
Public propertyCanMove
Gets or sets a value indicating whether the annotation can be moved by the end-user.
(Inherited from WpfAnnotationUI.)
Public propertyCanResize
Gets or sets a value indicating whether the annotation can be resized by the end-user.
(Inherited from WpfAnnotationUI.)
Public propertyCanRotate
Gets or sets a value indicating whether the annotation can be rotated by the end-user.
(Inherited from WpfAnnotationUI.)
Public propertyCanSelect
Gets or sets a value indicating whether the annotation can be selected by the end-user.
(Inherited from WpfAnnotationUI.)
Public propertyCanvas
Gets the WpfAnnotationCanvas class hosting this annotation.
(Inherited from WpfAnnotationUI.)
Public propertyCenterOfRotation
Gets the point used as center of rotation for the annotation.
(Inherited from WpfAnnotationUI.)
Public propertyChildElement
Gets the child UIElement of the annotation, if any.
(Overrides WpfAnnotationUIChildElement.)
Public propertyCreationTime
Gets or sets the creation time of the annotation.
(Inherited from WpfAnnotationUI.)
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyEditMode
Gets or sets a value indicating whether the annotation is in 'Edit Mode'.
Public propertyFill
Gets or sets the brush used to fill 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 font.
Public propertyGeometry
Gets a Geometry representing the annotation.
(Overrides WpfAnnotationUIGeometry.)
Public propertyGrips
Gets the grips for this annotation.
(Inherited from WpfAnnotationUI.)
Public propertyIsGrouped
Gets a value indicating whether the annotation is being hosted within a group.
(Inherited from WpfAnnotationUI.)
Public propertyIsMirroredHorizontally
Gets a value indicating whether the annotation is mirrored horizontally.
(Inherited from WpfAnnotationUI.)
Public propertyIsMirroredVertically
Gets a value indicating whether the annotation is mirrored vertically.
(Inherited from WpfAnnotationUI.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyIsVisible
Gets or sets a value indicating whether the annotation is visible.
(Inherited from WpfAnnotationUI.)
Public propertyLeader
Gets or sets the pen used for the leader line.
Public propertyLeaderFlatLength
Gets or sets the length of the leader line to the bend.
Public propertyLineAlignment
Gets or sets the vertical text alignment.
Public propertyLocation
Gets or sets the location of the annotation in document space.
(Inherited from WpfAnnotationUI.)
Public propertyModifiedTime
Gets or sets the last time the annotation was modified.
(Inherited from WpfAnnotationUI.)
Public propertyName
Gets or sets the name for the annotation.
(Inherited from WpfAnnotationUI.)
Public propertyOutline
Gets or sets the pen used for the annotation outline.
Public propertyPadding
Gets or sets the amount of padding around the text.
Public propertyParentLayer
Gets the parent layer of this annotation, if any.
(Inherited from WpfAnnotationUI.)
Public propertyRenderedBounds
Gets the bounding rectangle of the annotation including any transformations applied for rendering.
(Inherited from WpfAnnotationUI.)
Public propertyRenderTransform
Gets the transform used when rendering the annotation.
(Inherited from WpfAnnotationUI.)
Public propertyRotation
Gets or sets the amount of rotation applied to the annotation.
(Inherited from WpfAnnotationUI.)
Public propertySecurity
Gets or sets the security for the annotation.
(Inherited from WpfAnnotationUI.)
Public propertySelected
Gets or sets a value indicating whether the annotation is selected.
(Inherited from WpfAnnotationUI.)
Public propertyShadow
Gets or sets the brush used for the annotation shadow.
Public propertyShadowOffset
Gets or sets the offset used to position the shadow.
Public propertySize
Gets or sets the size of the annotation.
(Inherited from WpfAnnotationUI.)
Public propertyState
Gets or sets the annotation state.
(Inherited from WpfAnnotationUI.)
Public propertySupportsMultiClickCreation
Gets a value indicating whether the annotation supports being created from multiple mouse clicks.
(Inherited from WpfAnnotationUI.)
Public propertyTargetPosition
Gets or sets the position of the target in document space.
Public propertyText
Gets or sets the annotation text.
Public propertyToolTip
Gets or sets a tooltip to use for the annotation.
(Inherited from WpfAnnotationUI.)
Public propertyUserHasCreated
Gets a value indicating if the annotation was end-user created or added directly to a layer.
(Inherited from WpfAnnotationUI.)
Public propertyUserName
Gets or sets the username for this annotation.
(Inherited from WpfAnnotationUI.)
Protected propertyVisualBitmapEffect Obsolete.
Gets or sets the BitmapEffect value for the Visual.
(Inherited from Visual.)
Protected propertyVisualBitmapEffectInput Obsolete.
Gets or sets the BitmapEffectInput value for the Visual.
(Inherited from Visual.)
Protected propertyVisualBitmapScalingMode
Gets or sets the BitmapScalingMode for the Visual.
(Inherited from Visual.)
Protected propertyVisualCacheMode
Gets or sets a cached representation of the Visual.
(Inherited from Visual.)
Protected propertyVisualChildrenCount
Gets the number of child elements for the Visual.
(Inherited from Visual.)
Protected propertyVisualClearTypeHint
Gets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual.
(Inherited from Visual.)
Protected propertyVisualClip
Gets or sets the clip region of the Visual as a Geometry value.
(Inherited from Visual.)
Protected propertyVisualEdgeMode
Gets or sets the edge mode of the Visual as an EdgeMode value.
(Inherited from Visual.)
Protected propertyVisualEffect
Gets or sets the bitmap effect to apply to the Visual.
(Inherited from Visual.)
Protected propertyVisualOffset
Gets or sets the offset value of the visual object.
(Inherited from Visual.)
Protected propertyVisualOpacity
Gets or sets the opacity of the Visual.
(Inherited from Visual.)
Protected propertyVisualOpacityMask
Gets or sets the Brush value that represents the opacity mask of the Visual.
(Inherited from Visual.)
Protected propertyVisualParent
Gets the visual tree parent of the visual object.
(Inherited from Visual.)
Protected propertyVisualScrollableAreaClip
Gets or sets a clipped scrollable area for the Visual.
(Inherited from Visual.)
Protected propertyVisualTextHintingMode
Gets or sets the TextHintingMode of the Visual.
(Inherited from Visual.)
Protected propertyVisualTextRenderingMode
Gets or sets the TextRenderingMode of the Visual.
(Inherited from Visual.)
Protected propertyVisualTransform
Gets or sets the Transform value for the Visual.
(Inherited from Visual.)
Protected propertyVisualXSnappingGuidelines
Gets or sets the x-coordinate (vertical) guideline collection.
(Inherited from Visual.)
Protected propertyVisualYSnappingGuidelines
Gets or sets the y-coordinate (horizontal) guideline collection.
(Inherited from Visual.)
Top
Methods
  NameDescription
Protected methodAddVisualChild
Defines the parent-child relationship between two visuals.
(Inherited from Visual.)
Public methodAttachGrips
This method is called by the WpfAnnotationCanvas to ask the annotation for Grip creation.
(Inherited from WpfAnnotationUI.)
Protected methodAttachGripsOverride
Called when the annotation grips need to be created.
(Overrides WpfAnnotationUIAttachGripsOverride(WpfAnnotationCanvas).)
Protected methodCalculateGeometry
Calculates the geometry of the annotation with the specified parameters.
(Inherited from WpfAnnotationUI.)
Public methodCheckAccess
Determines whether the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
Creates a copy of the anotation.
(Inherited from WpfAnnotationUI.)
Protected methodCloneOverride
Derived classes must override this method and return a copy of itself.
(Overrides WpfAnnotationUICloneOverride(WpfAnnotationUI).)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
Public methodCreateDataSnapshot
This method creates an AnnotationData copy of this annotation for serialization.
(Inherited from WpfAnnotationUI.)
Protected methodCreateDataSnapshotOverride
This method is used to serialize the annotation.
(Overrides WpfAnnotationUICreateDataSnapshotOverride.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindCommonVisualAncestor
Returns the common ancestor of two visual objects.
(Inherited from Visual.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLeaderPoints
Returns an array of Point used to render the leader line.
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Protected methodGetVisualChild
Returns the specified Visual in the parent VisualCollection.
(Inherited from Visual.)
Protected methodHideEditBox
Called when the edit box needs to be hidden from the user.
Public methodHitTest
This method will determine whether the specified point is on the annotation.
(Inherited from WpfAnnotationUI.)
Protected methodHitTestCore(PointHitTestParameters)
Determines whether a point coordinate value is within the bounds of the visual object.
(Inherited from WpfAnnotationUI.)
Protected methodHitTestCore(GeometryHitTestParameters)
Determines whether a geometry value is within the bounds of the visual object.
(Inherited from Visual.)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Protected methodInvalidateVisual
Forces the annotation to redraw itself.
(Inherited from WpfAnnotationUI.)
Public methodIsAncestorOf
Determines whether the visual object is an ancestor of the descendant visual object.
(Inherited from Visual.)
Public methodIsDescendantOf
Determines whether the visual object is a descendant of the ancestor visual object.
(Inherited from Visual.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMirror
Mirrors the annotation in the specified direction.
(Inherited from WpfAnnotationUI.)
Protected methodOnAnnotationBrushChanged
Called when the FillProperty has changed.
(Overrides WpfAnnotationUIOnAnnotationBrushChanged(AnnotationBrush).)
Protected methodOnAnnotationCreated
Called after the annotation has been created.
(Inherited from WpfAnnotationUI.)
Protected methodOnAnnotationFontChanged
Called when the FontProperty has changed.
(Overrides WpfAnnotationUIOnAnnotationFontChanged(AnnotationFont).)
Protected methodOnAnnotationPenChanged
Called when the OutlineProperty has changed.
(Overrides WpfAnnotationUIOnAnnotationPenChanged(AnnotationPen).)
Protected methodOnCanvasChanged
Called when the Canvas property has changed.
(Inherited from WpfAnnotationUI.)
Protected methodOnGripPositionChanged
Called when a grip for the annotation has moved.
(Overrides WpfAnnotationUIOnGripPositionChanged(EventArgsWpfAnnotationGrip).)
Protected methodOnMouseDown
Called when a MouseDown event has been raised for the annotation.
(Overrides WpfAnnotationUIOnMouseDown(MouseButtonEventArgs).)
Protected methodOnMouseMove
Called when a MouseMove event has been raised for the annotation.
(Overrides WpfAnnotationUIOnMouseMove(MouseEventArgs).)
Protected methodOnMouseUp
Called when a MouseUp event has been raised for the annotation.
(Overrides WpfAnnotationUIOnMouseUp(MouseButtonEventArgs).)
Protected methodOnPropertyChanged
Raises the PropertyChanged event.
(Overrides WpfAnnotationUIOnPropertyChanged(DependencyPropertyChangedEventArgs).)
Protected methodOnRotateDocument
Called when the document has been rotated.
(Inherited from WpfAnnotationUI.)
Protected methodOnSelectedChanged
Called when the Selected property has been changed.
(Overrides WpfAnnotationUIOnSelectedChanged(EventArgs).)
Protected methodOnVisualChildrenChanged
Called when the VisualCollection of the visual object is modified.
(Inherited from Visual.)
Protected methodOnVisualParentChanged
Called when the parent of the visual object is changed.
(Inherited from Visual.)
Protected methodOperationRequest
Called when a request operation has been raised on the annotation.
(Overrides WpfAnnotationUIOperationRequest(OperationRequestInformation).)
Public methodPointFromScreen
Converts a Point in screen coordinates into a Point that represents the current coordinate system of the Visual.
(Inherited from Visual.)
Public methodPointToScreen
Converts a Point that represents the current coordinate system of the Visual into a Point in screen coordinates.
(Inherited from Visual.)
Public methodPredetermineRenderBounds
This method is used to calculate the expected render bounds of an annotation if its rotation was changed.
(Inherited from WpfAnnotationUI.)
Public methodRaiseEvent
This method is used to force an event in the annotation.
(Inherited from WpfAnnotationUI.)
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRemove
This method will remove the annotation from its parent layer.
(Inherited from WpfAnnotationUI.)
Protected methodRemoveVisualChild
Removes the parent-child relationship between two visuals.
(Inherited from Visual.)
Protected methodReplaceGrips
Call this method to replace the current annotation grips with new grips.
(Inherited from WpfAnnotationUI.)
Public methodResetMirrorVariables
This method will reset the internal Matrix used for mirroring.
(Inherited from WpfAnnotationUI.)
Public methodRotate
This method will append a rotation to the annotation's current rotation.
(Inherited from WpfAnnotationUI.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodSetTransparency
Sets the alpha values for the Fill and Outline of the annotation.
(Inherited from WpfAnnotationUI.)
Protected methodSetUserHasCreated
Derived class should call this method to indicate that their creation process has completed.
(Inherited from WpfAnnotationUI.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Protected methodShouldSerializeProperty
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.
(Inherited from DependencyObject.)
Protected methodShowEditBox
Called when the edit box needs to be shown, allowing the end-user to modify the annotation text.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTransformToAncestor(Visual)
Returns a transform that can be used to transform coordinates from the Visual to the specified Visual ancestor of the visual object.
(Inherited from Visual.)
Public methodTransformToAncestor(Visual3D)
Returns a transform that can be used to transform coordinates from the Visual to the specified Visual3D ancestor of the visual object.
(Inherited from Visual.)
Public methodTransformToDescendant
Returns a transform that can be used to transform coordinates from the Visual to the specified visual object descendant.
(Inherited from Visual.)
Public methodTransformToVisual
Returns a transform that can be used to transform coordinates from the Visual to the specified visual object.
(Inherited from Visual.)
Public methodVerifyAccess
Enforces that the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
Top
Events
  NameDescription
Public eventMouseDown
Event is raised when the left mouse button transitions from up to down while the cursor is over the annotation.
(Inherited from WpfAnnotationUI.)
Public eventMouseUp
Event is raised when the left mouse button transitions from down to up while the cursor is over the annotation.
(Inherited from WpfAnnotationUI.)
Public eventPropertyChanged
This event is raised when a property of the annotation has changed.
(Inherited from WpfAnnotationUI.)
Top
Fields
  NameDescription
Public fieldStatic memberAlignmentProperty
Identifies the Alignment dependency property.
Public fieldStatic memberAllowEditingProperty
Identifies the AllowEditing dependency property.
Public fieldStatic memberCanEditMirroredProperty
Identifies the CanEditMirrored dependency property.
Public fieldStatic memberCanEditRotatedProperty
Identifies the CanEditRotated dependency property.
Public fieldStatic memberEditModeProperty
Identifies the EditMode dependency property.
Public fieldStatic memberFontBrushProperty
Identifies the FontBrush dependency property.
Public fieldStatic memberFontProperty
Identifies the Font dependency property.
Public fieldStatic memberLeaderFlatLengthProperty
Identifies the LeaderFlatLength dependency property.
Public fieldStatic memberLeaderProperty
Identifies the Leader dependency property.
Public fieldStatic memberLineAlignmentProperty
Identifies the LineAlignment dependency property.
Public fieldStatic memberPaddingProperty
Identifies the Padding dependency property.
Public fieldStatic memberTargetPositionProperty
Identifies the TargetPosition dependency property.
Public fieldStatic memberTextProperty
Identifies the Text dependency property.
Top
See Also