BurnAnnotationsToPage(Boolean,GdPictureOutputIntent) Method

In This Topic

Burn, in other words flatten, the GdPicture/XMP annotations into the selected page of the document currently handled by this AnnotationManager object.

Burning (flattening) annotations means simply including them directly into the content of the page, to which they belong, so they are not more editable. This will permanently write an annotation into the document, so it is not considered as an annotation anymore.

This method doesn't support custom annotations burning.

Syntax

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

'Declaration
 
Public Overloads Function BurnAnnotationsToPage( _
   ByVal RemoveInitialAnnots As Boolean, _
   ByVal Intent As GdPictureOutputIntent _
) As GdPictureStatus

public GdPictureStatus BurnAnnotationsToPage( 
   bool RemoveInitialAnnots,
   GdPictureOutputIntent Intent
)

public function BurnAnnotationsToPage( 
    RemoveInitialAnnots: Boolean;
    Intent: GdPictureOutputIntent
): GdPictureStatus;

public function BurnAnnotationsToPage( 
   RemoveInitialAnnots : boolean,
   Intent : GdPictureOutputIntent
) : GdPictureStatus;

public: GdPictureStatus BurnAnnotationsToPage( 
   bool RemoveInitialAnnots,
   GdPictureOutputIntent Intent
)

public:
GdPictureStatus BurnAnnotationsToPage( 
   bool RemoveInitialAnnots,
   GdPictureOutputIntent Intent
)

Parameters

RemoveInitialAnnots: Set this parameter to true, if you want to remove the initial annotation blob content from the file, otherwise set it to false.
Intent: A member of the GdPictureOutputIntent enumeration. Specifies the intent of the produced page after flattening. The default value is GdPictureOutputIntent.IntentColor. Other intents produce smaller page size.

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

Please ensure that you have selected the proper page before starting any annotation related action with the handled document. Annotations are always treated relative to the currently selected page.

Be aware that this method doesn't support custom annotations burning. You can find out in the example for the AnnotationManager.BurnAnnotationsToPage method how to burn annotations to all pages in your document.

This method requires the Annotations component to run.

Example

How to burn annotations to the currently selected page of the handled document.

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

Reference

AnnotationManager Class
AnnotationManager Members
Overload List
SelectPage Method
InitFromFile Method
SaveAnnotationsToPage Method
SaveDocumentToJPEG(String,Int32) Method