Class TiffFieldInfo

Represents a TIFF field information.

Inheritance

System.Object

TiffFieldInfo

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: BitMiracle.LibTiff.Classic

Assembly: BitMiracle.LibTiff.NET.dll

Syntax

public class TiffFieldInfo

Remarks

TiffFieldInfo describes a field. It provides information about field name, type, number of values etc.

Constructors

TiffFieldInfo(TiffTag, Int16, Int16, TiffType, Int16, Boolean, Boolean, String)

Initializes a new instance of the TiffFieldInfo class.

Declaration

public TiffFieldInfo(TiffTag tag, short readCount, short writeCount, TiffType type, short bit, bool okToChange, bool passCount, string name)

Parameters

Type	Name	Description
TiffTag	tag	The tag to describe.
System.Int16	readCount	The number of values to read when reading field information or one of Variable, Spp and Variable2.
System.Int16	writeCount	The number of values to write when writing field information or one of Variable, Spp and Variable2.
TiffType	type	The type of the field value.
System.Int16	bit	Index of the bit to use in "Set Fields Vector" when this instance is merged into field info collection. Take a look at FieldBit class.
System.Boolean	okToChange	If true, then it is permissible to set the tag's value even after writing has commenced.
System.Boolean	passCount	If true, then number of value elements should be passed to SetField(TiffTag, Object[]) method as second parameter (right after tag type AND before value itself).
System.String	name	The name (description) of the tag this instance describes.

Fields

Spp

marker for SamplesPerPixel-bound tags

Declaration

public const short Spp = -2

Field Value

Type	Description
System.Int16

Variable

marker for variable length tags

Declaration

public const short Variable = -1

Field Value

Type	Description
System.Int16

Variable2

marker for integer variable length tags

Declaration

public const short Variable2 = -3

Field Value

Type	Description
System.Int16

Properties

Bit

Index of the bit to use in "Set Fields Vector" when this instance is merged into field info collection. Take a look at FieldBit class.

Declaration

public short Bit { get; }

Property Value

Type	Description
System.Int16

Name

The name (or description) of the tag this instance describes.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

OkToChange

If true, then it is permissible to set the tag's value even after writing has commenced.

Declaration

public bool OkToChange { get; }

Property Value

Type	Description
System.Boolean

PassCount

If true, then number of value elements should be passed to SetField(TiffTag, Object[]) method as second parameter (right after tag type AND before values itself).

Declaration

public bool PassCount { get; }

Property Value

Type	Description
System.Boolean

ReadCount

Number of values to read when reading field information or one of Variable, Spp and Variable2.

Declaration

public short ReadCount { get; }

Property Value

Type	Description
System.Int16

Tag

The tag described by this instance.

Declaration

public TiffTag Tag { get; }

Property Value

Type	Description
TiffTag

Type

Type of the field values.

Declaration

public TiffType Type { get; }

Property Value

Type	Description
TiffType

WriteCount

Number of values to write when writing field information or one of Variable, Spp and Variable2.

Declaration

public short WriteCount { get; }

Property Value

Type	Description
System.Int16

Methods

ToString()

Returns a System.String that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

Overrides

System.Object.ToString()