SaveDocumentToTIFF(String,String,String,TiffCompression) Method

In This Topic

Saves the document displayed in the GdViewer control to a file in TIFF format on a distant server using HTTP or FTP transfer according to what you have specified. The file transfer will be run synchronously. The document 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 DataReceived event is raised to allow you to monitor the transferred data. Likewise, the TransferEnded event is raised right after the transfer will finish. You can also control displaying the progress bar by enabling or disabling the EnabledProgressBar property.

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 Uri As String, _
   ByVal Login As String, _
   ByVal Password As String, _
   ByVal Compression As TiffCompression _
) As GdPictureStatus

public GdPictureStatus SaveDocumentToTIFF( 
   string Uri,
   string Login,
   string Password,
   TiffCompression Compression
)

public function SaveDocumentToTIFF( 
    Uri: String;
    Login: String;
    Password: String;
    Compression: TiffCompression
): GdPictureStatus;

public function SaveDocumentToTIFF( 
   Uri : String,
   Login : String,
   Password : String,
   Compression : TiffCompression
) : GdPictureStatus;

public: GdPictureStatus SaveDocumentToTIFF( 
   string* Uri,
   string* Login,
   string* Password,
   TiffCompression Compression
)

public:
GdPictureStatus SaveDocumentToTIFF( 
   String^ Uri,
   String^ Login,
   String^ Password,
   TiffCompression Compression
)

Parameters

Uri: The full URI path with the full document name, where the resulting TIFF file will be saved, for example ftp://ftp.gdpicture.com/upload/myfile.tif or http://www.gdpicture.com/upload/myfile.tif.
Login: The login required to authenticate on the server. It can be an empty string.
Password: The password required to authenticate on the server. It can be an empty string.
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.

Use the GetLastTransferError method to diagnose the error if this method has failed with one of the GdPictureStatus.Internet... errors.

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.

Both the DataReceived event and the TransferEnded event are raised to allow you to monitor the transfer progress.

Likewise, the SavingProgress event is raised when processing documents using this method.

Example

How to save the file displayed in the viewer to the TIFF image on a distant server.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    'Annotate your document.
    If GdViewer1.BurnAnnotationsToPage(True) = GdPictureStatus.OK Then
        If GdViewer1.SaveDocumentToTIFF("ftp://ftp.myweb.com/upload/myimage.tif", "login", "password", TiffCompression.TiffCompressionAUTO) = GdPictureStatus.OK Then
            MessageBox.Show("Done!", "GdViewer.SaveDocumentToTIFF")
        Else
            Dim message As String = "The file can't be saved. Status: " + GdViewer1.GetStat().ToString() + vbCrLf
            If (Not String.IsNullOrEmpty(GdViewer1.GetLastTransferError())) Then
                message = message + "  ftp failure: " + GdViewer1.GetLastTransferError()
            End If
            MessageBox.Show(message, "GdViewer.SaveDocumentToTIFF")
        End If
    Else
        MessageBox.Show("Annotations can't be burned. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToTIFF")
    End If
Else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToTIFF")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    //Annotate your document.
    if (GdViewer1.BurnAnnotationsToPage(true) == GdPictureStatus.OK)
    {
        if (GdViewer1.SaveDocumentToTIFF("ftp://ftp.myweb.com/upload/myimage.tif", "login", "password", TiffCompression.TiffCompressionAUTO) == GdPictureStatus.OK)
            MessageBox.Show("Done!", "GdViewer.SaveDocumentToTIFF");
        else
        {
            string message = "The file can't be saved. Status: " + GdViewer1.GetStat().ToString() + "\n";
            if (!String.IsNullOrEmpty(GdViewer1.GetLastTransferError()))
                message = message + "  ftp failure: " + GdViewer1.GetLastTransferError();
            MessageBox.Show(message, "GdViewer.SaveDocumentToTIFF");
        }
    }
    else
        MessageBox.Show("Annotations can't be burned. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToTIFF");
}
else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToTIFF");

Reference

GdViewer Class
GdViewer Members
Overload List
SaveDocumentToJPEG(String,Int32) Method
SaveDocumentToJPEG(Stream,Int32) Method
SaveDocumentToJPEG(String,String,String,Int32) Method
SaveDocumentToPDF(String) Method
SaveDocumentToPDF(Stream) Method
SaveDocumentToPDF(String,String,String) Method
SavingProgress Event
EnabledProgressBar Property
BurnAnnotationsToPage(Boolean) Method
GetLastTransferError Method