AnnotationController Class

The AnnotationController is the central hub for DotImage. It contains a LayerCollection for any number of LayerAnnotation objects, each containing any number of annotations.

Inheritance Hierarchy

SystemObject
Atalasoft.Annotate.UIAnnotationController

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

Syntax

Copy

public class AnnotationController : IComponent, 
	IDisposable

Public Class AnnotationController
	Implements IComponent, IDisposable

The AnnotationController type exposes the following members.

Constructors

	Name	Description
	AnnotationController	Creates a new instance of AnnotationController.
	AnnotationController(IAnnotate)	Creates a new instance of AnnotationController specifying the IAnnotate parent control.

Top

Properties

	Name	Description
	ActiveAnnotation	Gets or sets the currently selected annotation.
	AnnotationConfinement	Gets or sets the annotation confinement used to keep annotations within a specific area of the control.
	ClipToDocument	Gets or sets a value indicating whether the annotation rendering is clipped to the document bounds.
	CreateMouseButton	Gets or sets the mouse button used for creating annotations.
	CurrentLayer	Gets or sets the current active layer.
	DefaultSecurity	Gets or sets the default security used for new annotations.
	Factories	Gets the AnnotationUIFactoryCollection containing IAnnotationUIFactory objects used to create annotations from AnnotationData classes.
	InteractMode	Gets or sets a value specifying the user interactive mode of the AnnotationController.
	IsDirty	Gets a value indicating whether the annotations have been modified since the last load or save.
	Layers	Gets or sets the LayerCollection used by the AnnotationController.
	MultiSelectKey	Gets or sets the key held down to select multiple annotations.
	Parent	Gets or sets the IAnnotate parent control where the annotations will be rendered.
	RotationSnapInterval	Gets or sets the interval used for snapping interactive rotation to degrees. This is used to help users when rotating an annotation, making it easier to stop at whole degrees. The snap area is determined by the RotationSnapThreshold property.
	RotationSnapThreshold	Gets or sets the amount of deviation from the RotationSnapInterval that will be used to snap to the rotation interval.
	SelectedAnnotations	Gets an array of annotations currently selected.
	Site	Gets or sets the site of the control.
	SmoothingMode	Gets or sets the smoothing mode used when drawing annotations.
	ToolTip	Gets or sets the tooltip control used for annotation tooltips.
	UndoManager	Gets the AnnotationUndoManager used by the controller.
	WaitingToCreate	Gets a value indicating whether the AnnotationController is waiting for the user to create an annotation with the mouse.

Top

