ImageCollection Class |
This collection holds multiple AtalaImage objects useful for various features like working
with multi-paged images, animations, and layering.
Inheritance HierarchySystem.Object
System.Collections.CollectionBase
Atalasoft.Imaging.ImageCollection
System.Collections.CollectionBase
Atalasoft.Imaging.ImageCollection
Namespace: Atalasoft.Imaging
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe ImageCollection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ImageCollection() |
Initializes a new instance of the ImageCollection class.
|
| ImageCollection(AtalaImage[]) | Initializes a new instance of the %ImageCollection% object specifying one or multiple %AtalaImage% objects
to add to the collection. |
| ImageCollection(Stream, ProgressEventHandler) | Initializes a new instance of the %ImageCollection% object specifying a Stream containing
image data to load. |
| ImageCollection(String, ProgressEventHandler) | Initializes a new instance of the %ImageCollection% object specifying a filename containing image data to
load. |
Properties| Name | Description | |
|---|---|---|
 | Capacity | Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.) |
| Count | Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.) |
| Current | Gets or sets the current image in this collection. |
 | InnerList | Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
| Item | Allows the image collection to be accessed through an indexer and enumerated with foreach. |
| List | Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
Methods| Name | Description | |
|---|---|---|
| Add | Adds an AtalaImage to the collection. |
| Clear | Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.) |
| Contains | Returns a value Indicating if a specified image exists within this collection. |
| CopyTo | Copy this ImageCollection into an existing AtalaImage array. |
| Dispose() | Remove unmanaged resources in each AtalaImage in the collection. |
 | Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator | Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf | Returns the index of a specified image in the collection. |
| Insert |
Insert an AtalaImage at the specified index.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MoveNext | Set the Current image to the next image in the collection. |
| MovePrevious | Set the Current image to the previous image in the collection. |
| OnClear | Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
| OnClearComplete |
Performs additional custom processes after clearing the contents of the CollectionBase instance.
(Overrides CollectionBase.OnClearComplete().) |
| OnInsert | Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnInsertComplete | Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemove | Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemoveComplete |
Performs additional custom processes after removing an element from the CollectionBase instance.
(Overrides CollectionBase.OnRemoveComplete(Int32, Object).) |
| OnSet | Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnSetComplete | Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnValidate | Performs additional custom processes when validating a value. (Inherited from CollectionBase.) |
| ReadImages | Read all images from a multipage image file into this image collection. |
| Remove | Removes a specified AtalaImage from this ImageCollection. |
| RemoveAt | Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.) |
| Replace | Replaces the Current image in the collection with a new image. |
| Save(Stream, ImageEncoder, ProgressEventHandler) | Save the images in this ImageCollection to a stream specifying the %ImageEncoder% to use for encoding the
image data. |
| Save(String, ImageEncoder, ProgressEventHandler) | Save each ImageCollection in a multipaged or multiframed format. |
| Save(String, ImageType, ProgressEventHandler) | Obsolete. Save each ImageCollection in a multipaged or multiframed format. |
| ToByteArray | Saves the image into a byte array. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also