LayerCollection Class

This class is used to hold a collection of LayerAnnotation objects.

Inheritance Hierarchy

System.Object
System.Collections.CollectionBase
Atalasoft.Annotate.UI.LayerCollection

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

[SerializableAttribute]
public class LayerCollection : CollectionBase, 
	ISerializable, IDisposable, IDeserializationCallback

<SerializableAttribute>
Public Class LayerCollection
	Inherits CollectionBase
	Implements ISerializable, IDisposable, IDeserializationCallback

The LayerCollection type exposes the following members.

Constructors

	Name	Description
	LayerCollection()	Creates a new instance of LayerCollection.
	LayerCollection(SerializationInfo, StreamingContext)	Creates a new instance of LayerCollection from serialized information.

Top

Properties

	Name	Description
	Capacity	Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
	Controller	Gets the AnnotationController for this LayerCollection.
	Count	Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
	InnerList	Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
	Item	Gets the LayerAnnotation at the specified index in the collection.
	List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)

Top

Methods

	Name	Description
	Add	Adds a layer to the collection.
	AddRange	Adds an array of layers to the collection.
	Clear	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
	Contains	Returns a value indicating whether a layer is contains within the collection.
	CopyTo	Copies items into the specified array.
	Dispose()	Releases memory used by this collection and all of its annotations.
	Dispose(Boolean)	Releases resources used by the collection and all of its LayerAnnotation objects.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Finalizes an instance of the LayerCollection class. (Overrides Object.Finalize().)
	GetEnumerator	Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Fills a SerializationInfo object with information about this collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Returns the position of a layer within the collection or -1 if the layer is not in the collection.
	Insert	Inserts a layer into the collection at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAnnotationControllerNotification	Called when a change has been made to the collection or an object in the collection.
	OnClear	Called when the Clear method is invoked. (Overrides CollectionBase.OnClear().)
	OnClearComplete	Called when the Clear method has completed. (Overrides CollectionBase.OnClearComplete().)
	OnCollectionChanged	Called when there is any change to the collection.
	OnControllerChanged	Called when the AnnotationController using this LayerCollection has changed.
	OnDeserialization	Called after an object has been fully deserialized by a serialization formatter.
	OnInsert	Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
	OnInsertComplete	Called when an item has been added or inserted into the collection. (Overrides CollectionBase.OnInsertComplete(Int32, Object).)
	OnPropertyChanging	Called before this collection or an object in the collection has been changed.
	OnRemove	Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
	OnRemoveComplete	Called when a remove method has completed. (Overrides CollectionBase.OnRemoveComplete(Int32, Object).)
	OnSet	Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
	OnSetComplete	Called when an item in the collection has been changed. (Overrides CollectionBase.OnSetComplete(Int32, Object, Object).)
	OnValidate	Performs additional custom processes when validating a value. (Inherited from CollectionBase.)
	Remove(LayerAnnotation)	Removes a layer from the collection.
	Remove(LayerAnnotation[])	Removes an array of LayerAnnotation objects from the collection.
	RemoveAt	Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
	Replace(Int32, LayerAnnotation)	Replaces a layer at the specified index with the provided layer.
	Replace(LayerAnnotation, LayerAnnotation)	Replaces an existing layer with another one.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	AnnotationControllerNotification	Raised after this collection or an item in the collection has been changed.
	CollectionChanged	Raised when there has been a change in the collection.
	PropertyChanging	Raised before this collection or an item in the collection has been changed.

Top

Remarks

The order of the layers in the LayerCollection determines the stacking (z-order) used when rendering. For instance, the layer at index 1 is rendered on top of the layer at index 0. The order can be changed using the ChangeAnnotationPosition(ChangePositionMethod) method; this is because a LayerAnnotation derives from AnnotationUI.

Reference

Atalasoft.Annotate.UI Namespace