SaveAsTIFF(Int32,String,Boolean,TiffCompression) Method

In This Topic

Saves a required GdPicture image to a given file path as Tagged Image File Format (tif) acording to what you have specified. You can utilize the CMYK color space if required when saving an image using this method.

This method only saves the currently selected page of the specified image if it is an editable multipage TIFF image.

Syntax

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

'Declaration
 
Public Overloads Function SaveAsTIFF( _
   ByVal ImageID As Integer, _
   ByVal FilePath As String, _
   ByVal CMYKMode As Boolean, _
   ByVal Compression As TiffCompression _
) As GdPictureStatus

public GdPictureStatus SaveAsTIFF( 
   int ImageID,
   string FilePath,
   bool CMYKMode,
   TiffCompression Compression
)

public function SaveAsTIFF( 
    ImageID: Integer;
    FilePath: String;
    CMYKMode: Boolean;
    Compression: TiffCompression
): GdPictureStatus;

public function SaveAsTIFF( 
   ImageID : int,
   FilePath : String,
   CMYKMode : boolean,
   Compression : TiffCompression
) : GdPictureStatus;

public: GdPictureStatus SaveAsTIFF( 
   int ImageID,
   string* FilePath,
   bool CMYKMode,
   TiffCompression Compression
)

public:
GdPictureStatus SaveAsTIFF( 
   int ImageID,
   String^ FilePath,
   bool CMYKMode,
   TiffCompression Compression
)

Parameters

ImageID: A unique image identifier of the GdPicture image representing the image to be saved.
FilePath: The file path where the specified image will be saved. Use the empty string to allow the control to prompt users to select a file. If the specified file already exists, it will be overwritten.
You can subsequently use the GdPictureImaging.GetLastPath method to retrieve the path of the selected file.
CMYKMode: Set this parameter to true, if you want to save the required image as TIFF file in CMYK color space, otherwise set it to false.
Compression: A member of the TiffCompression enumeration. The resulting TIFF compression scheme to be used.
Please note that if you apply the JPEG compression, the quality factor used by default is 90. You can use the overloaded GdPictureImaging.SaveAsTIFF method to set your preferred value for the JpegQuality parameter.

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

Be aware that if the specified GdPicture image represents an editable multipage TIFF image, this method only saves the currently selected page. You should use the GdPictureImaging.TiffSaveMultiPageToFile method to save an editable multipage TIFF image instead.

Example

Applying ICM correction when saving CMYK based image as a tiff image.

using (GdPictureImaging gdpictureImaging = new GdPictureImaging())
{
    string filePath = "image.jpg";
    if (gdpictureImaging.IsCMYKFile(filePath))
    {
        // Enable color correction.
        gdpictureImaging.EnableICM(true);
        int imageID = gdpictureImaging.CreateGdPictureImageFromFile(filePath);
 
        gdpictureImaging.SaveAsTIFF(imageID, "output.tiff", true, TiffCompression.TiffCompressionAUTO);
 
        // Release used resources.
        gdpictureImaging.ReleaseGdPictureImage(imageID);
    }
}

Reference

GdPictureImaging Class
GdPictureImaging Members
Overload List
GetLastPath Method
CreateGdPictureImageFromFile(String,Boolean) Method
TiffSaveMultiPageToFile(Int32,String,TiffCompression) Method