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.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
public abstract class AnnotationData : ISerializable, 
	ICloneable, IDisposable

<SerializableAttribute>
Public MustInherit Class AnnotationData
	Implements ISerializable, ICloneable, IDisposable

The AnnotationData type exposes the following members.

Constructors

	Name	Description
	AnnotationData	Default constructor of AnnotationData.
	AnnotationData(SerializationInfo, StreamingContext)	Default serialization constructor of AnnotationData.

Top

Properties

	Name	Description
	AnnotationBounds	Gets the rectangle bounds of the annotation, including any pen or shadow, before any matricies are applied.
	Bounds	Gets the bounding rectangle of the annotation.
	CanMirror	Gets or sets a value indicating if the annotation can mirror.
	CanMove	Gets or sets a value indicating if the annotation can be moved.
	CanResize	Gets or sets a value indicating if the annotation can be resized.
	CanRotate	Gets or sets a value indicating if the annotation can be rotated.
	CanSelect	Gets or sets a value indicating if the annotation can be selected.
	CreationTime	Gets or sets the creation time of the annotation.
	IgnoreDataChanges	Gets or sets a value indicating whether any properties changes should be passed to the undo manager.
	IsMirroredHorizontally	Gets a value indicating whether the annotation is mirrored horizontally.
	IsMirroredVertically	Gets a value indicating whether the annotation is mirrored vertically.
	Location	Gets or sets the location of this annotation.
	ModifiedTime	Gets or sets the time in which this annotation was modified.
	Name	Gets or sets a name for this annotation.
	Rotation	Gets or sets the current amount of rotation for this annotation.
	Security	Gets or sets the security lock used for this annotation.
	Selected	Get or set whether this AnnotationData object is selected
	Size	Gets or sets the size of the annotation.
	State	Get or set the AnnotationState of this AnnotationData object
	ToolTip	Gets or sets the text displayed in the annotation tooltip.
	Transform	Gets the transformation matrix used for rendering this annotation.
	UserName	Gets or sets the username for the annotation. Internally this is used with PDF annotations.
	Visible	Gets or sets a value indicating if the annotation is visible.

Top

Methods

	Name	Description
	CalculateAnnotationBounds(AnnotationPen, AnnotationBrush, PointF)	This method will calculate the bounding rectangle without applying the annotation transforms.
	CalculateAnnotationBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)	This method will calculate the bounding rectangle without applying the annotation transforms.
	CalculateBounds(AnnotationPen, AnnotationBrush, PointF)	This method will calculate the bounding rectangle for the annotation, taking the pen width, shadow and annotation transforms into account.
	CalculateBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)	This method will add the annotation pen width, shadow and transforms to the provided rectangle bounds.
	Clone	Returns a copy of this annotation data.
	CloneBaseData	Fills the data object with cloned property values.
	CloneBaseDataFrom	Clones the base data from.
	Dispose	Releases resources used by the annotation.
	Dispose(Boolean)	Called to release resources used by the annotation.
	Equals	Compares the current annotation with another. (Overrides ObjectEquals(Object).)
	Finalize	Finalizes an instance of the AnnotationData class. (Overrides ObjectFinalize.)
	GetAllExtraProperties	Returns a Dictionary containing the key value pairs for extra properties.
	GetExtraProperty	Returns the value stored with SetExtraProperty(String, String).
	GetHashCode	Returns an identifier for this object. (Overrides ObjectGetHashCode.)
	GetLineCapBounds	Called to get the rectangle bounds of the line cap used in an AnnotationLineCap.
	GetObjectData	Fills the SerializationInfo object with properties values for the base AnnotationData class.
	GetRenderTransform	Returns a System.Drawing.Drawing2D.Matrix containing the matrices applied to the annotation.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Mirror	Flips (mirrors) the annotation horizontally or vertically.
	OnAnnotationControllerNotification	Called after a property value has been changed.
	OnCanMirrorChanged	Called when the CanMirror property value has changed.
	OnCanMoveChanged	Called when the CanMove property value has changed.
	OnCanResizeChanged	Called when the CanResize property has changed.
	OnCanRotateChanged	Called when the CanRotate property value has changed.
	OnCanSelectChanged	Called when the CanSelect property value has changed.
	OnCreationTimeChanged	Called when the CreationTime property value has changed.
	OnLocationChanged	Called when the Location property value has changed.
	OnMirrored	Called when the annotation has been mirrored.
	OnModifiedTimeChanged	Called when the ModifiedTime property has changed.
	OnNameChanged	Called when the Name property has changed.
	OnPropertyChanged	Called when a property has been changed and raises the PropertyChanged event.
	OnPropertyChanging	Called just before a property value is changed.
	OnRotationChanged	Called when the Rotation property has changed.
	OnSecurityChanged	Called when the Security property has changed.
	OnSizeChanged	Called when the Size property has changed.
	OnStateChanged	Called when the State property has changed and raises the StateChanged event.
	OnTooltipChanged	Called when the ToolTip property has changed.
	OnTransformChanged	Called when the Transform property has changed.
	OnUserNameChanged	Called when the UserName property has changed and raises the UserNameChanged event.
	OnVisibleChanged	Called when the Visible property has changed.
	RemoveBrushEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationBrush.
	RemoveFontEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationFont.
	RemovePenEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationPen.
	RemoveSecurityEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an IAnnotationLock.
	Rotate	Applies rotation to the annotation from its current rotation amount.
	SetBrushEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationBrush.
	SetExtraProperty	Sets a custom value within an annotation that can be retrieved using GetExtraProperty(String).
	SetFontEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationFont.
	SetPenEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationPen.
	SetSecurityEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an IAnnotationLock.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	AnnotationControllerNotification	Raised after a property has been changed.
	CanMirrorChanged	Raised when the CanMirror property is changed.
	CanMoveChanged	Raised when the CanMove property is changed.
	CanResizeChanged	Raised when the CanResize property has changed.
	CanRotateChanged	Raised when the CanRotate property has changed.
	CanSelectChanged	Raised when the CanSelect property has changed.
	CreationTimeChanged	Raised when the CreationTime property has changed.
	LocationChanged	Raised when the Location property has changed.
	Mirrored	Raised when the annotation is mirrored, either by the user dragging a grip across its opposite or when the Mirror method is called.
	ModifiedTimeChanged	Raised when the ModifiedTime property has changed.
	NameChanged	Raised when the Name property has changed.
	PropertyChanged	Raised when a property value has changed.
	PropertyChanging	Raised before a property is changed.
	RotationChanged	Raised when the Rotation property has changed.
	SecurityChanged	Raised when the Security property has changed.
	SizeChanged	Raised when the Size property has changed.
	StateChanged	This event is raised when the State property value has changed.
	TooltipChanged	Raised when the ToolTip property has changed.
	TransformChanged	Raised when the Transform property has changed.
	UserNameChanged	This event is raised when the UserName property has changed.
	VisibleChanged	Raised when the Visible property has changed.

Top

Reference

Atalasoft.Annotate Namespace

Inheritance Hierarchy