SaveDocumentToTIFF(String,TiffCompression) Method

In This Topic

Saves the document currently handled by this AnnotationManager object to a file in TIFF format according to a file path you have specified. The file is saved with full GdPicture/XMP annotation support.

Please consider using the BurnAnnotationsToPage(Boolean) method before saving, if you expect, that your annotations will be included in the document content.

The SavingProgress event is raised after each successfully saved page.

Syntax

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

'Declaration
 
Public Overloads Function SaveDocumentToTIFF( _
   ByVal FilePath As String, _
   ByVal Compression As TiffCompression _
) As GdPictureStatus

public GdPictureStatus SaveDocumentToTIFF( 
   string FilePath,
   TiffCompression Compression
)

public function SaveDocumentToTIFF( 
    FilePath: String;
    Compression: TiffCompression
): GdPictureStatus;

public function SaveDocumentToTIFF( 
   FilePath : String,
   Compression : TiffCompression
) : GdPictureStatus;

public: GdPictureStatus SaveDocumentToTIFF( 
   string* FilePath,
   TiffCompression Compression
)

public:
GdPictureStatus SaveDocumentToTIFF( 
   String^ FilePath,
   TiffCompression Compression
)

Parameters

FilePath: The file path including the full document name, where the resulting TIFF file will be saved.
Compression: A member of the TiffCompression enumeration. Specifies the compression method to be used to compress the resulting TIFF file.

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

Just to remind you that if you want to permanently incorporate the annotations to be part of the document content, you need to use the BurnAnnotationsToPage(Boolean) method before saving the file.

The SavingProgress event is raised when processing documents using this method.

Be aware that if the resulting file path is the same as the initial file path for multi-page TIFF files, then the GdPictureStatus.AccessDenied is returned.

This method requires the Annotations component to run.

Example

How to save the handled document to a TIFF formatted file.

VB.NET
C#

Dim annotationManager As AnnotationManager = New AnnotationManager()
If (annotationManager.InitFromFile("image.tif") = GdPictureStatus.OK) AndAlso
   (annotationManager.PageCount > 0) AndAlso (annotationManager.SelectPage(1) = GdPictureStatus.OK) Then
    Dim stamp As GdPicture14.Annotations.AnnotationRubberStamp = annotationManager.AddRubberStampAnnot(Color.Red, 0.5F, 0.5F, 2, 1, "APPROVED")
    If stamp IsNot Nothing Then
        stamp.Rotation = 20
        If (annotationManager.SaveAnnotationsToPage() = GdPictureStatus.OK) AndAlso
           (annotationManager.BurnAnnotationsToPage(true) = GdPictureStatus.OK) AndAlso
           (annotationManager.SaveDocumentToTIFF("image_approved.tif", TiffCompression.TiffCompressionAUTO) = GdPictureStatus.OK) Then
            MessageBox.Show("Finished successfully!", "AnnotationManager.SaveDocumentToTIFF")
        Else
            MessageBox.Show("The file can't be saved. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToTIFF")
        End If
        stamp.Dispose()
    Else
        MessageBox.Show("The rubber stamp annotation can't be created. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToTIFF")
    End If
    annotationManager.Close()
Else
    MessageBox.Show("The AnnotationManager can't be properly initialized. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToTIFF")
End If
annotationManager.Dispose()

AnnotationManager annotationManager = new AnnotationManager();
if ((annotationManager.InitFromFile("image.jpg") == GdPictureStatus.OK) &&
    (annotationManager.PageCount > 0) && (annotationManager.SelectPage(1) == GdPictureStatus.OK))
{
    GdPicture14.Annotations.AnnotationRubberStamp stamp = annotationManager.AddRubberStampAnnot(Color.Red, 0.5f, 0.5f, 2, 1, "APPROVED");
    if (stamp != null)
    {
        stamp.Rotation = 20;
        if ((annotationManager.SaveAnnotationsToPage() == GdPictureStatus.OK) &&
            (annotationManager.BurnAnnotationsToPage(true) == GdPictureStatus.OK) &&
            (annotationManager.SaveDocumentToTIFF("image_approved.tif", TiffCompression.TiffCompressionAUTO) == GdPictureStatus.OK))
            MessageBox.Show("Finished successfully!", "AnnotationManager.SaveDocumentToTIFF");
        else
            MessageBox.Show("The file can't be saved. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToTIFF");
        stamp.Dispose();
    }
    else
        MessageBox.Show("The rubber stamp annotation can't be created. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToTIFF");
    annotationManager.Close();
}
else
    MessageBox.Show("The AnnotationManager can't be properly initialized. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToTIFF");
annotationManager.Dispose();

Reference

AnnotationManager Class
AnnotationManager Members
Overload List
SaveDocumentToJPEG(String,Int32) Method
SaveDocumentToPDF(String) Method
SavingProgress Event
BurnAnnotationsToPage(Boolean) Method