BurnAnnotationsToPage(Boolean,Boolean) Method

In This Topic

Burn, in other words flatten, the GdPicture/XMP annotations into the current page of the document displayed in the GdViewer control.

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 supports custom annotations burning by setting the VectorMode parameter to false. In other words, this way annotations are drawn using raster graphics (rasterized) on the page.

Syntax

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

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

public GdPictureStatus BurnAnnotationsToPage( 
   bool RemoveInitialAnnots,
   bool VectorMode
)

public function BurnAnnotationsToPage( 
    RemoveInitialAnnots: Boolean;
    VectorMode: Boolean
): GdPictureStatus;

public function BurnAnnotationsToPage( 
   RemoveInitialAnnots : boolean,
   VectorMode : boolean
) : GdPictureStatus;

public: GdPictureStatus BurnAnnotationsToPage( 
   bool RemoveInitialAnnots,
   bool VectorMode
)

public:
GdPictureStatus BurnAnnotationsToPage( 
   bool RemoveInitialAnnots,
   bool VectorMode
)

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.
VectorMode: Determines, if annotations data are rendered in vector format (means using vector graphics) on the page. Setting this parameter to false is only suitable for burning annotations into PDF documents in order to rasterize them on the page, that means to produce image-based page content. At the same, custom annotations can only be burned if the VectorMode parameter is set to false using the same approach.

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 note that annotations are always treated relative to the currently displayed page.

To burn your custom annotations, please set the VectorMode paramater to false using this method. You can find out in the example for the BurnAnnotationsToPage(Boolean) method how to burn annotations to all pages in your document.

Example

How to burn your custom annotations to the current page.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    'Annotate your document.
    'Burning annotations to page using rasterization.
    If GdViewer1.BurnAnnotationsToPage(True, False) = GdPictureStatus.OK Then
        If GdViewer1.SaveDocumentToPDF("mydocument.pdf") = GdPictureStatus.OK Then
            MessageBox.Show("Done!", "GdViewer.BurnAnnotationsToPage")
        Else
            MessageBox.Show("The file can't be saved. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.BurnAnnotationsToPage")
        End If
    Else
        MessageBox.Show("Annotations can't be burned. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.BurnAnnotationsToPage")
    End If
Else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.BurnAnnotationsToPage")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    //Annotate your document.
    //Burning annotations to page using rasterization.
    if (GdViewer1.BurnAnnotationsToPage(true, false) == GdPictureStatus.OK)
    {
        if (GdViewer1.SaveDocumentToPDF("mydocument.pdf") == GdPictureStatus.OK)
            MessageBox.Show("Done!", "GdViewer.BurnAnnotationsToPage");
        else
            MessageBox.Show("The file can't be saved. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.BurnAnnotationsToPage");
    }
    else
        MessageBox.Show("Annotations can't be burned. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.BurnAnnotationsToPage");
}
else
    MessageBox.Show("The file can't be loaded. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.BurnAnnotationsToPage");

Reference

GdViewer Class
GdViewer Members
Overload List
DisplayFromFile(String) Method
SaveAnnotationsToPage Method
SaveDocumentToPDF(String) Method