TiffOptions class

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.

Inheritance: TiffOptionsImageOptionsBase

The TiffOptions type exposes the following members:

Constructors

ConstructorDescription
initInitializes a new instance of the TiffOptions class.
initInitializes a new instance of the TiffOptions class. By default little endian convention is used.
initInitializes a new instance of the TiffOptions class.
initInitializes a new instance of the TiffOptions class.

Properties

PropertyDescription
target_format
rotationGets or sets the parameter for rotate, flip, or rotate and flip the image..
layersGets or sets a of layer names must be exported.
All data will be exported without layers if names is not sets.
xmp_dataGets or sets the XMP metadata container.
sourceGets or sets the source to create image in.
paletteGets or sets the color palette.
resolution_settingsGets or sets the resolution settings.
vector_rasterization_optionsGets or sets the vector rasterization options.
timeoutTimeout value for export operation (in milliseconds)
pc_3_fileGets or sets the PC3 file full name.
user_watermark_textText for user-generated watermark
user_watermark_colorColor for user-generated watermark
is_validGets a value indicating whether the TiffOptions have been properly configured. Use Validate method as to find the failure reason.
artistGets or sets the artist.
byte_orderGets or sets a value indicating the tiff byte order.
bits_per_sampleGets or sets the bits per sample.
compressionGets or sets the compression.
copyrightGets or sets the copyright.
color_mapGets or sets the color map.
date_timeGets or sets the date and time.
document_nameGets or sets the name of the document.
alpha_storageGets or sets the alpha storage option. Options other than TiffAlphaStorage.UNSPECIFIED
are used when there are more than 3 TiffOptions.samples_per_pixel defined.
is_extra_samples_presentGets a value indicating whether the extra samples is present.
fill_orderGets or sets the byte bits fill order.
half_tone_hintsGets or sets the halftone hints.
image_descriptionGets or sets the image description.
ink_namesGets or sets the ink names.
scanner_manufacturerGets or sets the scanner manufacturer.
max_sample_valueGets or sets the max sample value.
min_sample_valueGets or sets the min sample value.
scanner_modelGets or sets the scanner model.
orientationGets or sets the orientation.
page_nameGets or sets the page name.
page_numberGets or sets the page number tag.
photometricGets or sets the photometric.
planar_configurationGets or sets the planar configuration.
resolution_unitGets or sets the resolution unit.
rows_per_stripGets or sets the rows per strip.
sample_formatGets or sets the sample format.
samples_per_pixelGets the samples per pixel. To change this property value use the TiffOptions.bits_per_sample property setter.
smax_sample_valueGets or sets the max sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).
smin_sample_valueGets or sets the min sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).
software_typeGets or sets the software type.
strip_byte_countsGets or sets the strip byte counts.
strip_offsetsGets or sets the strip offsets.
sub_file_typeGets or sets a general indication of the kind of data contained in this subfile.
target_printerGets or sets the target printer.
threshholdingGets or sets the threshholding.
total_pagesGets the total pages.
xpositionGets or sets the x position.
xresolutionGets or sets the x resolution.
ypositionGets or sets the y position.
yresolutionGets or sets the y resolution.
fax_t4_optionsGets or sets the fax t4 options.
predictorGets or sets the predictor for LZW compression.
image_lengthGets or sets the image length.
image_widthGets or sets the image width.
tagsGets or sets the tags.
valid_tag_countGets the valid tag count. This is not the total tags count but the number of tags which may be preserved.
bits_per_pixelGets the bits per pixel.

Methods

MethodDescription
is_tag_presentDetermines whether tag is present in the options or not.
get_valid_tags_countGets the valid tags count.
remove_tagRemoves the tag.
validateValidates if options have valid combination of tags
add_tagsAdds the tags.
add_tagAdds a new tag.
get_tag_by_typeGets the instance of the tag by type.

See Also