AppendToTiff(Int32,Stream,TiffCompression,Int32) Method

In This Topic

Appends an image resource, represented by its unique GdPicture image identifier, to a single page or a multipage TIFF file, located in a Stream object, according to what you have specified. This method allows you to set a JpegQuality parameter if you will apply a JPEG compression scheme.

The image is added as a new page after the last page of the specified destination TIFF file. If you want to add more pages from your source file to the destination TIFF file, please use this method for each single page.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function AppendToTiff( _
   ByVal ImageID As Integer, _
   ByVal Stream As Stream, _
   ByVal Compression As TiffCompression, _
   Optional ByVal JpegQuality As Integer _
) As GdPictureStatus

public GdPictureStatus AppendToTiff( 
   int ImageID,
   Stream Stream,
   TiffCompression Compression,
   int JpegQuality
)

public function AppendToTiff( 
    ImageID: Integer;
    Stream: Stream;
    Compression: TiffCompression;
    JpegQuality: Integer
): GdPictureStatus;

public function AppendToTiff( 
   ImageID : int,
   Stream : Stream,
   Compression : TiffCompression,
   JpegQuality : int
) : GdPictureStatus;

public: GdPictureStatus AppendToTiff( 
   int ImageID,
   Stream* Stream,
   TiffCompression Compression,
   int JpegQuality
)

public:
GdPictureStatus AppendToTiff( 
   int ImageID,
   Stream^ Stream,
   TiffCompression Compression,
   int JpegQuality
)

Parameters

ImageID: A unique image identifier of the GdPicture image representing the single image, that you want to append as a new page at the end of the destination TIFF file.
Stream: A Stream object containing the destination TIFF file. This stream object must be initialized before it can be sent into this method and it should remain open for subsequent use.
Compression: A member of the TiffCompression enumeration. The resulting TIFF compression scheme to be used.
JpegQuality: Specifies the JPEG compression quality, between 1 (worst quality) and 100 (better quality). This parameter is ignored when the specified TIFF compression scheme is different than JPEG.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

Please note that the output stream should be open for writing and should be closed/disposed of by the user as well.

Be aware that if you are applying CCITT3 or CCITT4 compression scheme, the image you want to append can only be 1bpp, otherwise the LZW compression scheme is used.

This method requires the Image Documents component to run.

Reference

GdPictureImaging Class
GdPictureImaging Members
Overload List
SaveAsTIFF(Int32,String,TiffCompression) Method