Click or drag to resize

WpfAnnotationUI Class

This is the base class for all WPF annotations.
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 abstract class WpfAnnotationUI : Visual

The WpfAnnotationUI type exposes the following members.

Constructors
  NameDescription
Protected methodWpfAnnotationUI
The default constructor.
Protected methodWpfAnnotationUI(AnnotationData)
Constructs an annotation using the specified AnnotationData object.
Top
Properties
  NameDescription
Public propertyBounds
Gets the bounding rectangle of this annotation.
Public propertyCanMirror
Gets or sets a value indicating whether the annotation can be mirrored by the end-user.
Public propertyCanMove
Gets or sets a value indicating whether the annotation can be moved by the end-user.
Public propertyCanResize
Gets or sets a value indicating whether the annotation can be resized by the end-user.
Public propertyCanRotate
Gets or sets a value indicating whether the annotation can be rotated by the end-user.
Public propertyCanSelect
Gets or sets a value indicating whether the annotation can be selected by the end-user.
Public propertyCanvas
Gets the WpfAnnotationCanvas class hosting this annotation.
Public propertyCenterOfRotation
Gets the point used as center of rotation for the annotation.
Public propertyChildElement
Gets the child UIElement of the annotation, if any.
Public propertyCreationTime
Gets or sets the creation time of the annotation.
Public propertyStatic memberDefaultFill
Gets or sets the default brush used for annotation backgrounds.
Public propertyStatic memberDefaultOutline
Gets or sets the default outline used for annotations.
Public propertyStatic memberDefaultShadow
Gets or sets the default shadow brush used for annotations.
Public propertyStatic memberDefaultShadowOffset
Gets or sets the default shadow offset used for annotations.
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 propertyGeometry
Gets a Geometry representing the annotation.
Public propertyGrips
Gets the grips for this annotation.
Public propertyIsGrouped
Gets a value indicating whether the annotation is being hosted within a group.
Public propertyIsMirroredHorizontally
Gets a value indicating whether the annotation is mirrored horizontally.
Public propertyIsMirroredVertically
Gets a value indicating whether the annotation is mirrored vertically.
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.
Public propertyLocation
Gets or sets the location of the annotation in document space.
Public propertyModifiedTime
Gets or sets the last time the annotation was modified.
Public propertyName
Gets or sets the name for the annotation.
Public propertyParentLayer
Gets the parent layer of this annotation, if any.
Public propertyRenderedBounds
Gets the bounding rectangle of the annotation including any transformations applied for rendering.
Public propertyRenderTransform
Gets the transform used when rendering the annotation.
Public propertyRotation
Gets or sets the amount of rotation applied to the annotation.
Public propertySecurity
Gets or sets the security for the annotation.
Public propertySelected
Gets or sets a value indicating whether the annotation is selected.
Public propertySize
Gets or sets the size of the annotation.
Public propertyState
Gets or sets the annotation state.
Public propertySupportsMultiClickCreation
Gets a value indicating whether the annotation supports being created from multiple mouse clicks.
Public propertyToolTip
Gets or sets a tooltip to use for the annotation.
Public propertyUserHasCreated
Gets a value indicating if the annotation was end-user created or added directly to a layer.
Public propertyUserName
Gets or sets the username for this annotation.
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.
Protected methodAttachGripsOverride
Called when the annotation grips need to be created.
Protected methodCalculateGeometry
Calculates the geometry of the annotation with the specified parameters.
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.
Protected methodCloneOverride
Derived classes must override this method and return a copy of itself.
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.
Protected methodCreateDataSnapshotOverride
This method is used to serialize the annotation.
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 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.)
Public methodHitTest
This method will determine whether the specified point is on the annotation.
Protected methodHitTestCore(GeometryHitTestParameters)
Determines whether a geometry value is within the bounds of the visual object.
(Inherited from Visual.)
Protected methodHitTestCore(PointHitTestParameters)
Determines whether a point coordinate value is within the bounds of the visual object.
(Overrides VisualHitTestCore(PointHitTestParameters).)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Protected methodInvalidateVisual
Forces the annotation to redraw itself.
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.
Protected methodOnAnnotationBrushChanged
Called when the FillProperty has changed.
Protected methodOnAnnotationCreated
Called after the annotation has been created.
Protected methodOnAnnotationFontChanged
Called when the FontProperty has changed.
Protected methodOnAnnotationPenChanged
Called when the OutlineProperty has changed.
Protected methodOnCanvasChanged
Called when the Canvas property has changed.
Protected methodOnGripPositionChanged
Called when a grip for the annotation has moved.
Protected methodOnMouseDown
Called when a MouseDown event has been raised for the annotation.
Protected methodOnMouseMove
Called when a MouseMove event has been raised for the annotation.
Protected methodOnMouseUp
Called when a MouseUp event has been raised for the annotation.
Protected methodOnPropertyChanged
Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data.
(Overrides DependencyObjectOnPropertyChanged(DependencyPropertyChangedEventArgs).)
Protected methodOnRotateDocument
Called when the document has been rotated.
Protected methodOnSelectedChanged
Called when the Selected property has been changed.
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.
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.
Public methodRaiseEvent
This method is used to force an event in the annotation.
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.
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.
Public methodResetMirrorVariables
This method will reset the internal Matrix used for mirroring.
Public methodRotate
This method will append a rotation to the annotation's current rotation.
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.
Protected methodSetUserHasCreated
Derived class should call this method to indicate that their creation process has completed.
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.)
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.
Public eventMouseUp
Event is raised when the left mouse button transitions from down to up while the cursor is over the annotation.
Public eventPropertyChanged
This event is raised when a property of the annotation has changed.
Top
Fields
  NameDescription