Methods

	Name	Description
	AnnotationFromPoint(PointF)	Returns the annotation located at a specific point on the control.
	AnnotationFromPoint(LayerAnnotation, PointF)	Returns the annotation at the specified point of a specified layer.
	CanPaste	Returns a value indicating whether there is annotation data on the clipboard.
	ChangeAnnotationPosition(ChangePositionMethod)	Changes the position of the selected annotation within the stacking order.
	ChangeAnnotationPosition(AnnotationUI, ChangePositionMethod)	Changes the position of an annotation or layer within the stacking order.
	ClearSelection	Unselects all of the selected annotations.
	Clone	Creates a copy of the AnnotationController including all of the layers and annotations.
	Copy	Copies the selected annotation(s) to the clipboard.
	CountAnnotations	Returns the number of annotations in all of the layers.
	CountAnnotations(LayerAnnotation)	Returns the number of annotations in the provided layer.
	CreateAnnotation(AnnotationUI)	Call this method to prepare the AnnotationController for creating a new annotation with the mouse.
	CreateAnnotation(AnnotationUI, CreateAnnotationMode)	Call this method to prepare the AnnotationController for creating a new annotation with the mouse, specifying the creation mode to use.
	Cut	Cuts the selected annotation(s) and places them onto the clipboard.
	Dispose	Releases memory used by the AnnotationController and all of its annotations.
	Dispose(Boolean)	Releases resources used by the AnnotationController.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExitCreateMode	This method will exit 'create mode' started with CreateAnnotation(AnnotationUI).
	Finalize	Finalizes an instance of the AnnotationController class. (Overrides ObjectFinalize.)
	FindAnnotationLayer(AnnotationUI)	Returns the LayerAnnotation containing a specified annotation.
	FindAnnotationLayer(LayerAnnotation, AnnotationUI)	Returns the LayerAnnotation containing a specified annotation.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetTopLevelLayer	Returns the top level LayerAnnotation for the supplied annotation. This method will scan through the nested layers until it finds the top most layer.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Group	Combines all selected annotations into a new LayerAnnotation object and adds this layer to the CurrentLayer.
	Group(AnnotationUI)	Combines annotations into a LayerAnnotation and adds it to the CurrentLayer.
	InvalidateAnnotation	Forces an annotation to be redrawn.
	Load(Byte, AnnotationDataFormat)	Loads annotation data from a byte array and adds the annotations to the Layers collection.
	Load(Byte, IFormatter)	Loads annotation data from a byte array using the supplied formatter and adds them to the Layers.
	Load(Stream, AnnotationDataFormat)	Loads annotation data from a stream and adds the annotations to the Layers collection.
	Load(Stream, IFormatter)	Loads annotation data from a stream using the supplied formatter into the Layers collection.
	Load(String, AnnotationDataFormat)	Loads annotation data from a file and adds the annotations to the Layers collection.
	Load(String, IFormatter)	Loads annotation data from a file using the supplied formatter and adds the annotations to the Layers collection.
	Load(Byte, LayerAnnotation, AnnotationDataFormat)	Loads annotation data from a byte array and adds the annotations to the specified layer.
	Load(Byte, LayerAnnotation, IFormatter)	Loads annotation data into the specified layer using the provided formatter.
	Load(Stream, LayerAnnotation, AnnotationDataFormat)	Loads annotation data from a stream and adds the annotations to the specified layer.
	Load(Stream, LayerAnnotation, IFormatter)	Loads annotation data from a stream using the formatter and adds the annotations to the provided layer.
	Load(String, LayerAnnotation, AnnotationDataFormat)	Loads annotation data from a file and adds the annotations to the specified layer.
	Load(String, LayerAnnotation, IFormatter)	Loads annotation data from a file using the formatter and adds the annotations to the provided layer.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyController	This method is used by layer and annotation objects to notify the AnnotationController of events.
	OnAnnotationCreated	Called when a new annotation has been created by the user.
	OnClick	Called when a Click event is received from the parent control.
	OnCurrentLayerChanged	Called when the CurrentLayer property has changed.
	OnDoubleClick	Called when a DoubleClick event has been received from the parent control.
	OnHotSpotClicked	Called when a hot spot annotation has been clicked.
	OnMouseDown	Called when a MouseDown event is received from the parent control.
	OnMouseMove	Called when a MouseMove event is received from the parent control.
	OnMouseUp	Called when a MouseUp event is received from the parent control.
	OnMoving	Called while an annotation is being moved by the user.
	OnPaint	Called when a Paint event is received from the parent control.
	OnResizing	Called while an annotation is being resized by the user.
	OnRotating	Called while the annotation is being rotated by the user.
	OnScrollPositionChanged	Called when a scroll event has been detected.
	OnSelectionChanged	Called when an annotation selection has changed.
	Paste	Pastes annotation data from the clipboard into the current layer.
	Refresh	This method will cause the control to redraw itself.
	RenderAnnotations(AnnotationImage)	Renders the annotations to the supplied image.
	RenderAnnotations(RenderDevice, Graphics)	Renders the annotations to a Graphics object
	RenderAnnotations(RenderDevice, Graphics, LayerAnnotation)	Renders the annotations in a specified layer to a Graphics object.
	ResumePaint	Resumes painting after it has been suspended with SuspendPaint.
	RotateDocument(DocumentRotation)	Rotates all layers in the Layers collection.
	RotateDocument(DocumentRotation, LayerAnnotation)	Rotates the specified layer.
	RotateDocument(DocumentRotation, Int32)	Rotates the annotations in 90 degree increments.
	Save(IFormatter)	Saves the annotations to a byte array using the specified formatter.
	Save(Stream, AnnotationDataFormat)	Writes annotation data to the specified stream.
	Save(Stream, IFormatter)	Saves the annotations to a stream using the specified formatter.
	Save(String, AnnotationDataFormat)	Saves the annotations to a file using a predefined formatter.
	Save(String, IFormatter)	Saves the annotations to a file using the specified formatter.
	Save(LayerAnnotation, IFormatter)	Returns a byte array containing the annotation data from a specified LayerAnnotation. This is useful when saving annotation data to be embedded into image metadata.
	Save(Stream, LayerAnnotation, AnnotationDataFormat)	Writes annotation data from a layer into the specified stream.
	Save(Stream, LayerAnnotation, IFormatter)	Saves the specified layer to a stream using the formatter supplied.
	Save(String, LayerAnnotation, AnnotationDataFormat)	Saves a layer to a file using a predefined format.
	Save(String, LayerAnnotation, IFormatter)	Saves a layer to a file using the specified formatter.
	SelectAll	Selects all of the annotations on the current layer or all layers.
	SelectFromBounds(RectangleF, Boolean)	Selects annotations that are partially or fully within a rectangular area.
	SelectFromBounds(LayerAnnotation, RectangleF, Boolean)	Selects annotations from a layer that are without a bounding region.
	SuspendPaint	Use this method to suspend painting any annotations until the ResumePaint method is called.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Ungroup	Ungroups the currently selected annotation.
	Ungroup(LayerAnnotation, LayerAnnotation)	Removes annotations from one layer and adds them to another.

Top

Events

	Name	Description
	AnnotationCreated	Raised when an annotation is created by the user.
	AnnotationDeserialization	Raised when an object is deserialized to allow developers to cancel or modify the object before its added into the controller.
	Click	Raised when an annotation is clicked with the mouse.
	CurrentLayerChanged	Raised when the CurrentLayer property has changed.
	Disposed	Raised when the AnnotationController has been disposed.
	DoubleClick	Raised when an annotation is double-clicked by the user.
	HotSpotClicked	Raised when a hot spot annotation is clicked.
	Moved	Raised when an annotation is moved.
	Moving	Raised while an annotation is being moved.
	Resized	Raised when an annotation is resized.
	Resizing	Raised while an annotation is being resized.
	Rotated	Raised when an annotation is rotated by the user.
	Rotating	Raised while an annotation is being rotated by the user.
	SelectionChanged	Raise when there has been a change in the annotation selection.

Top

Reference

Atalasoft.Annotate.UI Namespace