DropGdPictureAnnotations Property (GdPictureDocumentConverter)

In This Topic

Specifies if present GdPictureAnnotations objects in the loaded document should be copied before further processing.

Syntax

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

'Declaration
 
Public Property DropGdPictureAnnotations As Boolean

public bool DropGdPictureAnnotations {get; set;}

public read-write property DropGdPictureAnnotations: Boolean;

public function get,set DropGdPictureAnnotations : boolean

public: __property bool get_DropGdPictureAnnotations();
public: __property void set_DropGdPictureAnnotations( 
   bool value
);

public:
property bool DropGdPictureAnnotations {
   bool get();
   void set (    bool value);
}

Property Value

The default value is false.

Remarks

For PDF document format, copying annotations means, that firstly they are copied into their native format (xmp metadata) and secondly, they are converted to PDF annotations to allow other PDF viewers render their appearance.

Example

Loading and converting only the first page of the source document with copied annotations on that page.

VB.NET
C#

Using gdpictureDocumentConverter As New GdPictureDocumentConverter()
    gdpictureDocumentConverter.LoadOnlyFirstPage = True
    'Please try to use also a multi-page document.
    Dim status As GdPictureStatus = gdpictureDocumentConverter.LoadFromFile("test_doc.docx", GdPicture14.DocumentFormat.DocumentFormatDOCX)
    If status = GdPictureStatus.OK Then
        MessageBox.Show("The file has been loaded successfully.", "GdPicture")
        gdpictureDocumentConverter.DropGdPictureAnnotations = True
        status = gdpictureDocumentConverter.SaveAsPDF("first_page_dropped_annots.pdf", PdfConformance.PDF)
        If status = GdPictureStatus.OK Then
            MessageBox.Show("The file has been saved successfully.", "GdPicture")
        Else
            MessageBox.Show("The file has failed to save. Status: " + status.ToString(), "GdPicture")
        End If
    Else
        MessageBox.Show("The file has failed to load. Status: " + status.ToString(), "GdPicture")
    End If
End Using

using (GdPictureDocumentConverter gdpictureDocumentConverter = new GdPictureDocumentConverter())
{
    gdpictureDocumentConverter.LoadOnlyFirstPage = true;
    //Please try to use also a multi-page document.
    GdPictureStatus status = gdpictureDocumentConverter.LoadFromFile("test_doc.docx", GdPicture14.DocumentFormat.DocumentFormatDOCX);
    if (status == GdPictureStatus.OK)
    {
        MessageBox.Show("The file has been loaded successfully.", "GdPicture");
        gdpictureDocumentConverter.DropGdPictureAnnotations = true;
        status = gdpictureDocumentConverter.SaveAsPDF("first_page_dropped_annots.pdf", PdfConformance.PDF);
        if (status == GdPictureStatus.OK)
        {
            MessageBox.Show("The file has been saved successfully.", "GdPicture");
        }
        else
        {
            MessageBox.Show("The file has failed to save. Status: " + status.ToString(), "GdPicture");
        }
    }
    else
    {
        MessageBox.Show("The file has failed to load. Status: " + status.ToString(), "GdPicture");
    }
}

Reference

GdPictureDocumentConverter Class
GdPictureDocumentConverter Members