Click or drag to resize

ImageCollection Class

This collection holds multiple AtalaImage objects useful for various features like working with multi-paged images, animations, and layering.
Inheritance Hierarchy

Namespace:  Atalasoft.Imaging
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class ImageCollection : CollectionBase, 
	IList, ICollection, IEnumerable, IDisposable

The ImageCollection type exposes the following members.

Constructors
  NameDescription
Public methodImageCollection
Initializes a new instance of the ImageCollection class.
Public methodImageCollection(AtalaImage)
Initializes a new instance of the %ImageCollection% object specifying one or multiple %AtalaImage% objects to add to the collection.
Public methodImageCollection(Stream, ProgressEventHandler)
Initializes a new instance of the %ImageCollection% object specifying a Stream containing image data to load.
Public methodImageCollection(String, ProgressEventHandler)
Initializes a new instance of the %ImageCollection% object specifying a filename containing image data to load.
Top
Properties
  NameDescription
Public propertyCapacity
Gets or sets the number of elements that the CollectionBase can contain.
(Inherited from CollectionBase.)
Public propertyCount
Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden.
(Inherited from CollectionBase.)
Public propertyCurrent
Gets or sets the current image in this collection.
Protected propertyInnerList
Gets an ArrayList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Public propertyItem
Allows the image collection to be accessed through an indexer and enumerated with foreach.
Protected propertyList
Gets an IList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Top
Methods
  NameDescription
Public methodAdd
Adds an AtalaImage to the collection.
Public methodClear
Removes all objects from the CollectionBase instance. This method cannot be overridden.
(Inherited from CollectionBase.)
Public methodContains
Returns a value Indicating if a specified image exists within this collection.
Public methodCopyTo
Copy this ImageCollection into an existing AtalaImage array.
Public methodDispose
Remove unmanaged resources in each AtalaImage in the collection.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the CollectionBase instance.
(Inherited from CollectionBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Returns the index of a specified image in the collection.
Public methodInsert
Insert an AtalaImage at the specified index.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveNext
Set the Current image to the next image in the collection.
Public methodMovePrevious
Set the Current image to the previous image in the collection.
Protected methodOnClear
Performs additional custom processes when clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnClearComplete
Performs additional custom processes after clearing the contents of the CollectionBase instance.
(Overrides CollectionBaseOnClearComplete.)
Protected methodOnInsert
Performs additional custom processes before inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsertComplete
Performs additional custom processes after inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemove
Performs additional custom processes when removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemoveComplete
Performs additional custom processes after removing an element from the CollectionBase instance.
(Overrides CollectionBaseOnRemoveComplete(Int32, Object).)
Protected methodOnSet
Performs additional custom processes before setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSetComplete
Performs additional custom processes after setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnValidate
Performs additional custom processes when validating a value.
(Inherited from CollectionBase.)
Public methodReadImages
Read all images from a multipage image file into this image collection.
Public methodRemove
Removes a specified AtalaImage from this ImageCollection.
Public methodRemoveAt
Removes the element at the specified index of the CollectionBase instance. This method is not overridable.
(Inherited from CollectionBase.)
Public methodReplace
Replaces the Current image in the collection with a new image.
Public methodSave(Stream, ImageEncoder, ProgressEventHandler)
Save the images in this ImageCollection to a stream specifying the %ImageEncoder% to use for encoding the image data.
Public methodSave(String, ImageEncoder, ProgressEventHandler)
Save each ImageCollection in a multipaged or multiframed format.
Public methodSave(String, ImageType, ProgressEventHandler) Obsolete.
Save each ImageCollection in a multipaged or multiframed format.
Public methodToByteArray
Saves the image into a byte array.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also