Click or drag to resize

AnnotationData Class

This is the main annotation data class used to hold base information required by all annotations.
Inheritance Hierarchy
SystemObject
  Atalasoft.AnnotateAnnotationData
    More...

Namespace:  Atalasoft.Annotate
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public abstract class AnnotationData : ISerializable, 
	ICloneable, IDisposable

The AnnotationData type exposes the following members.

Constructors
  NameDescription
Public methodAnnotationData
Default constructor of AnnotationData.
Protected methodAnnotationData(SerializationInfo, StreamingContext)
Default serialization constructor of AnnotationData.
Top
Properties
  NameDescription
Public propertyAnnotationBounds
Gets the rectangle bounds of the annotation, including any pen or shadow, before any matricies are applied.
Public propertyBounds
Gets the bounding rectangle of the annotation.
Public propertyCanMirror
Gets or sets a value indicating if the annotation can mirror.
Public propertyCanMove
Gets or sets a value indicating if the annotation can be moved.
Public propertyCanResize
Gets or sets a value indicating if the annotation can be resized.
Public propertyCanRotate
Gets or sets a value indicating if the annotation can be rotated.
Public propertyCanSelect
Gets or sets a value indicating if the annotation can be selected.
Public propertyCreationTime
Gets or sets the creation time of the annotation.
Public propertyIgnoreDataChanges
Gets or sets a value indicating whether any properties changes should be passed to the undo manager.
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 propertyLocation
Gets or sets the location of this annotation.
Public propertyModifiedTime
Gets or sets the time in which this annotation was modified.
Public propertyName
Gets or sets a name for this annotation.
Public propertyRotation
Gets or sets the current amount of rotation for this annotation.
Public propertySecurity
Gets or sets the security lock used for this annotation.
Public propertySelected
Get or set whether this AnnotationData object is selected
Public propertySize
Gets or sets the size of the annotation.
Public propertyState
Get or set the AnnotationState of this AnnotationData object
Public propertyToolTip
Gets or sets the text displayed in the annotation tooltip.
Public propertyTransform
Gets the transformation matrix used for rendering this annotation.
Public propertyUserName
Gets or sets the username for the annotation. Internally this is used with PDF annotations.
Public propertyVisible
Gets or sets a value indicating if the annotation is visible.
Top
Methods
  NameDescription
