Click or drag to resize

LayerData Class

The LayerData class is used to hold a collection of AnnotationData objects, including other LayerData objects, allowing the annotations to be organized into layers.
Inheritance Hierarchy

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 class LayerData : AnnotationData, ICloneable, 
	IDeserializationCallback

The LayerData type exposes the following members.

Constructors
  NameDescription
Public methodLayerData
Creates a new instance of LayerData.
Public methodLayerData(SerializationInfo, StreamingContext)
Creates a new instance of LayerData from serialized data.
Top
Properties
  NameDescription
Public propertyAnnotationBounds
Gets the rectangle bounds of the annotation, including any pen or shadow, before any matricies are applied.
(Inherited from AnnotationData.)
Public propertyBounds (Overrides AnnotationDataBounds.)
Public propertyCanMirror
Gets or sets a value indicating if the annotation can mirror.
(Inherited from AnnotationData.)
Public propertyCanMove
Gets or sets a value indicating if the annotation can be moved.
(Inherited from AnnotationData.)
Public propertyCanResize
Gets or sets a value indicating if the annotation can be resized.
(Inherited from AnnotationData.)
Public propertyCanRotate
Gets or sets a value indicating if the annotation can be rotated.
(Inherited from AnnotationData.)
Public propertyCanSelect
Gets or sets a value indicating if the annotation can be selected.
(Inherited from AnnotationData.)
Public propertyCreationTime
Gets or sets the creation time of the annotation.
(Inherited from AnnotationData.)
Public propertyGroupAnnotation
Gets or sets a value indicating whether the annotations in this layer are acting as a single group.
Public propertyIgnoreDataChanges
Gets or sets a value indicating whether any properties changes should be passed to the undo manager.
(Inherited from AnnotationData.)
Public propertyIsMirroredHorizontally
Gets a value indicating whether the annotation is mirrored horizontally.
(Inherited from AnnotationData.)
Public propertyIsMirroredVertically
Gets a value indicating whether the annotation is mirrored vertically.
(Inherited from AnnotationData.)
Public propertyItems
Gets an AnnotationDataCollection used to hold the data for this layer.
Public propertyLocation
Gets or sets the location of this annotation.
(Inherited from AnnotationData.)
Public propertyModifiedTime
Gets or sets the time in which this annotation was modified.
(Inherited from AnnotationData.)
Public propertyName
Gets or sets a name for this annotation.
(Inherited from AnnotationData.)
Public propertyRotation
Gets or sets the current amount of rotation for this annotation.
(Inherited from AnnotationData.)
Public propertySecurity
Gets or sets the security lock used for this annotation.
(Inherited from AnnotationData.)
Public propertySelected
Get or set whether this AnnotationData object is selected
(Inherited from AnnotationData.)
Public propertySerializeCollection
Gets or sets a value indicating whether the AnnotationDataCollection is serialized along with the LayerData object.
Public propertySize
Gets or sets the size of the annotation.
(Inherited from AnnotationData.)
Public propertyState
Get or set the AnnotationState of this AnnotationData object
(Inherited from AnnotationData.)
Public propertyToolTip
Gets or sets the text displayed in the annotation tooltip.
(Inherited from AnnotationData.)
Public propertyTransform
Gets the transformation matrix used for rendering this annotation.
(Inherited from AnnotationData.)
Public propertyUserName
Gets or sets the username for the annotation. Internally this is used with PDF annotations.
(Inherited from AnnotationData.)
Public propertyVisible
Gets or sets a value indicating if the annotation is visible.
(Inherited from AnnotationData.)
Top
Methods
  NameDescription
