GrapeCity.Documents.Imaging.Windows.GcWicTiffReader

Class GcWicTiffReader

Namespace

GrapeCity.Documents.Imaging.Windows

Assembly

GcDocs.Imaging.Windows.dll

Allows reading images from a multipage TIFF file/stream.

public class GcWicTiffReader : IDisposable

Inheritance

object

GcWicTiffReader

Implements

System.IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

GcWicTiffReader(Stream, bool, int, ImagingFactory)

Initializes a new instance of GcWicTiffReader class and assigns the input stream.

public GcWicTiffReader(Stream stream, bool ownStream = false, int frameIndex = -1, ImagingFactory imagingFactory = null)

Parameters

stream System.IO.Stream

The input stream.

ownStream bool

Indicates if the input stream should be closed when the GcWicTiffReader is disposed.

frameIndex int

Index of a frame to read. Pass -1 to get all frames.

imagingFactory ImagingFactory

The existing imaging factory, to avoid duplicating factories.

GcWicTiffReader(string, int, ImagingFactory)

Initializes a new instance of GcWicTiffReader class and assigns the input file.

public GcWicTiffReader(string filePath, int frameIndex = -1, ImagingFactory imagingFactory = null)

Parameters

filePath string

Full path to the input .tiff file.

frameIndex int

Index of a frame to read. Pass -1 to get all frames.

imagingFactory ImagingFactory

The existing imaging factory, to avoid duplicating factories.

Properties

FilePath

If possible, gets the file name of the associated .tiff file.

public string FilePath { get; }

Property Value

string

Frames

Gets the list of frames in the associated TIFF file/stream.

public List<WicTiffFrame> Frames { get; }

Property Value

System.Collections.Generic.List<T><WicTiffFrame>

OwnStream

Gets a value indicating if the associated stream should be closed when the GcWicTiffReader is disposed.

public bool OwnStream { get; }

Property Value

bool

OwnWicFactory

Gets or sets a value indicating if the WicFactory should be disposed together with the GcWicTiffReader class.

public bool OwnWicFactory { get; set; }

Property Value

bool

Stream

Gets the Stream associated with GcWicTiffReader.

public Stream Stream { get; }

Property Value

System.IO.Stream

StreamStartPosition

Gets the start position in the associated Stream.

public long StreamStartPosition { get; }

Property Value

long

WicFactory

Gets an instance of the ImagingFactory class.

public ImagingFactory WicFactory { get; }

Property Value

ImagingFactory

Methods

ApplyLicenseKey(string)

Applies a license key to an instance of GcWicTiffReader.

public void ApplyLicenseKey(string key)

Parameters

key string

The license key to set.

Dispose()

Clean up any resources being used.

public void Dispose()

Dispose(bool)

Performs cleanup operations on managed and unmanaged resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

~GcWicTiffReader()

Performs cleanup operations on unmanaged resources.

protected ~GcWicTiffReader()