Protected methodCalculateAnnotationBounds(AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle without applying the annotation transforms.
Protected methodCalculateAnnotationBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle without applying the annotation transforms.
Protected methodCalculateBounds(AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle for the annotation, taking the pen width, shadow and annotation transforms into account.
Protected methodCalculateBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)
This method will add the annotation pen width, shadow and transforms to the provided rectangle bounds.
Public methodCode exampleClone
Returns a copy of this annotation data.
Protected methodCode exampleCloneBaseData
Fills the data object with cloned property values.
Protected methodCloneBaseDataFrom
Clones the base data from.
Public methodDispose
Releases resources used by the annotation.
Protected methodDispose(Boolean)
Called to release resources used by the annotation.
Public methodEquals
Compares the current annotation with another.
(Overrides ObjectEquals(Object).)
Protected methodFinalize
Finalizes an instance of the AnnotationData class.
(Overrides ObjectFinalize.)
Public methodGetAllExtraProperties
Returns a Dictionary containing the key value pairs for extra properties.
Public methodGetExtraProperty
Returns the value stored with SetExtraProperty(String, String).
Public methodGetHashCode
Returns an identifier for this object.
(Overrides ObjectGetHashCode.)
Protected methodGetLineCapBounds
Called to get the rectangle bounds of the line cap used in an AnnotationLineCap.
Public methodCode exampleGetObjectData
Fills the SerializationInfo object with properties values for the base AnnotationData class.
Public methodGetRenderTransform
Returns a System.Drawing.Drawing2D.Matrix containing the matrices applied to the annotation.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMirror
Flips (mirrors) the annotation horizontally or vertically.
Protected methodOnAnnotationControllerNotification
Called after a property value has been changed.
Protected methodOnCanMirrorChanged
Called when the CanMirror property value has changed.
Protected methodOnCanMoveChanged
Called when the CanMove property value has changed.
Protected methodOnCanResizeChanged
Called when the CanResize property has changed.
Protected methodOnCanRotateChanged
Called when the CanRotate property value has changed.
Protected methodOnCanSelectChanged
Called when the CanSelect property value has changed.
Protected methodOnCreationTimeChanged
Called when the CreationTime property value has changed.
Protected methodOnLocationChanged
Called when the Location property value has changed.
Protected methodOnMirrored
Called when the annotation has been mirrored.
Protected methodOnModifiedTimeChanged
Called when the ModifiedTime property has changed.
Protected methodOnNameChanged
Called when the Name property has changed.
Protected methodOnPropertyChanged
Called when a property has been changed and raises the PropertyChanged event.
Protected methodOnPropertyChanging
Called just before a property value is changed.
Protected methodOnRotationChanged
Called when the Rotation property has changed.
Protected methodOnSecurityChanged
Called when the Security property has changed.
Protected methodOnSizeChanged
Called when the Size property has changed.
Protected methodOnStateChanged
Called when the State property has changed and raises the StateChanged event.
Protected methodOnTooltipChanged
Called when the ToolTip property has changed.
Protected methodOnTransformChanged
Called when the Transform property has changed.
Protected methodOnUserNameChanged
Called when the UserName property has changed and raises the UserNameChanged event.
Protected methodOnVisibleChanged
Called when the Visible property has changed.
Protected methodRemoveBrushEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationBrush.
Protected methodRemoveFontEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationFont.
Protected methodRemovePenEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationPen.
Protected methodRemoveSecurityEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an IAnnotationLock.
Public methodRotate
Applies rotation to the annotation from its current rotation amount.
Protected methodSetBrushEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationBrush.
Public methodSetExtraProperty
Sets a custom value within an annotation that can be retrieved using GetExtraProperty(String).
Protected methodSetFontEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationFont.
Protected methodSetPenEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationPen.
Protected methodSetSecurityEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an IAnnotationLock.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventAnnotationControllerNotification
Raised after a property has been changed.
Public eventCanMirrorChanged
Raised when the CanMirror property is changed.
Public eventCanMoveChanged
Raised when the CanMove property is changed.
Public eventCanResizeChanged
Raised when the CanResize property has changed.
Public eventCanRotateChanged
Raised when the CanRotate property has changed.
Public eventCanSelectChanged
Raised when the CanSelect property has changed.
Public eventCreationTimeChanged
Raised when the CreationTime property has changed.
Public eventLocationChanged
Raised when the Location property has changed.
Public eventMirrored
Raised when the annotation is mirrored, either by the user dragging a grip across its opposite or when the Mirror method is called.
Public eventModifiedTimeChanged
Raised when the ModifiedTime property has changed.
Public eventNameChanged
Raised when the Name property has changed.
Public eventPropertyChanged
Raised when a property value has changed.
Public eventPropertyChanging
Raised before a property is changed.
Public eventRotationChanged
Raised when the Rotation property has changed.
Public eventSecurityChanged
Raised when the Security property has changed.
Public eventSizeChanged
Raised when the Size property has changed.
Public eventStateChanged
This event is raised when the State property value has changed.
Public eventTooltipChanged
Raised when the ToolTip property has changed.
Public eventTransformChanged
Raised when the Transform property has changed.
Public eventUserNameChanged
This event is raised when the UserName property has changed.
Public eventVisibleChanged
Raised when the Visible property has changed.
Top
See Also
Inheritance Hierarchy
SystemObject
  Atalasoft.AnnotateAnnotationData
    Atalasoft.AnnotateCalloutData
    Atalasoft.AnnotateEllipseData
    Atalasoft.AnnotateEmbeddedImageData
    Atalasoft.AnnotateHotSpotData
    Atalasoft.Annotate.InkInkData
    Atalasoft.AnnotateLayerData
    Atalasoft.AnnotateLineData
    Atalasoft.AnnotateOcrRegionData
    Atalasoft.Annotate.PdfPdfAnnotationData
    Atalasoft.AnnotatePointBaseData
    Atalasoft.AnnotateRectangleData
    Atalasoft.AnnotateReferencedImageData
    Atalasoft.AnnotateRubberStampData
    Atalasoft.Annotate.SilverlightSilverlightInkData
    Atalasoft.AnnotateTextData