Protected methodCalculateAnnotationBounds(AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle without applying the annotation transforms.
(Inherited from AnnotationData.)
Protected methodCalculateAnnotationBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle without applying the annotation transforms.
(Inherited from AnnotationData.)
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.
(Inherited from AnnotationData.)
Protected methodCalculateBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)
This method will add the annotation pen width, shadow and transforms to the provided rectangle bounds.
(Inherited from AnnotationData.)
Public methodClone
Creates a copy of this LayerData object.
(Overrides AnnotationDataClone.)
Protected methodCode exampleCloneBaseData
Fills the data object with cloned property values.
(Overrides AnnotationDataCloneBaseData(AnnotationData).)
Protected methodCloneBaseDataFrom
Clones the base data from.
(Inherited from AnnotationData.)
Public methodDispose
Releases resources used by the annotation.
(Inherited from AnnotationData.)
Protected methodDispose(Boolean)
Called to release resources used by the annotation.
(Inherited from AnnotationData.)
Public methodEquals
Determines if another LayerData object has the same property settings.
(Overrides AnnotationDataEquals(Object).)
Protected methodFinalize
Finalizes an instance of the AnnotationData class.
(Inherited from AnnotationData.)
Public methodGetAllExtraProperties
Returns a Dictionary containing the key value pairs for extra properties.
(Inherited from AnnotationData.)
Public methodGetAttachments
Returns an IEumerable of AnnotationData for all annotations attached to the specified parent.
Public methodGetExtraProperty
Returns the value stored with SetExtraProperty(String, String).
(Inherited from AnnotationData.)
Public methodGetHashCode (Overrides AnnotationDataGetHashCode.)
Protected methodGetLineCapBounds
Called to get the rectangle bounds of the line cap used in an AnnotationLineCap.
(Inherited from AnnotationData.)
Public methodGetObjectData
Fills a SerializationInfo object with information about this LayerData.
(Overrides AnnotationDataGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetRenderTransform
Returns a System.Drawing.Drawing2D.Matrix containing the matrices applied to the annotation.
(Inherited from AnnotationData.)
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 (Overrides AnnotationDataMirror(MirrorDirection, Boolean).)
Protected methodOnAnnotationControllerNotification (Overrides AnnotationDataOnAnnotationControllerNotification(AnnotationControllerNotificationEventArgs).)
Protected methodOnCanMirrorChanged
Called when the CanMirror property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCanMoveChanged
Called when the CanMove property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCanResizeChanged
Called when the CanResize property has changed.
(Inherited from AnnotationData.)
Protected methodOnCanRotateChanged
Called when the CanRotate property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCanSelectChanged
Called when the CanSelect property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCreationTimeChanged
Called when the CreationTime property value has changed.
(Inherited from AnnotationData.)
Public methodOnDeserialization
Called after an object has been fully deserialized by a serialization formatter.
Protected methodOnLocationChanged (Overrides AnnotationDataOnLocationChanged(AnnotationLocationChangedEventArgs).)
Protected methodOnMirrored
Called when the annotation has been mirrored.
(Inherited from AnnotationData.)
Protected methodOnModifiedTimeChanged
Called when the ModifiedTime property has changed.
(Inherited from AnnotationData.)
Protected methodOnNameChanged
Called when the Name property has changed.
(Inherited from AnnotationData.)
Protected methodOnPropertyChanged
Called when a property has been changed and raises the PropertyChanged event.
(Inherited from AnnotationData.)
Protected methodOnPropertyChanging (Overrides AnnotationDataOnPropertyChanging(AnnotationPropertyChangingEventArgs).)
Protected methodOnRotationChanged (Overrides AnnotationDataOnRotationChanged(EventArgs).)
Protected methodOnSecurityChanged
Called when the Security property has changed.
(Inherited from AnnotationData.)
Protected methodOnSizeChanged (Overrides AnnotationDataOnSizeChanged(AnnotationSizeChangedEventArgs).)
Protected methodOnStateChanged
Called when the State property has changed and raises the StateChanged event.
(Inherited from AnnotationData.)
Protected methodOnTooltipChanged
Called when the ToolTip property has changed.
(Inherited from AnnotationData.)
Protected methodOnTransformChanged
Called when the Transform property has changed.
(Inherited from AnnotationData.)
Protected methodOnUserNameChanged
Called when the UserName property has changed and raises the UserNameChanged event.
(Inherited from AnnotationData.)
Protected methodOnVisibleChanged
Called when the Visible property has changed.
(Inherited from AnnotationData.)
Protected methodRemoveBrushEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationBrush.
(Inherited from AnnotationData.)
Protected methodRemoveFontEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationFont.
(Inherited from AnnotationData.)
Protected methodRemovePenEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationPen.
(Inherited from AnnotationData.)
Protected methodRemoveSecurityEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an IAnnotationLock.
(Inherited from AnnotationData.)
Public methodRotate (Overrides AnnotationDataRotate(Single).)
Protected methodSetBrushEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationBrush.
(Inherited from AnnotationData.)
Public methodSetExtraProperty
Sets a custom value within an annotation that can be retrieved using GetExtraProperty(String).
(Inherited from AnnotationData.)
Protected methodSetFontEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationFont.
(Inherited from AnnotationData.)
Protected methodSetPenEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationPen.
(Inherited from AnnotationData.)
Protected methodSetSecurityEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an IAnnotationLock.
(Inherited from AnnotationData.)
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.
(Inherited from AnnotationData.)
Public eventCanMirrorChanged
Raised when the CanMirror property is changed.
(Inherited from AnnotationData.)
Public eventCanMoveChanged
Raised when the CanMove property is changed.
(Inherited from AnnotationData.)
Public eventCanResizeChanged
Raised when the CanResize property has changed.
(Inherited from AnnotationData.)
Public eventCanRotateChanged
Raised when the CanRotate property has changed.
(Inherited from AnnotationData.)
Public eventCanSelectChanged
Raised when the CanSelect property has changed.
(Inherited from AnnotationData.)
Public eventCreationTimeChanged
Raised when the CreationTime property has changed.
(Inherited from AnnotationData.)
Public eventLocationChanged
Raised when the Location property has changed.
(Inherited from AnnotationData.)
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.
(Inherited from AnnotationData.)
Public eventModifiedTimeChanged
Raised when the ModifiedTime property has changed.
(Inherited from AnnotationData.)
Public eventNameChanged
Raised when the Name property has changed.
(Inherited from AnnotationData.)
Public eventPropertyChanged
Raised when a property value has changed.
(Inherited from AnnotationData.)
Public eventPropertyChanging
Raised before a property is changed.
(Inherited from AnnotationData.)
Public eventRotationChanged
Raised when the Rotation property has changed.
(Inherited from AnnotationData.)
Public eventSecurityChanged
Raised when the Security property has changed.
(Inherited from AnnotationData.)
Public eventSizeChanged
Raised when the Size property has changed.
(Inherited from AnnotationData.)
Public eventStateChanged
This event is raised when the State property value has changed.
(Inherited from AnnotationData.)
Public eventTooltipChanged
Raised when the ToolTip property has changed.
(Inherited from AnnotationData.)
Public eventTransformChanged
Raised when the Transform property has changed.
(Inherited from AnnotationData.)
Public eventUserNameChanged
This event is raised when the UserName property has changed.
(Inherited from AnnotationData.)
Public eventVisibleChanged
Raised when the Visible property has changed.
(Inherited from AnnotationData.)
Top
Examples
The code below creates a LayerData object and adds a couple AnnotationData objects in addition to a sub layer.
LayerDataExample
LayerData mainLayer = new LayerData();

// Add a couple AnnotationData objects.
mainLayer.Items.Add(new EllipseData(new RectangleF(120, 12, 90, 180), new AnnotationBrush(Color.Red)));
mainLayer.Items.Add(new LineData(new AnnotationPen(Color.Blue, 2), new PointF(30, 30), new PointF(180, 180)));

// Add a sub layer object.
LayerData subLayer = new LayerData();
subLayer.Items.Add(new RectangleData(new RectangleF(10, 20, 120, 80), new AnnotationBrush(Color.BlueViolet)));
subLayer.Items.Add(new TextData("My TextData Object"));
mainLayer.Items.Add(subLayer);
LayerDataExampleVB
Dim mainLayer As LayerData =  New LayerData() 

' Add a couple AnnotationData objects.
mainLayer.Items.Add(New EllipseData(New RectangleF(120, 12, 90, 180), New AnnotationBrush(Color.Red)))
mainLayer.Items.Add(New LineData(New AnnotationPen(Color.Blue, 2), New PointF(30, 30), New PointF(180, 180)))

' Add a sub layer object.
Dim subLayer As LayerData =  New LayerData() 
subLayer.Items.Add(New RectangleData(New RectangleF(10, 20, 120, 80), New AnnotationBrush(Color.BlueViolet)))
subLayer.Items.Add(New TextData("My TextData Object"))
mainLayer.Items.Add(subLayer)
See Also