Public fieldStatic memberBoundsProperty
Identifies the Bounds dependency property.
Public fieldStatic memberCanMirrorProperty
Identifies the CanMirror dependency property.
Public fieldStatic memberCanMoveProperty
Identifies the CanMove dependency property.
Public fieldStatic memberCanResizeProperty
Identifies the CanResize dependency property.
Public fieldStatic memberCanRotateProperty
Identifies the CanRotate dependency property.
Public fieldStatic memberCanSelectProperty
Identifies the CanSelect dependency property.
Public fieldStatic memberCreationTimeProperty
Identifies the CreationTime dependency property.
Public fieldStatic memberFillProperty
Identifies the Fill dependency property.
Public fieldStatic memberIsVisibleProperty
Identifies the IsVisible dependency property.
Public fieldStatic memberLocationProperty
Identifies the Location dependency property.
Public fieldStatic memberModifiedTimeProperty
Identifies the ModifiedTime dependency property.
Public fieldStatic memberNameProperty
Identifies the Name dependency property.
Public fieldStatic memberOutlineProperty
Identifies the Outline dependency property.
Public fieldStatic memberRotationProperty
Identifies the Rotation dependency property.
Public fieldStatic memberSecurityProperty
Identifies the Security dependency property.
Public fieldStatic memberSelectedProperty
Identifies the Selected dependency property.
Public fieldStatic memberShadowOffsetProperty
Identifies the ShadowOffset dependency property.
Public fieldStatic memberShadowProperty
Identifies the Shadow dependency property.
Public fieldStatic memberSizeProperty
Identifies the Size dependency property.
Public fieldStatic memberStateProperty
Identifies the State dependency property.
Public fieldStatic memberToolTipProperty
Identifies the ToolTip dependency property.
Public fieldStatic memberUserNameProperty
Identifies the UserName dependency property.
Top
See Also
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        Atalasoft.Annotate.WpfWpfAnnotationUI
          Atalasoft.Annotate.Wpf.PdfWpfPdfAnnotation
          Atalasoft.Annotate.WpfWpfCalloutAnnotation
          Atalasoft.Annotate.WpfWpfEllipseAnnotation
          Atalasoft.Annotate.WpfWpfEmbeddedImageAnnotation
          Atalasoft.Annotate.WpfWpfHotSpotAnnotation
          Atalasoft.Annotate.WpfWpfLayerAnnotation
          Atalasoft.Annotate.WpfWpfLineAnnotation
          Atalasoft.Annotate.WpfWpfPointBaseAnnotation
          Atalasoft.Annotate.WpfWpfRectangleAnnotation
          Atalasoft.Annotate.WpfWpfReferencedImageAnnotation
          Atalasoft.Annotate.WpfWpfRubberStampAnnotation
          Atalasoft.Annotate.WpfWpfTextAnnotation