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





In This Topic

SaveDocumentToPDF(Stream) Method

In This Topic
Saves the document currently handled by this AnnotationManager object 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 AnnotationManager.BurnAnnotationsToPage 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 AnnotationManager.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
'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 AnnotationManager.BurnAnnotationsToPage method before saving the document.

The AnnotationManager.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.

This method requires the Annotations component to run.

Example
How to save the handled document to a PDF formatted file using a stream.
Using annotationManager As AnnotationManager = New AnnotationManager()

    If (annotationManager.InitFromFile("test.pdf") = 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

            Dim oFileStream As System.IO.FileStream = New System.IO.FileStream("test_approved.pdf", System.IO.FileMode.Create)

            If (annotationManager.SaveAnnotationsToPage() = GdPictureStatus.OK) AndAlso

               (annotationManager.BurnAnnotationsToPage(True) = GdPictureStatus.OK) AndAlso

               (annotationManager.SaveDocumentToPDF(oFileStream) = GdPictureStatus.OK) Then

                MessageBox.Show("Finished successfully!", "AnnotationManager.SaveDocumentToPDF")

            Else

                MessageBox.Show("The file can't be saved. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToPDF")

            End If

            oFileStream.Dispose()

            stamp.Dispose()

        Else

            MessageBox.Show("The rubber stamp annotation can't be created. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToPDF")

        End If

        annotationManager.Close()

    Else

        MessageBox.Show("The AnnotationManager can't be properly initialized. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToPDF")

    End If

End Using
using (AnnotationManager annotationManager = new AnnotationManager())

{

    if ((annotationManager.InitFromFile("test.pdf") == 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;

            System.IO.FileStream oFileStream = new System.IO.FileStream("test_approved.pdf", System.IO.FileMode.Create);

            if ((annotationManager.SaveAnnotationsToPage() == GdPictureStatus.OK) &&

                (annotationManager.BurnAnnotationsToPage(true) == GdPictureStatus.OK) &&

                (annotationManager.SaveDocumentToPDF(oFileStream) == GdPictureStatus.OK))

                MessageBox.Show("Finished successfully!", "AnnotationManager.SaveDocumentToPDF");

            else

                MessageBox.Show("The file can't be saved. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToPDF");

            oFileStream.Dispose();

            stamp.Dispose();

        }

        else

            MessageBox.Show("The rubber stamp annotation can't be created. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToPDF");

        annotationManager.Close();

    }

    else

        MessageBox.Show("The AnnotationManager can't be properly initialized. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToPDF");

}
See Also