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

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        Atalasoft.Annotate.WpfWpfAnnotationUI
          Atalasoft.Annotate.WpfWpfCalloutAnnotation

Namespace: Atalasoft.Annotate.Wpf
Assembly: Atalasoft.dotImage.Wpf (in Atalasoft.dotImage.Wpf.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public class WpfCalloutAnnotation : WpfAnnotationUI

Public Class WpfCalloutAnnotation
	Inherits WpfAnnotationUI

The WpfCalloutAnnotation type exposes the following members.

Constructors

	Name	Description
	WpfCalloutAnnotation	Creates a new instance WpfCalloutAnnotation using default values.
	WpfCalloutAnnotation(CalloutData)	Creates a new instance of WpfCalloutAnnotation from a CalloutData object.
	WpfCalloutAnnotation(String, AnnotationFont, AnnotationBrush, AnnotationPen, Double, AnnotationBrush, AnnotationPen)	Creates a new instance of WpfCalloutAnnotation specifying its more common properties.
	WpfCalloutAnnotation(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

	Name	Description
	Alignment	Gets or sets the horizontal text alignment.
	AllowEditing	Gets or sets a value indicating whether the annotation text can be edited by double-clicking on the annotation.
	Bounds	Gets the bounding rectangle of this annotation. (Inherited from WpfAnnotationUI.)
	CanEditMirrored	Gets or sets a value indicating whether the text can be edited mirrored.
	CanEditRotated	Gets or sets a value indicating whether the text can be edited rotated.
	CanMirror	Gets or sets a value indicating whether the annotation can be mirrored by the end-user. (Inherited from WpfAnnotationUI.)
	CanMove	Gets or sets a value indicating whether the annotation can be moved by the end-user. (Inherited from WpfAnnotationUI.)
	CanResize	Gets or sets a value indicating whether the annotation can be resized by the end-user. (Inherited from WpfAnnotationUI.)
	CanRotate	Gets or sets a value indicating whether the annotation can be rotated by the end-user. (Inherited from WpfAnnotationUI.)
	CanSelect	Gets or sets a value indicating whether the annotation can be selected by the end-user. (Inherited from WpfAnnotationUI.)
	Canvas	Gets the WpfAnnotationCanvas class hosting this annotation. (Inherited from WpfAnnotationUI.)
	CenterOfRotation	Gets the point used as center of rotation for the annotation. (Inherited from WpfAnnotationUI.)
	ChildElement	Gets the child UIElement of the annotation, if any. (Overrides WpfAnnotationUIChildElement.)
	CreationTime	Gets or sets the creation time of the annotation. (Inherited from WpfAnnotationUI.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	EditMode	Gets or sets a value indicating whether the annotation is in 'Edit Mode'.
	ExtraProperties	Gets the annotation extra properties dictionary. (Inherited from WpfAnnotationUI.)
	Fill	Gets or sets the brush used to fill the annotation.
	Font	Gets or sets the font used to render the text.
	FontBrush	Gets or sets the brush used to render the font.
	Geometry	Gets a Geometry representing the annotation. (Overrides WpfAnnotationUIGeometry.)
	Grips	Gets the grips for this annotation. (Inherited from WpfAnnotationUI.)
	IsGrouped	Gets a value indicating whether the annotation is being hosted within a group. (Inherited from WpfAnnotationUI.)
	IsMirroredHorizontally	Gets a value indicating whether the annotation is mirrored horizontally. (Inherited from WpfAnnotationUI.)
	IsMirroredVertically	Gets a value indicating whether the annotation is mirrored vertically. (Inherited from WpfAnnotationUI.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
	IsVisible	Gets or sets a value indicating whether the annotation is visible. (Inherited from WpfAnnotationUI.)
	Leader	Gets or sets the pen used for the leader line.
	LeaderFlatLength	Gets or sets the length of the leader line to the bend.
	LineAlignment	Gets or sets the vertical text alignment.
	Location	Gets or sets the location of the annotation in document space. (Inherited from WpfAnnotationUI.)
	ModifiedTime	Gets or sets the last time the annotation was modified. (Inherited from WpfAnnotationUI.)
	Name	Gets or sets the name for the annotation. (Inherited from WpfAnnotationUI.)
	Outline	Gets or sets the pen used for the annotation outline.
	Padding	Gets or sets the amount of padding around the text.
	ParentLayer	Gets the parent layer of this annotation, if any. (Inherited from WpfAnnotationUI.)
	RenderedBounds	Gets the bounding rectangle of the annotation including any transformations applied for rendering. (Inherited from WpfAnnotationUI.)
	RenderTransform	Gets the transform used when rendering the annotation. (Inherited from WpfAnnotationUI.)
	Rotation	Gets or sets the amount of rotation applied to the annotation. (Inherited from WpfAnnotationUI.)
	Security	Gets or sets the security for the annotation. (Inherited from WpfAnnotationUI.)
	Selected	Gets or sets a value indicating whether the annotation is selected. (Inherited from WpfAnnotationUI.)
	Shadow	Gets or sets the brush used for the annotation shadow.
	ShadowOffset	Gets or sets the offset used to position the shadow.
	Size	Gets or sets the size of the annotation. (Inherited from WpfAnnotationUI.)
	State	Gets or sets the annotation state. (Inherited from WpfAnnotationUI.)
	SupportsMultiClickCreation	Gets a value indicating whether the annotation supports being created from multiple mouse clicks. (Inherited from WpfAnnotationUI.)
	TargetPosition	Gets or sets the position of the target in document space.
	Text	Gets or sets the annotation text.
	ToolTip	Gets or sets a tooltip to use for the annotation. (Inherited from WpfAnnotationUI.)
	UserHasCreated	Gets a value indicating if the annotation was end-user created or added directly to a layer. (Inherited from WpfAnnotationUI.)
	UserName	Gets or sets the username for this annotation. (Inherited from WpfAnnotationUI.)
	VisualBitmapEffect	Obsolete. Gets or sets the BitmapEffect value for the Visual. (Inherited from Visual.)
	VisualBitmapEffectInput	Obsolete. Gets or sets the BitmapEffectInput value for the Visual. (Inherited from Visual.)
	VisualBitmapScalingMode	Gets or sets the BitmapScalingMode for the Visual. (Inherited from Visual.)
	VisualCacheMode	Gets or sets a cached representation of the Visual. (Inherited from Visual.)
	VisualChildrenCount	Gets the number of child elements for the Visual. (Inherited from Visual.)
	VisualClearTypeHint	Gets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual. (Inherited from Visual.)
	VisualClip	Gets or sets the clip region of the Visual as a Geometry value. (Inherited from Visual.)
	VisualEdgeMode	Gets or sets the edge mode of the Visual as an EdgeMode value. (Inherited from Visual.)
	VisualEffect	Gets or sets the bitmap effect to apply to the Visual. (Inherited from Visual.)
	VisualOffset	Gets or sets the offset value of the visual object. (Inherited from Visual.)
	VisualOpacity	Gets or sets the opacity of the Visual. (Inherited from Visual.)
	VisualOpacityMask	Gets or sets the Brush value that represents the opacity mask of the Visual. (Inherited from Visual.)
	VisualParent	Gets the visual tree parent of the visual object. (Inherited from Visual.)
	VisualScrollableAreaClip	Gets or sets a clipped scrollable area for the Visual. (Inherited from Visual.)
	VisualTextHintingMode	Gets or sets the TextHintingMode of the Visual. (Inherited from Visual.)
	VisualTextRenderingMode	Gets or sets the TextRenderingMode of the Visual. (Inherited from Visual.)
	VisualTransform	Gets or sets the Transform value for the Visual. (Inherited from Visual.)
	VisualXSnappingGuidelines	Gets or sets the x-coordinate (vertical) guideline collection. (Inherited from Visual.)
	VisualYSnappingGuidelines	Gets or sets the y-coordinate (horizontal) guideline collection. (Inherited from Visual.)

Top

Methods

	Name	Description
	AddVisualChild	Defines the parent-child relationship between two visuals. (Inherited from Visual.)
	AttachGrips	This method is called by the WpfAnnotationCanvas to ask the annotation for Grip creation. (Inherited from WpfAnnotationUI.)
	AttachGripsOverride	Called when the annotation grips need to be created. (Overrides WpfAnnotationUIAttachGripsOverride(WpfAnnotationCanvas).)
	CalculateGeometry	Calculates the geometry of the annotation with the specified parameters. (Inherited from WpfAnnotationUI.)
	CheckAccess	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone	Creates a copy of the anotation. (Inherited from WpfAnnotationUI.)
	CloneOverride	Derived classes must override this method and return a copy of itself. (Overrides WpfAnnotationUICloneOverride(WpfAnnotationUI).)
	CoerceValue	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.)
	CreateDataSnapshot	This method creates an AnnotationData copy of this annotation for serialization. (Inherited from WpfAnnotationUI.)
	CreateDataSnapshotOverride	This method is used to serialize the annotation. (Overrides WpfAnnotationUICreateDataSnapshotOverride.)
	Equals	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindCommonVisualAncestor	Returns the common ancestor of two visual objects. (Inherited from Visual.)
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetLeaderPoints	Returns an array of Point used to render the leader line.
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	GetVisualChild	Returns the specified Visual in the parent VisualCollection. (Inherited from Visual.)
	HideEditBox	Called when the edit box needs to be hidden from the user.
	HitTest	This method will determine whether the specified point is on the annotation. (Inherited from WpfAnnotationUI.)
	HitTestCore(PointHitTestParameters)	Determines whether a point coordinate value is within the bounds of the visual object. (Inherited from WpfAnnotationUI.)
	HitTestCore(GeometryHitTestParameters)	Determines whether a geometry value is within the bounds of the visual object. (Inherited from Visual.)
	InvalidateProperty	Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
	InvalidateVisual	Forces the annotation to redraw itself. (Inherited from WpfAnnotationUI.)
	IsAncestorOf	Determines whether the visual object is an ancestor of the descendant visual object. (Inherited from Visual.)
	IsDescendantOf	Determines whether the visual object is a descendant of the ancestor visual object. (Inherited from Visual.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Mirror	Mirrors the annotation in the specified direction. (Inherited from WpfAnnotationUI.)
	OnAnnotationBrushChanged	Called when the FillProperty has changed. (Overrides WpfAnnotationUIOnAnnotationBrushChanged(AnnotationBrush).)
	OnAnnotationCreated	Called after the annotation has been created. (Inherited from WpfAnnotationUI.)
	OnAnnotationFontChanged	Called when the FontProperty has changed. (Overrides WpfAnnotationUIOnAnnotationFontChanged(AnnotationFont).)
	OnAnnotationPenChanged	Called when the OutlineProperty has changed. (Overrides WpfAnnotationUIOnAnnotationPenChanged(AnnotationPen).)
	OnCanvasChanged	Called when the Canvas property has changed. (Inherited from WpfAnnotationUI.)
	OnGripPositionChanged	Called when a grip for the annotation has moved. (Overrides WpfAnnotationUIOnGripPositionChanged(EventArgsWpfAnnotationGrip).)
	OnMouseDown	Called when a MouseDown event has been raised for the annotation. (Overrides WpfAnnotationUIOnMouseDown(MouseButtonEventArgs).)
	OnMouseMove	Called when a MouseMove event has been raised for the annotation. (Overrides WpfAnnotationUIOnMouseMove(MouseEventArgs).)
	OnMouseUp	Called when a MouseUp event has been raised for the annotation. (Overrides WpfAnnotationUIOnMouseUp(MouseButtonEventArgs).)
	OnPropertyChanged	Raises the PropertyChanged event. (Overrides WpfAnnotationUIOnPropertyChanged(DependencyPropertyChangedEventArgs).)
	OnRotateDocument	Called when the document has been rotated. (Inherited from WpfAnnotationUI.)
	OnSelectedChanged	Called when the Selected property has been changed. (Overrides WpfAnnotationUIOnSelectedChanged(EventArgs).)
	OnVisualChildrenChanged	Called when the VisualCollection of the visual object is modified. (Inherited from Visual.)
	OnVisualParentChanged	Called when the parent of the visual object is changed. (Inherited from Visual.)
	OperationRequest	Called when a request operation has been raised on the annotation. (Overrides WpfAnnotationUIOperationRequest(OperationRequestInformation).)
	PointFromScreen	Converts a Point in screen coordinates into a Point that represents the current coordinate system of the Visual. (Inherited from Visual.)
	PointToScreen	Converts a Point that represents the current coordinate system of the Visual into a Point in screen coordinates. (Inherited from Visual.)
	PredetermineRenderBounds	This method is used to calculate the expected render bounds of an annotation if its rotation was changed. (Inherited from WpfAnnotationUI.)
	RaiseEvent	This method is used to force an event in the annotation. (Inherited from WpfAnnotationUI.)
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	Remove	This method will remove the annotation from its parent layer. (Inherited from WpfAnnotationUI.)
	RemoveVisualChild	Removes the parent-child relationship between two visuals. (Inherited from Visual.)
	ReplaceGrips	Call this method to replace the current annotation grips with new grips. (Inherited from WpfAnnotationUI.)
	ResetMirrorVariables	This method will reset the internal Matrix used for mirroring. (Inherited from WpfAnnotationUI.)
	Rotate	This method will append a rotation to the annotation's current rotation. (Inherited from WpfAnnotationUI.)
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetTransparency	Sets the alpha values for the Fill and Outline of the annotation. (Inherited from WpfAnnotationUI.)
	SetUserHasCreated	Derived class should call this method to indicate that their creation process has completed. (Inherited from WpfAnnotationUI.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ShouldSerializeProperty	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
	ShowEditBox	Called when the edit box needs to be shown, allowing the end-user to modify the annotation text.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TransformToAncestor(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.)
	TransformToAncestor(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.)
	TransformToDescendant	Returns a transform that can be used to transform coordinates from the Visual to the specified visual object descendant. (Inherited from Visual.)
	TransformToVisual	Returns a transform that can be used to transform coordinates from the Visual to the specified visual object. (Inherited from Visual.)
	VerifyAccess	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Top

Events

	Name	Description
	MouseDown	Event is raised when the left mouse button transitions from up to down while the cursor is over the annotation. (Inherited from WpfAnnotationUI.)
	MouseUp	Event is raised when the left mouse button transitions from down to up while the cursor is over the annotation. (Inherited from WpfAnnotationUI.)
	PropertyChanged	This event is raised when a property of the annotation has changed. (Inherited from WpfAnnotationUI.)

Top

Fields

	Name	Description
	AlignmentProperty	Identifies the Alignment dependency property.
	AllowEditingProperty	Identifies the AllowEditing dependency property.
	CanEditMirroredProperty	Identifies the CanEditMirrored dependency property.
	CanEditRotatedProperty	Identifies the CanEditRotated dependency property.
	EditModeProperty	Identifies the EditMode dependency property.
	FontBrushProperty	Identifies the FontBrush dependency property.
	FontProperty	Identifies the Font dependency property.
	LeaderFlatLengthProperty	Identifies the LeaderFlatLength dependency property.
	LeaderProperty	Identifies the Leader dependency property.
	LineAlignmentProperty	Identifies the LineAlignment dependency property.
	PaddingProperty	Identifies the Padding dependency property.
	TargetPositionProperty	Identifies the TargetPosition dependency property.
	TextProperty	Identifies the Text dependency property.

Top

Reference

Atalasoft.Annotate.Wpf Namespace