SaveDocumentToJPEG(String,Int32) Method

In This Topic

Saves the document handled by this AnnotationManager object to a file in JPEG format according to a file path you have specified. The file 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.

Syntax

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

'Declaration
 
Public Overloads Function SaveDocumentToJPEG( _
   ByVal FilePath As String, _
   ByVal Quality As Integer _
) As GdPictureStatus

public GdPictureStatus SaveDocumentToJPEG( 
   string FilePath,
   int Quality
)

public function SaveDocumentToJPEG( 
    FilePath: String;
    Quality: Integer
): GdPictureStatus;

public function SaveDocumentToJPEG( 
   FilePath : String,
   Quality : int
) : GdPictureStatus;

public: GdPictureStatus SaveDocumentToJPEG( 
   string* FilePath,
   int Quality
)

public:
GdPictureStatus SaveDocumentToJPEG( 
   String^ FilePath,
   int Quality
)

Parameters

FilePath: The file path including the full document name, where the resulting JPEG file will be saved.
Quality: The compression quality level from 0 to 100 to be used to compress the resulting JPEG file. 0 means worse quality and better compression, 100 means the best quality and worse compression.

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

Example

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

VB.NET
C#

Dim annotationManager As AnnotationManager = New AnnotationManager()
If (annotationManager.InitFromFile("image.jpg") = 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.SaveDocumentToJPEG("image_approved.jpg", 75) = GdPictureStatus.OK) Then
            MessageBox.Show("Finished successfully!", "AnnotationManager.SaveDocumentToJPEG")
        Else
            MessageBox.Show("The file can't be saved. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToJPEG")
        End If
        stamp.Dispose()
    Else
        MessageBox.Show("The rubber stamp annotation can't be created. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToJPEG")
    End If
    annotationManager.Close()
Else
    MessageBox.Show("The AnnotationManager can't be properly initialized. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToJPEG")
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.SaveDocumentToJPEG("image_approved.jpg", 75) == GdPictureStatus.OK))
            MessageBox.Show("Finished successfully!", "AnnotationManager.SaveDocumentToJPEG");
        else
            MessageBox.Show("The file can't be saved. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToJPEG");
        stamp.Dispose();
    }
    else
        MessageBox.Show("The rubber stamp annotation can't be created. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToJPEG");
    annotationManager.Close();
}
else
    MessageBox.Show("The AnnotationManager can't be properly initialized. Status: " + annotationManager.GetStat().ToString(), "AnnotationManager.SaveDocumentToJPEG");
annotationManager.Dispose();

Reference

AnnotationManager Class
AnnotationManager Members
Overload List
SaveDocumentToPDF(String) Method
SaveDocumentToTIFF(String,TiffCompression) Method
BurnAnnotationsToPage(Boolean) Method