SaveDocumentToPDF(Stream) Method

In This Topic

Saves the document displayed in the GdViewer control in PDF format to an instantiated Stream object according to what you have specified. 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, for example for printing or to disable their editing.

The SavingProgress event is raised after each successfully saved page, when processing the image-based documents, in other words if you are saving the multi-page TIFF file to PDF document.

Syntax

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

'Declaration
 
Public Overloads Function SaveDocumentToPDF( _
   ByVal Stream As Stream _
) As GdPictureStatus

public GdPictureStatus SaveDocumentToPDF( 
   Stream Stream
)

public function SaveDocumentToPDF( 
    Stream: Stream
): GdPictureStatus;

public function SaveDocumentToPDF( 
   Stream : Stream
) : GdPictureStatus;

public: GdPictureStatus SaveDocumentToPDF( 
   Stream* Stream
)

public:
GdPictureStatus SaveDocumentToPDF( 
   Stream^ Stream
)

Parameters

Stream: A System.IO.Stream object where the resulting PDF document will be saved to. This Stream object must be initialized before it can be sent into this method and it should remain open for subsequent use.

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 document.

The SavingProgress event is raised, when processing the image-based documents using this method.

The output stream should be open for writing and should be closed/disposed by the user as well.

Example

How to save the file displayed in the viewer to the PDF document using the stream.

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
        Dim oFileStream As System.IO.FileStream = New System.IO.FileStream("mydocument.pdf", System.IO.FileMode.Create)
        If GdViewer1.SaveDocumentToPDF(oFileStream) = GdPictureStatus.OK Then
            MessageBox.Show("Done!", "GdViewer.SaveDocumentToPDF")
        Else
            MessageBox.Show("The file can't be saved. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToPDF")
        End If
        oFileStream.Dispose()
    Else
        MessageBox.Show("Annotations can't be burned. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToPDF")
    End If
Else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToPDF")
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)
    {
        System.IO.FileStream oFileStream = new System.IO.FileStream("mydocument.pdf", System.IO.FileMode.Create);
        if (GdViewer1.SaveDocumentToPDF(oFileStream) == GdPictureStatus.OK)
            MessageBox.Show("Done!", "GdViewer.SaveDocumentToPDF");
        else
            MessageBox.Show("The file can't be saved. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToPDF");
        oFileStream.Dispose();
    }
    else
        MessageBox.Show("Annotations can't be burned. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToPDF");
}
else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SaveDocumentToPDF");

Reference

GdViewer Class
GdViewer Members
Overload List
SaveDocumentToJPEG(Stream,Int32) Method
SaveDocumentToTIFF(Stream,TiffCompression) Method
SavingProgress Event
BurnAnnotationsToPage(Boolean) Method