Click or drag to resize

FileSystemImageSource Class

This is an implementation of an ImageSource using a file system as a provider of images.
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
[SerializableAttribute]
public class FileSystemImageSource : RandomAccessImageSource, 
	ISerializable, IImageStreamSource

The FileSystemImageSource type exposes the following members.

Constructors
  NameDescription
Protected methodFileSystemImageSource(SerializationInfo, StreamingContext)
Creates a new instance of FileSystemImageSource from serialization information.
Public methodFileSystemImageSource(String, Boolean)
Provides access to all image files from a directory or file
Public methodFileSystemImageSource(String, Boolean)
Provides access to a list of image files.
Public methodFileSystemImageSource(String, String, Boolean)
Provides access to all image files from a directory that match a pattern or from a single file.
Top
Properties
  NameDescription
Protected propertyActiveImages
Gets the active images.
(Inherited from ImageSource.)
Public propertyCount
Returns the total number of images in the image source.
(Inherited from RandomAccessImageSource.)
Protected propertyCulledImages
Gets the culled images.
(Inherited from ImageSource.)
Public propertyCurrent
Returns the index of the current image.
(Inherited from ImageSource.)
Public propertyFileFilter
Gets or sets a delegate that is invoked for each file, allowing the files to be filtered with custom rules.
Public propertyImmediateUnload
Determines if an image should be unloaded from memory immediately.
(Inherited from ImageSource.)
Public propertyItem
Acquires the image at location i within the image source and returns it.
(Inherited from RandomAccessImageSource.)
Public propertyMemoryInUse
Returns an estimate of the number of bytes of memory currently in use by images in this ImageSource.
(Inherited from ImageSource.)
Public propertyMemoryLimit
This sets the limit for memory usage for this ImageSource. If memory usage goes beyond this, images will be dropped from memory until memory usage is below the limit.
(Inherited from ImageSource.)
Public propertyTotalImages
Returns the total number of available images in this ImageSource.
(Inherited from ImageSource.)
Public propertyTotalImagesKnown
Gets a value indicating whether or not the total number of images in this image source can be known.
(Inherited from ImageSource.)
Top
Methods
  NameDescription
Public methodAcquire(Int32) Obsolete.
This method has been deprecated. Use ReAcquire(AtalaImage) instead.
(Inherited from ImageSource.)
Public methodAcquire(AtalaImage) Obsolete.
This method has been deprecated. Use ReAcquire(AtalaImage) instead.
(Inherited from ImageSource.)
Public methodAcquireNext
Acquire the next available image from the ImageSource.
(Inherited from ImageSource.)
Protected methodAllImagesAreReleased
Determines if all the images have been released.
(Inherited from ImageSource.)
Protected methodAllowFile
Called to determine whether a file is allowed.
Public methodContainsImage
Determines whether this ImageSource contains the specified image.
(Inherited from ImageSource.)
Protected methodCullNode
Culls the node from the ImageSource
(Inherited from ImageSource.)
Protected methodCullReleasedImages
Culls all released images.
(Inherited from ImageSource.)
Public methodDispose
Free up resources used by this ImageSource
(Inherited from ImageSource.)
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
(Inherited from ImageSource.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Finalizes an instance of the ImageSource class.
(Inherited from ImageSource.)
Protected methodFind
Finds the specified image.
(Inherited from ImageSource.)
Public methodFlush
Flush all released images out of memory.
(Inherited from ImageSource.)
Public methodGetFrameCount
Returns the number of frames in for an image in a FileSystemImageSource.
Public methodGetFrameNumber
Return the frame index of an image in the FileSystemImageSource.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodCode exampleGetImageStream
Returns an object that contains information about the stream that contains the requested image. When you call this, the ImageStream member of the returned object will be open and the caller is responsible for closing it.
Public methodGetObjectData
Fills a SerializationInfo object with object information.
(Overrides RandomAccessImageSourceGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetPath
Returns the path of the image in a FileSystemImageSource.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasMoreImages
Determines if there are more images to load.
(Inherited from ImageSource.)
Protected methodLowLevelAcquire
Performs an acquire of an indexed image.
(Overrides RandomAccessImageSourceLowLevelAcquire(Int32).)
Protected methodLowLevelAcquireNextImage
Lows level implementation to acquire next image.
(Overrides ImageSourceLowLevelAcquireNextImage.)
Protected methodLowLevelDispose
Lows level implementation to dispose the ImageSource.
(Overrides ImageSourceLowLevelDispose.)
Protected methodLowLevelFlushOnReset
Lows level implementation to determine if there should be a flush on reset.
(Overrides ImageSourceLowLevelFlushOnReset.)
Protected methodLowLevelHasMoreImages
Lows level implementation to determine if the ImageSource has more images.
(Overrides ImageSourceLowLevelHasMoreImages.)
Protected methodLowLevelReplaceImage
Low level implementation to replace an image.
(Overrides ImageSourceLowLevelReplaceImage(ImageSourceNode, AtalaImage).)
Protected methodLowLevelReset
Lows level implementation of reset.
(Overrides ImageSourceLowLevelReset.)
Protected methodLowLevelSkipNextImage
Lows level implementation to skip next image.
(Overrides ImageSourceLowLevelSkipNextImage.)
Protected methodLowLevelTotalImages
Lows level implementation that returns the total number of images.
(Overrides ImageSourceLowLevelTotalImages.)
Protected methodLowLevelTotalImagesKnown
Returns if the total images is known.
(Inherited from RandomAccessImageSource.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNotifyChangedImage(AtalaImage)
This method is used to inform an ImageSource that one of its current acquired images has changed.
(Inherited from ImageSource.)
Public methodNotifyChangedImage(AtalaImage, AtalaImage)
This method is used to inform an ImageSource that one of its current acquired images has changed.
(Inherited from ImageSource.)
Protected methodOnChangedImage
Raises the [E:ChangedImage] event.
(Inherited from ImageSource.)
Protected methodOnNodeIndexSet
This method is called from the RandomAccessImageSource indexer after it has set the ImageSourceNode.Index value.
(Inherited from RandomAccessImageSource.)
Protected methodOnReleasing
Called when Release(AtalaImage) was performed on an ImageSourceNode.
(Inherited from ImageSource.)
Public methodReAcquire(Int32)
Acquire a previous image by index.
(Inherited from ImageSource.)
Public methodReAcquire(AtalaImage)
Acquire an AtalaImage that has been previously acquired.
(Inherited from ImageSource.)
Public methodRelease
Release a previously acquired image.
(Inherited from ImageSource.)
Public methodReleaseChangedImage(AtalaImage)
Release an image that has changed, notifying other clients that the image has changed.
(Inherited from ImageSource.)
Public methodReleaseChangedImage(AtalaImage, AtalaImage)
Release an image that has changed, notifying other clients that the image has changed.
(Inherited from ImageSource.)
Public methodReset
Resets the ImageSource to start over again.
(Inherited from ImageSource.)
Public methodToPath
Retrieves the path associated with a previously acquired image.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventChangedImage
This event is fired whenever an image has been replaced.
(Inherited from ImageSource.)
Public eventImageAcquired
Invoked when an image is acquired into memory.
Public eventReleasing
Raised when the Release(AtalaImage) method is called on an ImageSourceNode.
(Inherited from ImageSource.)
Top
Remarks
This class can be used to open a large multi-page TIFF document. Create an instance of the FileSystemImageSource setting the doAllFrames parameter to true.
See Also