DeletePagePieceInfo Method (GdPicturePDF)

In This Topic

Deletes a page PieceInfo dictionary used to hold private application data, if any is defined for the currently selected page of the loaded PDF document.

Syntax

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

'Declaration
 
Public Function DeletePagePieceInfo() As GdPictureStatus

public GdPictureStatus DeletePagePieceInfo()

public function DeletePagePieceInfo(): GdPictureStatus;

public function DeletePagePieceInfo() : GdPictureStatus;

public: GdPictureStatus DeletePagePieceInfo();

public:
GdPictureStatus DeletePagePieceInfo();

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

This method is only allowed for use with non-encrypted documents.

Example

How to delete PieceInfo from each page of your document.

VB.NET
C#

Dim gdpicturePDF As New GdPicturePDF()
If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then
    Dim count As Integer = gdpicturePDF.GetPageCount()
    Dim status As GdPictureStatus = gdpicturePDF.GetStat()
    If status = GdPictureStatus.OK Then
        Dim message As String = ""
        For i As Integer = 1 To count
            status = gdpicturePDF.SelectPage(i)
            If status = GdPictureStatus.OK Then
                status = gdpicturePDF.DeletePagePieceInfo()
                If status = GdPictureStatus.OK Then
                    message = message + "The PieceInfo for the page nr." + i.ToString() + " has been successfully deleted." + vbCrLf
                Else
                    message = message + "The DeletePagePieceInfo() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + vbCrLf
                End If
            Else
                message = message + "The SelectPage() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + vbCrLf
            End If
        Next
        If gdpicturePDF.SaveToFile("test_DeletePagePieceInfo.pdf") = GdPictureStatus.OK Then
            message = message + "The file has been saved."
        Else
            message = message + "The file can't be saved."
        End If
        MessageBox.Show(message, "Example: DeletePagePieceInfo")
    Else
        MessageBox.Show("The GetPageCount() method has failed with the status: " + status.ToString(), "Example: DeletePagePieceInfo")
    End If
Else
    MessageBox.Show("The file can't be loaded.", "Example: DeletePagePieceInfo")
End If
gdpicturePDF.Dispose()

GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetPageCount();
    GdPictureStatus status = gdpicturePDF.GetStat();
    if (status == GdPictureStatus.OK)
    {
        string message = "";
        for (int i = 1; i <= count; i++)
        {
            status = gdpicturePDF.SelectPage(i);
            if (status == GdPictureStatus.OK)
            {
                status = gdpicturePDF.DeletePagePieceInfo();
                if (status == GdPictureStatus.OK)
                    message = message + "The PieceInfo for the page nr." + i.ToString() + " has been successfully deleted.\n";
                else
                    message = message + "The DeletePagePieceInfo() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + "\n";
            }
            else
                message = message + "The SelectPage() method has failed for the page nr." + i.ToString() + " with the status: " + status.ToString() + "\n";
        }
        if (gdpicturePDF.SaveToFile("test_DeletePagePieceInfo.pdf") == GdPictureStatus.OK)
            message = message + "The file has been saved.";
        else
            message = message + "The file can't be saved.";
        MessageBox.Show(message, "Example: DeletePagePieceInfo");
    }
    else
        MessageBox.Show("The GetPageCount() method has failed with the status: " + status.ToString(), "Example: DeletePagePieceInfo");
}
else
    MessageBox.Show("The file can't be loaded.", "Example: DeletePagePieceInfo");
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetPageCount Method
SelectPage Method
GetCurrentPage Method