GrapeCity.Documents.Imaging.GcTiffReader

Class GcTiffReader

Namespace

GrapeCity.Documents.Imaging

Assembly

GcDocs.Imaging.dll

Allows reading images from a multi-page TIFF file/stream.

public class GcTiffReader : IDisposable

Inheritance

object

GcTiffReader

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

GcTiffReader(Stream, bool, int)

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

public GcTiffReader(Stream stream, bool ownStream = false, int frameIndex = -1)

Parameters

stream System.IO.Stream

The input stream.

ownStream bool

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

frameIndex int

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

GcTiffReader(string, int)

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

public GcTiffReader(string filePath, int frameIndex = -1)

Parameters

filePath string

Full path to the input .tiff file.

frameIndex int

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

Properties

FilePath

If possible, gets full path to the associated TIFF file.

public string FilePath { get; }

Property Value

string

Frames

Gets the list of frames in the associated TIFF file.

Check the value of IsValid property before reading an image from TiffFrame.

public List<TiffFrame> Frames { get; }

Property Value

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

IsDisposed

Gets a value indicating whether the GcTiffReader has been disposed of.

public bool IsDisposed { get; }

Property Value

bool

OwnStream

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

public bool OwnStream { get; }

Property Value

bool

Stream

Gets the Stream associated with GcTiffReader.

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

Methods

ApplyLicenseKey(string)

Applies a license key to an instance of GcTiffReader.

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

~GcTiffReader()

Performs cleanup operations on unmanaged resources.

protected ~GcTiffReader()