GrapeCity.Documents.Imaging.TiffFrame

Class TiffFrame

Namespace

GrapeCity.Documents.Imaging

Assembly

GcDocs.Imaging.dll

Represents a single frame in TIFF file.

public class TiffFrame

Inheritance

object

TiffFrame

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Artist

Gets a string that describes a person who created the image.

public string Artist { get; }

Property Value

string

Copyright

Gets a string with image copyright notice.

public string Copyright { get; }

Property Value

string

DateTime

Gets a string with date and time of image creation in “YYYY:MM:DD HH:MM:SS”, with hours like those on a 24-hour clock, and one space character between the date and the time.

public string DateTime { get; }

Property Value

string

DpiX

Gets the horizontal DPI of the image.

public float DpiX { get; }

Property Value

float

DpiY

Gets the vertical DPI of the image.

public float DpiY { get; }

Property Value

float

ExifProfile

Gets or sets an instance of ExifProfile with Exif metadata of the image.

public ExifProfile ExifProfile { get; set; }

Property Value

ExifProfile

FrameIndex

Gets the index of the frame in the associated TIFF file.

public int FrameIndex { get; }

Property Value

int

HostComputer

Gets a string that describes the computer and/or operating system in use at the time of image creation.

public string HostComputer { get; }

Property Value

string

ImageDescription

Gets a string that describes the subject of the image.

public string ImageDescription { get; }

Property Value

string

ImageLength

Gets the number of rows (sometimes described as scanlines) in the image.

public int ImageLength { get; }

Property Value

int

ImageWidth

Gets the number of columns in the image, i.e., the number of pixels per scanline.

public int ImageWidth { get; }

Property Value

int

IsBilevelBitmap

Gets a value indicating if the frame can be read as a BilevelBitmap.

public bool IsBilevelBitmap { get; }

Property Value

bool

IsGrayscaleBitmap

Gets a value indicating if the frame can be read as a GrayscaleBitmap.

public bool IsGrayscaleBitmap { get; }

Property Value

bool

IsIndexed4bppBitmap

Gets a value indicating if the frame can be read as a Indexed4bppBitmap.

public bool IsIndexed4bppBitmap { get; }

Property Value

bool

IsIndexed8bppBitmap

Gets a value indicating if the frame can be read as a Indexed8bppBitmap.

public bool IsIndexed8bppBitmap { get; }

Property Value

bool

IsValid

Gets a value indicating whether or not an image can be read from the TIFF frame.

public bool IsValid { get; }

Property Value

bool

Make

Gets a string that describes the scanner manufacturer.

public string Make { get; }

Property Value

string

Model

Gets a string with the scanner model name or number.

public string Model { get; }

Property Value

string

Opaque

Gets a value indicating whether the alpha channel of the image should be ignored.

public bool Opaque { get; }

Property Value

bool

Orientation

Gets the orientation of the image.

public TiffOrientation Orientation { get; }

Property Value

TiffOrientation

PrimaryChromaticities

Gets the chromaticities of the primaries of the image.

public float[] PrimaryChromaticities { get; }

Property Value

float[]

Reader

Gets the associated GcTiffReader.

public GcTiffReader Reader { get; }

Property Value

GcTiffReader

Software

Gets a string with the name and version number of the software package(s) used to create the image.

public string Software { get; }

Property Value

string

ValidationResult

Gets a value specifying the reason if an image cannot be loaded from the TIFF frame.

public TiffValidationResult ValidationResult { get; }

Property Value

TiffValidationResult

WhitePoint

Gets the chromaticity of the white point of the image.

public float[] WhitePoint { get; }

Property Value

float[]

Methods

ReadAsBilevelBitmap(bool)

Gets the frame image as a BilevelBitmap.

public BilevelBitmap ReadAsBilevelBitmap(bool cloneExif = true)

Parameters

cloneExif bool

Specifies whether the Exif metadata should be cloned (if exist), not just copied as a reference.

Returns

BilevelBitmap

BilevelBitmap or null if the image is not in bi-level format.

ReadAsGrayscaleBitmap(bool)

Gets the frame image as a GrayscaleBitmap.

public GrayscaleBitmap ReadAsGrayscaleBitmap(bool cloneExif = true)

Parameters

cloneExif bool

Specifies whether the Exif metadata should be cloned (if exist), not just copied as a reference.

Returns

GrayscaleBitmap

GrayscaleBitmap or null if the image is not in grayscale 8bpp format.

ReadAsIndexed4bppBitmap(bool)

Gets the frame image as a Indexed4bppBitmap.

public Indexed4bppBitmap ReadAsIndexed4bppBitmap(bool cloneExif = true)

Parameters

cloneExif bool

Specifies whether the Exif metadata should be cloned (if exist), not just copied as a reference.

Returns

Indexed4bppBitmap

Indexed4bppBitmap or null if the image is not in palette-color 4bpp format.

ReadAsIndexed8bppBitmap(bool)

Gets the frame image as a Indexed8bppBitmap.

public Indexed8bppBitmap ReadAsIndexed8bppBitmap(bool cloneExif = true)

Parameters

cloneExif bool

Specifies whether the Exif metadata should be cloned (if exist), not just copied as a reference.

Returns

Indexed8bppBitmap

Indexed8bppBitmap or null if the image is not in palette-color 8bpp format.

ToGcBitmap()

Gets the frame image as a GcBitmap.

public GcBitmap ToGcBitmap()

Returns

GcBitmap

ToGcBitmap(GcBitmap, bool)

Reads the frame image into an existing GcBitmap.

public void ToGcBitmap(GcBitmap bmp, bool cloneExif)

Parameters

bmp GcBitmap

The target GcBitmap object.

cloneExif bool

Specifies whether the Exif metadata should be cloned (if exist), not just copied as a reference.

ToImage(ImageBinding)

Creates an Image object for the frame.

public Image ToImage(ImageBinding binding = ImageBinding.FilePath)

Parameters

binding ImageBinding

Specifies how the image data is attached to the Image object.

Returns

Image

The newly created Image object.