FileSystemImageSource Class

This is an implementation of an ImageSource using a file system as a provider of images.

Inheritance Hierarchy

SystemObject
  Atalasoft.ImagingImageSource
    Atalasoft.ImagingRandomAccessImageSource
      Atalasoft.ImagingFileSystemImageSource

Namespace: Atalasoft.Imaging
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
public class FileSystemImageSource : RandomAccessImageSource, 
	ISerializable, IImageStreamSource

<SerializableAttribute>
Public Class FileSystemImageSource
	Inherits RandomAccessImageSource
	Implements ISerializable, IImageStreamSource

The FileSystemImageSource type exposes the following members.

Constructors

	Name	Description
	FileSystemImageSource(SerializationInfo, StreamingContext)	Creates a new instance of FileSystemImageSource from serialization information.
	FileSystemImageSource(String, Boolean)	Provides access to all image files from a directory or file
	FileSystemImageSource(String, Boolean)	Provides access to a list of image files.
	FileSystemImageSource(String, String, Boolean)	Provides access to all image files from a directory that match a pattern or from a single file.

Top

Properties

	Name	Description
	ActiveImages	Gets the active images. (Inherited from ImageSource.)
	Count	Returns the total number of images in the image source. (Inherited from RandomAccessImageSource.)
	CulledImages	Gets the culled images. (Inherited from ImageSource.)
	Current	Returns the index of the current image. (Inherited from ImageSource.)
	FileFilter	Gets or sets a delegate that is invoked for each file, allowing the files to be filtered with custom rules.
	ImmediateUnload	Determines if an image should be unloaded from memory immediately. (Inherited from ImageSource.)
	Item	Acquires the image at location i within the image source and returns it. (Inherited from RandomAccessImageSource.)
	MemoryInUse	Returns an estimate of the number of bytes of memory currently in use by images in this ImageSource. (Inherited from ImageSource.)
	MemoryLimit	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.)
	TotalImages	Returns the total number of available images in this ImageSource. (Inherited from ImageSource.)
	TotalImagesKnown	Gets a value indicating whether or not the total number of images in this image source can be known. (Inherited from ImageSource.)

Top

Methods

	Name	Description
	Acquire(Int32)	Obsolete. This method has been deprecated. Use ReAcquire(AtalaImage) instead. (Inherited from ImageSource.)
	Acquire(AtalaImage)	Obsolete. This method has been deprecated. Use ReAcquire(AtalaImage) instead. (Inherited from ImageSource.)
	AcquireNext	Acquire the next available image from the ImageSource. (Inherited from ImageSource.)
	AllImagesAreReleased	Determines if all the images have been released. (Inherited from ImageSource.)
	AllowFile	Called to determine whether a file is allowed.
	ContainsImage	Determines whether this ImageSource contains the specified image. (Inherited from ImageSource.)
	CullNode	Culls the node from the ImageSource (Inherited from ImageSource.)
	CullReleasedImages	Culls all released images. (Inherited from ImageSource.)
	Dispose	Free up resources used by this ImageSource (Inherited from ImageSource.)
	Dispose(Boolean)	Releases unmanaged and - optionally - managed resources. (Inherited from ImageSource.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Finalizes an instance of the ImageSource class. (Inherited from ImageSource.)
	Find	Finds the specified image. (Inherited from ImageSource.)
	Flush	Flush all released images out of memory. (Inherited from ImageSource.)
	GetFrameCount	Returns the number of frames in for an image in a FileSystemImageSource.
	GetFrameNumber	Return the frame index of an image in the FileSystemImageSource.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetImageStream	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.
	GetObjectData	Fills a SerializationInfo object with object information. (Overrides RandomAccessImageSourceGetObjectData(SerializationInfo, StreamingContext).)
	GetPath	Returns the path of the image in a FileSystemImageSource.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasMoreImages	Determines if there are more images to load. (Inherited from ImageSource.)
	LowLevelAcquire	Performs an acquire of an indexed image. (Overrides RandomAccessImageSourceLowLevelAcquire(Int32).)
	LowLevelAcquireNextImage	Lows level implementation to acquire next image. (Overrides ImageSourceLowLevelAcquireNextImage.)
	LowLevelDispose	Lows level implementation to dispose the ImageSource. (Overrides ImageSourceLowLevelDispose.)
	LowLevelFlushOnReset	Lows level implementation to determine if there should be a flush on reset. (Overrides ImageSourceLowLevelFlushOnReset.)
	LowLevelHasMoreImages	Lows level implementation to determine if the ImageSource has more images. (Overrides ImageSourceLowLevelHasMoreImages.)
	LowLevelReplaceImage	Low level implementation to replace an image. (Overrides ImageSourceLowLevelReplaceImage(ImageSourceNode, AtalaImage).)
	LowLevelReset	Lows level implementation of reset. (Overrides ImageSourceLowLevelReset.)
	LowLevelSkipNextImage	Lows level implementation to skip next image. (Overrides ImageSourceLowLevelSkipNextImage.)
	LowLevelTotalImages	Lows level implementation that returns the total number of images. (Overrides ImageSourceLowLevelTotalImages.)
	LowLevelTotalImagesKnown	Returns if the total images is known. (Inherited from RandomAccessImageSource.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyChangedImage(AtalaImage)	This method is used to inform an ImageSource that one of its current acquired images has changed. (Inherited from ImageSource.)
	NotifyChangedImage(AtalaImage, AtalaImage)	This method is used to inform an ImageSource that one of its current acquired images has changed. (Inherited from ImageSource.)
	OnChangedImage	Raises the [E:ChangedImage] event. (Inherited from ImageSource.)
	OnNodeIndexSet	This method is called from the RandomAccessImageSource indexer after it has set the ImageSourceNode.Index value. (Inherited from RandomAccessImageSource.)
	OnReleasing	Called when Release(AtalaImage) was performed on an ImageSourceNode. (Inherited from ImageSource.)
	ReAcquire(Int32)	Acquire a previous image by index. (Inherited from ImageSource.)
	ReAcquire(AtalaImage)	Acquire an AtalaImage that has been previously acquired. (Inherited from ImageSource.)
	Release	Release a previously acquired image. (Inherited from ImageSource.)
	ReleaseChangedImage(AtalaImage)	Release an image that has changed, notifying other clients that the image has changed. (Inherited from ImageSource.)
	ReleaseChangedImage(AtalaImage, AtalaImage)	Release an image that has changed, notifying other clients that the image has changed. (Inherited from ImageSource.)
	Reset	Resets the ImageSource to start over again. (Inherited from ImageSource.)
	ToPath	Retrieves the path associated with a previously acquired image.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ChangedImage	This event is fired whenever an image has been replaced. (Inherited from ImageSource.)
	ImageAcquired	Invoked when an image is acquired into memory.
	Releasing	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.

Reference

Atalasoft.Imaging Namespace