TiffExtendedParams Object (ITiffExtendedParams Interface)
This object provides functionality for tuning the parameters of saving an image to TIFF format (all IFF_Tiff... image format types) using the IImage::WriteToFile method. A pointer to this object is passed into the IImage::WriteToFile method as an input parameter, and thus affects the size and quality of the resulting image. All properties of a newly created object of this type are set to reasonable defaults. See the description of particular property for its default value.
The TiffExtendedParams object is a persistent object. This means that the object's current state can be written to persistent storage: an area in the global memory or a disk file. Later, the object can be re-created by reading the object's state from persistent storage. The following methods provide persistence of the object: SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.
Properties
| Name | Type | Description |
|---|---|---|
| Application | Engine, read-only | Returns the Engine object. |
| JpegQuality | int |
Stores the value of the JPEG quality in percent, for those image formats which use JPEG compression (IFF_TiffColorJpegJfif, IFF_TiffGrayJpegJfif). The default value of this property is 50. |
| WriteSingleStrip | VARIANT_BOOL |
Specifies if the whole image should be saved as a single strip.
The default value of this property is FALSE. |
Methods
| Name | Description |
|---|---|
| CopyFrom | Initializes properties of the current object with values of similar properties of another object. |
| LoadFromFile | Restores the object contents from a file on disk. |
| LoadFromMemory | Restores the object contents from the global memory. |
| SaveToFile | Saves the object contents into a file on disk. |
| SaveToMemory | Saves the object contents into the global memory. |
Output parameter
This object is the output parameter of the CreateTiffExtendedParams method of the Engine object.
Input parameter
This object is passed as an input parameter to the following methods:
- WriteToFile method of the Image object
- CreateMultipageImageWriter method of the Engine object
See also
9/17/2024 3:14:40 PM