TiffOptions

TiffOptions class

The tiff file format options. Note that width and height tags will get overwritten on image creation by width and height parameters so there is no need to specify them directly. Note that many options return a default value but that does not mean that this option is set explicitly as a tag value. To verify the tag is present use Tags property or the corresponding IsTagPresent method.

public class TiffOptions : ImageOptionsBase

Constructors

Name Description
TiffOptions(TiffDataType[]) Initializes a new instance of the TiffOptions class.
TiffOptions(TiffExpectedFormat) Initializes a new instance of the TiffOptions class. By default little endian convention is used.
TiffOptions(TiffOptions) Initializes a new instance of the TiffOptions class.
TiffOptions(TiffExpectedFormat, TiffByteOrder) Initializes a new instance of the TiffOptions class.

Properties

Name Description
AlphaStorage { get; set; } Gets or sets the alpha storage option. Options other than Unspecified are used when there are more than 3 SamplesPerPixel defined.
Artist { get; set; } Gets or sets the artist.
BitsPerPixel { get; } Gets the bits per pixel.
BitsPerSample { get; set; } Gets or sets the bits per sample.
ByteOrder { get; set; } Gets or sets a value indicating the tiff byte order.
ColorMap { get; set; } Gets or sets the color map.
Compression { get; set; } Gets or sets the compression.
Copyright { get; set; } Gets or sets the copyright.
DateTime { get; set; } Gets or sets the date and time.
DocumentName { get; set; } Gets or sets the name of the document.
FaxT4Options { get; set; } Gets or sets the fax t4 options.
FillOrder { get; set; } Gets or sets the byte bits fill order.
HalfToneHints { get; set; } Gets or sets the halftone hints.
IccProfile { get; } Gets the icc profile stream.
ImageDescription { get; set; } Gets or sets the image description.
ImageLength { get; set; } Gets or sets the image length.
ImageWidth { get; set; } Gets or sets the image width.
InkNames { get; set; } Gets or sets the ink names.
InterruptionToken { get; set; } Token that can be used to interrupt export operation
IsExtraSamplesPresent { get; } Gets a value indicating whether the extra samples is present.
IsValid { get; } Gets a value indicating whether the TiffOptions have been properly configured. Use Validate method as to find the failure reason.
Layers { get; set; } Gets or sets a of layer names must be exported. All data will be exported without layers if names is not sets.
MaxSampleValue { get; set; } Gets or sets the max sample value.
MinSampleValue { get; set; } Gets or sets the min sample value.
Orientation { get; set; } Gets or sets the orientation.
PageName { get; set; } Gets or sets the page name.
PageNumber { get; set; } Gets or sets the page number tag.
override Palette { get; set; } Gets or sets the color palette.
Pc3File { get; set; } Gets or sets the PC3 file full name.
Photometric { get; set; } Gets or sets the photometric.
PlanarConfiguration { get; set; } Gets or sets the planar configuration.
Predictor { get; set; } Gets or sets the predictor for LZW compression.
override ResolutionSettings { get; set; } Gets or sets the resolution settings.
ResolutionUnit { get; set; } Gets or sets the resolution unit.
Rotation { get; set; } Gets or sets the parameter for rotate, flip, or rotate and flip the image..
RowsPerStrip { get; set; } Gets or sets the rows per strip.
SampleFormat { get; set; } Gets or sets the sample format.
SamplesPerPixel { get; } Gets the samples per pixel. To change this property value use the BitsPerSample property setter.
ScannerManufacturer { get; set; } Gets or sets the scanner manufacturer.
ScannerModel { get; set; } Gets or sets the scanner model.
SmaxSampleValue { get; set; } Gets or sets the max sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).
SminSampleValue { get; set; } Gets or sets the min sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).
SoftwareType { get; set; } Gets or sets the software type.
Source { get; set; } Gets or sets the source to create image in.
StripByteCounts { get; set; } Gets or sets the strip byte counts.
StripOffsets { get; set; } Gets or sets the strip offsets.
SubFileType { get; set; } Gets or sets a general indication of the kind of data contained in this subfile.
Tags { get; set; } Gets or sets the tags.
TargetPrinter { get; set; } Gets or sets the target printer.
Threshholding { get; set; } Gets or sets the threshholding.
Timeout { get; set; } Timeout value for export operation
TotalPages { get; } Gets the total pages.
UserWatermarkColor { get; set; } Color for user-generated watermark
UserWatermarkText { get; set; } Text for user-generated watermark
ValidTagCount { get; } Gets the valid tag count. This is not the total tags count but the number of tags which may be preserved.
VectorRasterizationOptions { get; set; } Gets or sets the vector rasterization options.
override XmpData { get; set; } Gets or sets the XMP metadata container.
Xposition { get; set; } Gets or sets the x position.
Xresolution { get; set; } Gets or sets the x resolution.
Yposition { get; set; } Gets or sets the y position.
Yresolution { get; set; } Gets or sets the y resolution.

Methods

Name Description
AddTag(TiffDataType) Adds a new tag.
AddTags(TiffDataType[]) Adds the tags.
GetTagByType(TiffTags) Gets the instance of the tag by type.
IsTagPresent(TiffTags) Determines whether tag is present in the options or not.
RemoveTag(TiffTags) Removes the tag.
Validate() Validates if options have valid combination of tags
static GetValidTagsCount(TiffDataType[]) Gets the valid tags count.

See Also